Class AttachedClustersClient (2.19.0)

The AttachedClusters API provides a single centrally managed service to register and manage Anthos attached clusters that run on customer's owned infrastructure.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

AttachedClustersClient(AttachedClustersClient const &)

Copy and move support

Parameter
NameDescription
AttachedClustersClient const &

AttachedClustersClient(AttachedClustersClient &&)

Copy and move support

Parameter
NameDescription
AttachedClustersClient &&

AttachedClustersClient(std::shared_ptr< AttachedClustersConnection >, Options)

Parameters
NameDescription
connection std::shared_ptr< AttachedClustersConnection >
opts Options

Operators

operator=(AttachedClustersClient const &)

Copy and move support

Parameter
NameDescription
AttachedClustersClient const &
Returns
TypeDescription
AttachedClustersClient &

operator=(AttachedClustersClient &&)

Copy and move support

Parameter
NameDescription
AttachedClustersClient &&
Returns
TypeDescription
AttachedClustersClient &

Functions

CreateAttachedCluster(std::string const &, google::cloud::gkemulticloud::v1::AttachedCluster const &, std::string const &, Options)

Creates a new AttachedCluster resource on a given Google Cloud Platform project and region.

If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.

Parameters
NameDescription
parent std::string const &

Required. The parent location where this AttachedCluster resource will be created.
Location names are formatted as projects/<project-id>/locations/<region>.
See Resource Names for more details on Google Cloud resource names.

attached_cluster google::cloud::gkemulticloud::v1::AttachedCluster const &

Required. The specification of the AttachedCluster to create.

attached_cluster_id std::string const &

Required. A client provided ID the resource. Must be unique within the parent resource.
The provided ID will be part of the AttachedCluster resource name formatted as projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>.
Valid characters are /[a-z][0-9]-/. Cannot be longer than 63 characters.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::gkemulticloud::v1::AttachedCluster > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.gkemulticloud.v1.AttachedCluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateAttachedCluster(google::cloud::gkemulticloud::v1::CreateAttachedClusterRequest const &, Options)

Creates a new AttachedCluster resource on a given Google Cloud Platform project and region.

If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.

Parameters
NameDescription
request google::cloud::gkemulticloud::v1::CreateAttachedClusterRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gkemulticloud.v1.CreateAttachedClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::gkemulticloud::v1::AttachedCluster > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.gkemulticloud.v1.AttachedCluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateAttachedCluster(google::cloud::gkemulticloud::v1::AttachedCluster const &, google::protobuf::FieldMask const &, Options)

Updates an AttachedCluster.

Parameters
NameDescription
attached_cluster google::cloud::gkemulticloud::v1::AttachedCluster const &

Required. The AttachedCluster resource to update.

update_mask google::protobuf::FieldMask const &

Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field can only include these fields from AttachedCluster:

  • description.
  • annotations.
  • platform_version.
  • authorization.admin_users.
  • logging_config.component_config.enable_components.
  • monitoring_config.managed_prometheus_config.enabled.
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::gkemulticloud::v1::AttachedCluster > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.gkemulticloud.v1.AttachedCluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateAttachedCluster(google::cloud::gkemulticloud::v1::UpdateAttachedClusterRequest const &, Options)

Updates an AttachedCluster.

Parameters
NameDescription
request google::cloud::gkemulticloud::v1::UpdateAttachedClusterRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gkemulticloud.v1.UpdateAttachedClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::gkemulticloud::v1::AttachedCluster > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.gkemulticloud.v1.AttachedCluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ImportAttachedCluster(std::string const &, std::string const &, Options)

Imports creates a new AttachedCluster resource by importing an existing Fleet Membership resource.

Attached Clusters created before the introduction of the Anthos Multi-Cloud API can be imported through this method.

If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.

Parameters
NameDescription
parent std::string const &

Required. The parent location where this AttachedCluster resource will be created.
Location names are formatted as projects/<project-id>/locations/<region>.
See Resource Names for more details on Google Cloud resource names.

fleet_membership std::string const &

Required. The name of the fleet membership resource to import.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::gkemulticloud::v1::AttachedCluster > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.gkemulticloud.v1.AttachedCluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ImportAttachedCluster(google::cloud::gkemulticloud::v1::ImportAttachedClusterRequest const &, Options)

Imports creates a new AttachedCluster resource by importing an existing Fleet Membership resource.

Attached Clusters created before the introduction of the Anthos Multi-Cloud API can be imported through this method.

If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.

Parameters
NameDescription
request google::cloud::gkemulticloud::v1::ImportAttachedClusterRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gkemulticloud.v1.ImportAttachedClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::gkemulticloud::v1::AttachedCluster > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.gkemulticloud.v1.AttachedCluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

GetAttachedCluster(std::string const &, Options)

Describes a specific AttachedCluster resource.

Parameters
NameDescription
name std::string const &

Required. The name of the AttachedCluster resource to describe.
AttachedCluster names are formatted as projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>.
See Resource Names for more details on Google Cloud Platform resource names.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::cloud::gkemulticloud::v1::AttachedCluster >

the result of the RPC. The response message type (google.cloud.gkemulticloud.v1.AttachedCluster) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetAttachedCluster(google::cloud::gkemulticloud::v1::GetAttachedClusterRequest const &, Options)

Describes a specific AttachedCluster resource.

Parameters
NameDescription
request google::cloud::gkemulticloud::v1::GetAttachedClusterRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gkemulticloud.v1.GetAttachedClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::cloud::gkemulticloud::v1::AttachedCluster >

the result of the RPC. The response message type (google.cloud.gkemulticloud.v1.AttachedCluster) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListAttachedClusters(std::string const &, Options)

Lists all AttachedCluster resources on a given Google Cloud project and region.

Parameters
NameDescription
parent std::string const &

Required. The parent location which owns this collection of AttachedCluster resources.
Location names are formatted as projects/<project-id>/locations/<region>.
See Resource Names for more details on Google Cloud Platform resource names.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StreamRange< google::cloud::gkemulticloud::v1::AttachedCluster >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.gkemulticloud.v1.AttachedCluster, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListAttachedClusters(google::cloud::gkemulticloud::v1::ListAttachedClustersRequest, Options)

Lists all AttachedCluster resources on a given Google Cloud project and region.

Parameters
NameDescription
request google::cloud::gkemulticloud::v1::ListAttachedClustersRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gkemulticloud.v1.ListAttachedClustersRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StreamRange< google::cloud::gkemulticloud::v1::AttachedCluster >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.gkemulticloud.v1.AttachedCluster, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

DeleteAttachedCluster(std::string const &, Options)

Deletes a specific AttachedCluster resource.

If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.

Parameters
NameDescription
name std::string const &

Required. The resource name the AttachedCluster to delete.
AttachedCluster names are formatted as projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>.
See Resource Names for more details on Google Cloud Platform resource names.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::gkemulticloud::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.gkemulticloud.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteAttachedCluster(google::cloud::gkemulticloud::v1::DeleteAttachedClusterRequest const &, Options)

Deletes a specific AttachedCluster resource.

If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.

Parameters
NameDescription
request google::cloud::gkemulticloud::v1::DeleteAttachedClusterRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gkemulticloud.v1.DeleteAttachedClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
future< StatusOr< google::cloud::gkemulticloud::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.gkemulticloud.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

GetAttachedServerConfig(std::string const &, Options)

Returns information, such as supported Kubernetes versions, on a given Google Cloud location.

Parameters
NameDescription
name std::string const &

Required. The name of the AttachedServerConfig resource to describe.
AttachedServerConfig names are formatted as projects/<project-id>/locations/<region>/attachedServerConfig.
See Resource Names for more details on Google Cloud resource names.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::cloud::gkemulticloud::v1::AttachedServerConfig >

the result of the RPC. The response message type (google.cloud.gkemulticloud.v1.AttachedServerConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetAttachedServerConfig(google::cloud::gkemulticloud::v1::GetAttachedServerConfigRequest const &, Options)

Returns information, such as supported Kubernetes versions, on a given Google Cloud location.

Parameters
NameDescription
request google::cloud::gkemulticloud::v1::GetAttachedServerConfigRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gkemulticloud.v1.GetAttachedServerConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::cloud::gkemulticloud::v1::AttachedServerConfig >

the result of the RPC. The response message type (google.cloud.gkemulticloud.v1.AttachedServerConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GenerateAttachedClusterInstallManifest(std::string const &, std::string const &, Options)

Generates the install manifest to be installed on the target cluster.

Parameters
NameDescription
parent std::string const &

Required. The parent location where this [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource will be created.
Location names are formatted as projects/<project-id>/locations/<region>.
See Resource Names for more details on Google Cloud resource names.

attached_cluster_id std::string const &

Required. A client provided ID of the resource. Must be unique within the parent resource.
The provided ID will be part of the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource name formatted as projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>.
Valid characters are /[a-z][0-9]-/. Cannot be longer than 63 characters.
When generating an install manifest for importing an existing Membership resource, the attached_cluster_id field must be the Membership id.
Membership names are formatted as projects/<project-id>/locations/<region>/memberships/<membership-id>.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::cloud::gkemulticloud::v1::GenerateAttachedClusterInstallManifestResponse >

the result of the RPC. The response message type (google.cloud.gkemulticloud.v1.GenerateAttachedClusterInstallManifestResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GenerateAttachedClusterInstallManifest(google::cloud::gkemulticloud::v1::GenerateAttachedClusterInstallManifestRequest const &, Options)

Generates the install manifest to be installed on the target cluster.

Parameters
NameDescription
request google::cloud::gkemulticloud::v1::GenerateAttachedClusterInstallManifestRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.gkemulticloud.v1.GenerateAttachedClusterInstallManifestRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::cloud::gkemulticloud::v1::GenerateAttachedClusterInstallManifestResponse >

the result of the RPC. The response message type (google.cloud.gkemulticloud.v1.GenerateAttachedClusterInstallManifestResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.