Chapter 8. CloudSourcesService
Chapter 8. CloudSourcesService 8.1. UpdateCloudSource PUT /v1/cloud-sources/{cloudSource.id} UpdateCloudSource creates or replaces a cloud source. 8.1.1. Description 8.1.2. Parameters 8.1.2.1. Path Parameters Name Description Required Default Pattern cloudSource.id X null 8.1.2.2. Body Parameter Name Description Required Default Pattern body V1UpdateCloudSourceRequest X 8.1.3. Return Type Object 8.1.4. Content Type application/json 8.1.5. Responses Table 8.1. HTTP Response Codes Code Message Datatype 200 A successful response. Object 0 An unexpected error response. RuntimeError 8.1.6. Samples 8.1.7. Common object reference 8.1.7.1. ProtobufAny Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a message in C++. Example 2: Pack and unpack a message in Java. The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z". 8.1.7.1.1. JSON representation The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example: If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]): Field Name Required Nullable Type Description Format typeUrl String A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration ). The name should be in a canonical form (e.g., leading \".\" is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http , https , or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, https is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than http , https (or the empty scheme) might be used with implementation specific semantics. value byte[] Must be a valid serialized protocol buffer of the above specified type. byte 8.1.7.2. RuntimeError Field Name Required Nullable Type Description Format error String code Integer int32 message String details List of ProtobufAny 8.1.7.3. V1CloudSource CloudSource is an integration which provides a source for discovered clusters. Field Name Required Nullable Type Description Format id String name String type V1CloudSourceType TYPE_UNSPECIFIED, TYPE_PALADIN_CLOUD, TYPE_OCM, credentials V1CloudSourceCredentials skipTestIntegration Boolean paladinCloud V1PaladinCloudConfig ocm V1OCMConfig 8.1.7.4. V1CloudSourceCredentials Field Name Required Nullable Type Description Format secret String 8.1.7.5. V1CloudSourceType Enum Values TYPE_UNSPECIFIED TYPE_PALADIN_CLOUD TYPE_OCM 8.1.7.6. V1OCMConfig OCMConfig provides information required to fetch discovered clusters from the OpenShift cluster manager. Field Name Required Nullable Type Description Format endpoint String 8.1.7.7. V1PaladinCloudConfig PaladinCloudConfig provides information required to fetch discovered clusters from Paladin Cloud. Field Name Required Nullable Type Description Format endpoint String 8.1.7.8. V1UpdateCloudSourceRequest Field Name Required Nullable Type Description Format cloudSource V1CloudSource updateCredentials Boolean If true, cloud_source must include valid credentials. If false, the resource must already exist and credentials in cloud_source are ignored. 8.2. ListCloudSources GET /v1/cloud-sources ListCloudSources returns the list of cloud sources after filtered by requested fields. 8.2.1. Description 8.2.2. Parameters 8.2.2.1. Query Parameters Name Description Required Default Pattern pagination.limit - null pagination.offset - null pagination.sortOption.field - null pagination.sortOption.reversed - null pagination.sortOption.aggregateBy.aggrFunc - UNSET pagination.sortOption.aggregateBy.distinct - null filter.names Matches cloud sources based on their name. String - null filter.types Matches cloud sources based on their type. String - null 8.2.3. Return Type V1ListCloudSourcesResponse 8.2.4. Content Type application/json 8.2.5. Responses Table 8.2. HTTP Response Codes Code Message Datatype 200 A successful response. V1ListCloudSourcesResponse 0 An unexpected error response. RuntimeError 8.2.6. Samples 8.2.7. Common object reference 8.2.7.1. ProtobufAny Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a message in C++. Example 2: Pack and unpack a message in Java. The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z". 8.2.7.1.1. JSON representation The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example: If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]): Field Name Required Nullable Type Description Format typeUrl String A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration ). The name should be in a canonical form (e.g., leading \".\" is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http , https , or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, https is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than http , https (or the empty scheme) might be used with implementation specific semantics. value byte[] Must be a valid serialized protocol buffer of the above specified type. byte 8.2.7.2. RuntimeError Field Name Required Nullable Type Description Format error String code Integer int32 message String details List of ProtobufAny 8.2.7.3. V1CloudSource CloudSource is an integration which provides a source for discovered clusters. Field Name Required Nullable Type Description Format id String name String type V1CloudSourceType TYPE_UNSPECIFIED, TYPE_PALADIN_CLOUD, TYPE_OCM, credentials V1CloudSourceCredentials skipTestIntegration Boolean paladinCloud V1PaladinCloudConfig ocm V1OCMConfig 8.2.7.4. V1CloudSourceCredentials Field Name Required Nullable Type Description Format secret String 8.2.7.5. V1CloudSourceType Enum Values TYPE_UNSPECIFIED TYPE_PALADIN_CLOUD TYPE_OCM 8.2.7.6. V1ListCloudSourcesResponse Field Name Required Nullable Type Description Format cloudSources List of V1CloudSource 8.2.7.7. V1OCMConfig OCMConfig provides information required to fetch discovered clusters from the OpenShift cluster manager. Field Name Required Nullable Type Description Format endpoint String 8.2.7.8. V1PaladinCloudConfig PaladinCloudConfig provides information required to fetch discovered clusters from Paladin Cloud. Field Name Required Nullable Type Description Format endpoint String 8.3. DeleteCloudSource DELETE /v1/cloud-sources/{id} DeleteCloudSource removes a cloud source. 8.3.1. Description 8.3.2. Parameters 8.3.2.1. Path Parameters Name Description Required Default Pattern id X null 8.3.3. Return Type Object 8.3.4. Content Type application/json 8.3.5. Responses Table 8.3. HTTP Response Codes Code Message Datatype 200 A successful response. Object 0 An unexpected error response. RuntimeError 8.3.6. Samples 8.3.7. Common object reference 8.3.7.1. ProtobufAny Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a message in C++. Example 2: Pack and unpack a message in Java. The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z". 8.3.7.1.1. JSON representation The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example: If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]): Field Name Required Nullable Type Description Format typeUrl String A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration ). The name should be in a canonical form (e.g., leading \".\" is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http , https , or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, https is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than http , https (or the empty scheme) might be used with implementation specific semantics. value byte[] Must be a valid serialized protocol buffer of the above specified type. byte 8.3.7.2. RuntimeError Field Name Required Nullable Type Description Format error String code Integer int32 message String details List of ProtobufAny 8.4. GetCloudSource GET /v1/cloud-sources/{id} GetCloudSource retrieves a cloud source by ID. 8.4.1. Description 8.4.2. Parameters 8.4.2.1. Path Parameters Name Description Required Default Pattern id X null 8.4.3. Return Type V1GetCloudSourceResponse 8.4.4. Content Type application/json 8.4.5. Responses Table 8.4. HTTP Response Codes Code Message Datatype 200 A successful response. V1GetCloudSourceResponse 0 An unexpected error response. RuntimeError 8.4.6. Samples 8.4.7. Common object reference 8.4.7.1. ProtobufAny Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a message in C++. Example 2: Pack and unpack a message in Java. The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z". 8.4.7.1.1. JSON representation The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example: If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]): Field Name Required Nullable Type Description Format typeUrl String A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration ). The name should be in a canonical form (e.g., leading \".\" is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http , https , or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, https is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than http , https (or the empty scheme) might be used with implementation specific semantics. value byte[] Must be a valid serialized protocol buffer of the above specified type. byte 8.4.7.2. RuntimeError Field Name Required Nullable Type Description Format error String code Integer int32 message String details List of ProtobufAny 8.4.7.3. V1CloudSource CloudSource is an integration which provides a source for discovered clusters. Field Name Required Nullable Type Description Format id String name String type V1CloudSourceType TYPE_UNSPECIFIED, TYPE_PALADIN_CLOUD, TYPE_OCM, credentials V1CloudSourceCredentials skipTestIntegration Boolean paladinCloud V1PaladinCloudConfig ocm V1OCMConfig 8.4.7.4. V1CloudSourceCredentials Field Name Required Nullable Type Description Format secret String 8.4.7.5. V1CloudSourceType Enum Values TYPE_UNSPECIFIED TYPE_PALADIN_CLOUD TYPE_OCM 8.4.7.6. V1GetCloudSourceResponse Field Name Required Nullable Type Description Format cloudSource V1CloudSource 8.4.7.7. V1OCMConfig OCMConfig provides information required to fetch discovered clusters from the OpenShift cluster manager. Field Name Required Nullable Type Description Format endpoint String 8.4.7.8. V1PaladinCloudConfig PaladinCloudConfig provides information required to fetch discovered clusters from Paladin Cloud. Field Name Required Nullable Type Description Format endpoint String 8.5. CreateCloudSource POST /v1/cloud-sources CreateCloudSource creates a cloud source. 8.5.1. Description 8.5.2. Parameters 8.5.2.1. Body Parameter Name Description Required Default Pattern body V1CreateCloudSourceRequest X 8.5.3. Return Type V1CreateCloudSourceResponse 8.5.4. Content Type application/json 8.5.5. Responses Table 8.5. HTTP Response Codes Code Message Datatype 200 A successful response. V1CreateCloudSourceResponse 0 An unexpected error response. RuntimeError 8.5.6. Samples 8.5.7. Common object reference 8.5.7.1. ProtobufAny Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a message in C++. Example 2: Pack and unpack a message in Java. The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z". 8.5.7.1.1. JSON representation The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example: If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]): Field Name Required Nullable Type Description Format typeUrl String A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration ). The name should be in a canonical form (e.g., leading \".\" is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http , https , or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, https is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than http , https (or the empty scheme) might be used with implementation specific semantics. value byte[] Must be a valid serialized protocol buffer of the above specified type. byte 8.5.7.2. RuntimeError Field Name Required Nullable Type Description Format error String code Integer int32 message String details List of ProtobufAny 8.5.7.3. V1CloudSource CloudSource is an integration which provides a source for discovered clusters. Field Name Required Nullable Type Description Format id String name String type V1CloudSourceType TYPE_UNSPECIFIED, TYPE_PALADIN_CLOUD, TYPE_OCM, credentials V1CloudSourceCredentials skipTestIntegration Boolean paladinCloud V1PaladinCloudConfig ocm V1OCMConfig 8.5.7.4. V1CloudSourceCredentials Field Name Required Nullable Type Description Format secret String 8.5.7.5. V1CloudSourceType Enum Values TYPE_UNSPECIFIED TYPE_PALADIN_CLOUD TYPE_OCM 8.5.7.6. V1CreateCloudSourceRequest Field Name Required Nullable Type Description Format cloudSource V1CloudSource 8.5.7.7. V1CreateCloudSourceResponse Field Name Required Nullable Type Description Format cloudSource V1CloudSource 8.5.7.8. V1OCMConfig OCMConfig provides information required to fetch discovered clusters from the OpenShift cluster manager. Field Name Required Nullable Type Description Format endpoint String 8.5.7.9. V1PaladinCloudConfig PaladinCloudConfig provides information required to fetch discovered clusters from Paladin Cloud. Field Name Required Nullable Type Description Format endpoint String 8.6. TestCloudSource POST /v1/cloud-sources/test TestCloudSource tests a cloud source. 8.6.1. Description 8.6.2. Parameters 8.6.2.1. Body Parameter Name Description Required Default Pattern body V1TestCloudSourceRequest X 8.6.3. Return Type Object 8.6.4. Content Type application/json 8.6.5. Responses Table 8.6. HTTP Response Codes Code Message Datatype 200 A successful response. Object 0 An unexpected error response. RuntimeError 8.6.6. Samples 8.6.7. Common object reference 8.6.7.1. ProtobufAny Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a message in C++. Example 2: Pack and unpack a message in Java. The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z". 8.6.7.1.1. JSON representation The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example: If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]): Field Name Required Nullable Type Description Format typeUrl String A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration ). The name should be in a canonical form (e.g., leading \".\" is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http , https , or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, https is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than http , https (or the empty scheme) might be used with implementation specific semantics. value byte[] Must be a valid serialized protocol buffer of the above specified type. byte 8.6.7.2. RuntimeError Field Name Required Nullable Type Description Format error String code Integer int32 message String details List of ProtobufAny 8.6.7.3. V1CloudSource CloudSource is an integration which provides a source for discovered clusters. Field Name Required Nullable Type Description Format id String name String type V1CloudSourceType TYPE_UNSPECIFIED, TYPE_PALADIN_CLOUD, TYPE_OCM, credentials V1CloudSourceCredentials skipTestIntegration Boolean paladinCloud V1PaladinCloudConfig ocm V1OCMConfig 8.6.7.4. V1CloudSourceCredentials Field Name Required Nullable Type Description Format secret String 8.6.7.5. V1CloudSourceType Enum Values TYPE_UNSPECIFIED TYPE_PALADIN_CLOUD TYPE_OCM 8.6.7.6. V1OCMConfig OCMConfig provides information required to fetch discovered clusters from the OpenShift cluster manager. Field Name Required Nullable Type Description Format endpoint String 8.6.7.7. V1PaladinCloudConfig PaladinCloudConfig provides information required to fetch discovered clusters from Paladin Cloud. Field Name Required Nullable Type Description Format endpoint String 8.6.7.8. V1TestCloudSourceRequest Field Name Required Nullable Type Description Format cloudSource V1CloudSource updateCredentials Boolean If true, cloud_source must include valid credentials. If false, the resource must already exist and credentials in cloud_source are ignored. 8.7. CountCloudSources GET /v1/count/cloud-sources CountCloudSources returns the number of cloud sources after filtering by requested fields. 8.7.1. Description 8.7.2. Parameters 8.7.2.1. Query Parameters Name Description Required Default Pattern filter.names Matches cloud sources based on their name. String - null filter.types Matches cloud sources based on their type. String - null 8.7.3. Return Type V1CountCloudSourcesResponse 8.7.4. Content Type application/json 8.7.5. Responses Table 8.7. HTTP Response Codes Code Message Datatype 200 A successful response. V1CountCloudSourcesResponse 0 An unexpected error response. RuntimeError 8.7.6. Samples 8.7.7. Common object reference 8.7.7.1. ProtobufAny Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a message in C++. Example 2: Pack and unpack a message in Java. The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z". 8.7.7.1.1. JSON representation The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example: If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]): Field Name Required Nullable Type Description Format typeUrl String A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration ). The name should be in a canonical form (e.g., leading \".\" is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http , https , or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, https is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than http , https (or the empty scheme) might be used with implementation specific semantics. value byte[] Must be a valid serialized protocol buffer of the above specified type. byte 8.7.7.2. RuntimeError Field Name Required Nullable Type Description Format error String code Integer int32 message String details List of ProtobufAny 8.7.7.3. V1CountCloudSourcesResponse Field Name Required Nullable Type Description Format count Integer int32
Foo foo = ...; Any any; any.PackFrom(foo); if (any.UnpackTo(&foo)) { } Foo foo = ...; Any any = Any.pack(foo); if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } // or if (any.isSameTypeAs(Foo.getDefaultInstance())) { foo = any.unpack(Foo.getDefaultInstance()); } Example 3: Pack and unpack a message in Python. foo = Foo(...) any = Any() any.Pack(foo) if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) Example 4: Pack and unpack a message in Go foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { } foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { } package google.profile; message Person { string first_name = 1; string last_name = 2; } { "@type": "type.googleapis.com/google.profile.Person", "firstName": <string>, "lastName": <string> } { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" } Foo foo = ...; Any any; any.PackFrom(foo); if (any.UnpackTo(&foo)) { } Foo foo = ...; Any any = Any.pack(foo); if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } // or if (any.isSameTypeAs(Foo.getDefaultInstance())) { foo = any.unpack(Foo.getDefaultInstance()); } Example 3: Pack and unpack a message in Python. foo = Foo(...) any = Any() any.Pack(foo) if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) Example 4: Pack and unpack a message in Go foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { } foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { } package google.profile; message Person { string first_name = 1; string last_name = 2; } { "@type": "type.googleapis.com/google.profile.Person", "firstName": <string>, "lastName": <string> } { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" } Foo foo = ...; Any any; any.PackFrom(foo); if (any.UnpackTo(&foo)) { } Foo foo = ...; Any any = Any.pack(foo); if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } // or if (any.isSameTypeAs(Foo.getDefaultInstance())) { foo = any.unpack(Foo.getDefaultInstance()); } Example 3: Pack and unpack a message in Python. foo = Foo(...) any = Any() any.Pack(foo) if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) Example 4: Pack and unpack a message in Go foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { } foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { } package google.profile; message Person { string first_name = 1; string last_name = 2; } { "@type": "type.googleapis.com/google.profile.Person", "firstName": <string>, "lastName": <string> } { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" } Foo foo = ...; Any any; any.PackFrom(foo); if (any.UnpackTo(&foo)) { } Foo foo = ...; Any any = Any.pack(foo); if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } // or if (any.isSameTypeAs(Foo.getDefaultInstance())) { foo = any.unpack(Foo.getDefaultInstance()); } Example 3: Pack and unpack a message in Python. foo = Foo(...) any = Any() any.Pack(foo) if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) Example 4: Pack and unpack a message in Go foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { } foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { } package google.profile; message Person { string first_name = 1; string last_name = 2; } { "@type": "type.googleapis.com/google.profile.Person", "firstName": <string>, "lastName": <string> } { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" } Foo foo = ...; Any any; any.PackFrom(foo); if (any.UnpackTo(&foo)) { } Foo foo = ...; Any any = Any.pack(foo); if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } // or if (any.isSameTypeAs(Foo.getDefaultInstance())) { foo = any.unpack(Foo.getDefaultInstance()); } Example 3: Pack and unpack a message in Python. foo = Foo(...) any = Any() any.Pack(foo) if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) Example 4: Pack and unpack a message in Go foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { } foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { } package google.profile; message Person { string first_name = 1; string last_name = 2; } { "@type": "type.googleapis.com/google.profile.Person", "firstName": <string>, "lastName": <string> } { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" } Foo foo = ...; Any any; any.PackFrom(foo); if (any.UnpackTo(&foo)) { } Foo foo = ...; Any any = Any.pack(foo); if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } // or if (any.isSameTypeAs(Foo.getDefaultInstance())) { foo = any.unpack(Foo.getDefaultInstance()); } Example 3: Pack and unpack a message in Python. foo = Foo(...) any = Any() any.Pack(foo) if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) Example 4: Pack and unpack a message in Go foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { } foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { } package google.profile; message Person { string first_name = 1; string last_name = 2; } { "@type": "type.googleapis.com/google.profile.Person", "firstName": <string>, "lastName": <string> } { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" } Foo foo = ...; Any any; any.PackFrom(foo); if (any.UnpackTo(&foo)) { } Foo foo = ...; Any any = Any.pack(foo); if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } // or if (any.isSameTypeAs(Foo.getDefaultInstance())) { foo = any.unpack(Foo.getDefaultInstance()); } Example 3: Pack and unpack a message in Python. foo = Foo(...) any = Any() any.Pack(foo) if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) Example 4: Pack and unpack a message in Go foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { } foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { } package google.profile; message Person { string first_name = 1; string last_name = 2; } { "@type": "type.googleapis.com/google.profile.Person", "firstName": <string>, "lastName": <string> } { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }