Class AwsClustersClient (2.11.0)

The AwsClusters API provides a single centrally managed service to create and manage Anthos clusters that run on AWS 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

AwsClustersClient(AwsClustersClient const &)

Copy and move support

Parameter
Name Description
AwsClustersClient const &

AwsClustersClient(AwsClustersClient &&)

Copy and move support

Parameter
Name Description
AwsClustersClient &&

AwsClustersClient(std::shared_ptr< AwsClustersConnection >, Options)

Parameters
Name Description
connection std::shared_ptr< AwsClustersConnection >
opts Options

Operators

operator=(AwsClustersClient const &)

Copy and move support

Parameter
Name Description
AwsClustersClient const &
Returns
Type Description
AwsClustersClient &

operator=(AwsClustersClient &&)

Copy and move support

Parameter
Name Description
AwsClustersClient &&
Returns
Type Description
AwsClustersClient &

Functions

CreateAwsCluster(std::string const &, google::cloud::gkemulticloud::v1::AwsCluster const &, std::string const &, Options)

Creates a new AwsCluster 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
Name Description
parent std::string const &

Required. The parent location where this AwsCluster 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.

aws_cluster google::cloud::gkemulticloud::v1::AwsCluster const &

Required. The specification of the AwsCluster to create.

aws_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 AwsCluster resource name formatted as projects/<project-id>/locations/<region>/awsClusters/<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
Type Description
future< StatusOr< google::cloud::gkemulticloud::v1::AwsCluster > >

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.AwsCluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateAwsCluster(google::cloud::gkemulticloud::v1::CreateAwsClusterRequest const &, Options)

Creates a new AwsCluster 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
Name Description
request google::cloud::gkemulticloud::v1::CreateAwsClusterRequest 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.CreateAwsClusterRequest. 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
Type Description
future< StatusOr< google::cloud::gkemulticloud::v1::AwsCluster > >

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.AwsCluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateAwsCluster(google::cloud::gkemulticloud::v1::AwsCluster const &, google::protobuf::FieldMask const &, Options)

Updates an AwsCluster.

Parameters
Name Description
aws_cluster google::cloud::gkemulticloud::v1::AwsCluster const &

Required. The AwsCluster 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 AwsCluster:

  • description.
  • annotations.
  • control_plane.version.
  • authorization.admin_users.
  • control_plane.aws_services_authentication.role_arn.
  • control_plane.aws_services_authentication.role_session_name.
  • control_plane.config_encryption.kms_key_arn.
  • control_plane.instance_type.
  • control_plane.security_group_ids.
  • control_plane.proxy_config.
  • control_plane.proxy_config.secret_arn.
  • control_plane.proxy_config.secret_version.
  • control_plane.root_volume.size_gib.
  • control_plane.root_volume.volume_type.
  • control_plane.root_volume.iops.
  • control_plane.root_volume.kms_key_arn.
  • control_plane.ssh_config.
  • control_plane.ssh_config.ec2_key_pair.
  • control_plane.instance_placement.tenancy.
  • control_plane.iam_instance_profile.
  • logging_config.component_config.enable_components.
  • control_plane.tags.
  • monitoring_config.managed_prometheus_config.enabled.
opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::gkemulticloud::v1::AwsCluster > >

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.AwsCluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateAwsCluster(google::cloud::gkemulticloud::v1::UpdateAwsClusterRequest const &, Options)

Updates an AwsCluster.

Parameters
Name Description
request google::cloud::gkemulticloud::v1::UpdateAwsClusterRequest 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.UpdateAwsClusterRequest. 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
Type Description
future< StatusOr< google::cloud::gkemulticloud::v1::AwsCluster > >

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.AwsCluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

GetAwsCluster(std::string const &, Options)

Describes a specific AwsCluster resource.

Parameters
Name Description
name std::string const &

Required. The name of the AwsCluster resource to describe.
AwsCluster names are formatted as projects/<project-id>/locations/<region>/awsClusters/<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
Type Description
StatusOr< google::cloud::gkemulticloud::v1::AwsCluster >

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

GetAwsCluster(google::cloud::gkemulticloud::v1::GetAwsClusterRequest const &, Options)

Describes a specific AwsCluster resource.

Parameters
Name Description
request google::cloud::gkemulticloud::v1::GetAwsClusterRequest 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.GetAwsClusterRequest. 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
Type Description
StatusOr< google::cloud::gkemulticloud::v1::AwsCluster >

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

ListAwsClusters(std::string const &, Options)

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

Parameters
Name Description
parent std::string const &

Required. The parent location which owns this collection of AwsCluster 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
Type Description
StreamRange< google::cloud::gkemulticloud::v1::AwsCluster >

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.AwsCluster, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListAwsClusters(google::cloud::gkemulticloud::v1::ListAwsClustersRequest, Options)

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

Parameters
Name Description
request google::cloud::gkemulticloud::v1::ListAwsClustersRequest

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.ListAwsClustersRequest. 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
Type Description
StreamRange< google::cloud::gkemulticloud::v1::AwsCluster >

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.AwsCluster, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

DeleteAwsCluster(std::string const &, Options)

Deletes a specific AwsCluster resource.

Fails if the cluster has one or more associated AwsNodePool resources.

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

Parameters
Name Description
name std::string const &

Required. The resource name the AwsCluster to delete.
AwsCluster names are formatted as projects/<project-id>/locations/<region>/awsClusters/<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
Type Description
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.

DeleteAwsCluster(google::cloud::gkemulticloud::v1::DeleteAwsClusterRequest const &, Options)

Deletes a specific AwsCluster resource.

Fails if the cluster has one or more associated AwsNodePool resources.

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

Parameters
Name Description
request google::cloud::gkemulticloud::v1::DeleteAwsClusterRequest 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.DeleteAwsClusterRequest. 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
Type Description
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.

GenerateAwsAccessToken(google::cloud::gkemulticloud::v1::GenerateAwsAccessTokenRequest const &, Options)

Generates a short-lived access token to authenticate to a given AwsCluster resource.

Parameters
Name Description
request google::cloud::gkemulticloud::v1::GenerateAwsAccessTokenRequest 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.GenerateAwsAccessTokenRequest. 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
Type Description
StatusOr< google::cloud::gkemulticloud::v1::GenerateAwsAccessTokenResponse >

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

CreateAwsNodePool(std::string const &, google::cloud::gkemulticloud::v1::AwsNodePool const &, std::string const &, Options)

Creates a new AwsNodePool, attached to a given AwsCluster.

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

Parameters
Name Description
parent std::string const &

Required. The AwsCluster resource where this node pool will be created.
AwsCluster names are formatted as projects/<project-id>/locations/<region>/awsClusters/<cluster-id>.
See Resource Names for more details on Google Cloud resource names.

aws_node_pool google::cloud::gkemulticloud::v1::AwsNodePool const &

Required. The specification of the AwsNodePool to create.

aws_node_pool_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 AwsNodePool resource name formatted as projects/<project-id>/locations/<region>/awsClusters/<cluster-id>/awsNodePools/<node-pool-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
Type Description
future< StatusOr< google::cloud::gkemulticloud::v1::AwsNodePool > >

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.AwsNodePool proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateAwsNodePool(google::cloud::gkemulticloud::v1::CreateAwsNodePoolRequest const &, Options)

Creates a new AwsNodePool, attached to a given AwsCluster.

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

Parameters
Name Description
request google::cloud::gkemulticloud::v1::CreateAwsNodePoolRequest 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.CreateAwsNodePoolRequest. 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
Type Description
future< StatusOr< google::cloud::gkemulticloud::v1::AwsNodePool > >

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.AwsNodePool proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateAwsNodePool(google::cloud::gkemulticloud::v1::AwsNodePool const &, google::protobuf::FieldMask const &, Options)

Updates an AwsNodePool.

Parameters
Name Description
aws_node_pool google::cloud::gkemulticloud::v1::AwsNodePool const &

Required. The AwsNodePool 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 AwsNodePool:

  • annotations.
  • version.
  • autoscaling.min_node_count.
  • autoscaling.max_node_count.
  • config.config_encryption.kms_key_arn.
  • config.security_group_ids.
  • config.root_volume.iops.
  • config.root_volume.kms_key_arn.
  • config.root_volume.volume_type.
  • config.root_volume.size_gib.
  • config.proxy_config.
  • config.proxy_config.secret_arn.
  • config.proxy_config.secret_version.
  • config.ssh_config.
  • config.ssh_config.ec2_key_pair.
  • config.instance_placement.tenancy.
  • config.iam_instance_profile.
  • config.labels.
  • config.tags.
  • config.autoscaling_metrics_collection.
  • config.autoscaling_metrics_collection.granularity.
  • config.autoscaling_metrics_collection.metrics.
opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::gkemulticloud::v1::AwsNodePool > >

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.AwsNodePool proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateAwsNodePool(google::cloud::gkemulticloud::v1::UpdateAwsNodePoolRequest const &, Options)

Updates an AwsNodePool.

Parameters
Name Description
request google::cloud::gkemulticloud::v1::UpdateAwsNodePoolRequest 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.UpdateAwsNodePoolRequest. 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
Type Description
future< StatusOr< google::cloud::gkemulticloud::v1::AwsNodePool > >

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.AwsNodePool proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

GetAwsNodePool(std::string const &, Options)

Describes a specific AwsNodePool resource.

Parameters
Name Description
name std::string const &

Required. The name of the AwsNodePool resource to describe.
AwsNodePool names are formatted as projects/<project-id>/locations/<region>/awsClusters/<cluster-id>/awsNodePools/<node-pool-id>.
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
Type Description
StatusOr< google::cloud::gkemulticloud::v1::AwsNodePool >

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

GetAwsNodePool(google::cloud::gkemulticloud::v1::GetAwsNodePoolRequest const &, Options)

Describes a specific AwsNodePool resource.

Parameters
Name Description
request google::cloud::gkemulticloud::v1::GetAwsNodePoolRequest 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.GetAwsNodePoolRequest. 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
Type Description
StatusOr< google::cloud::gkemulticloud::v1::AwsNodePool >

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

ListAwsNodePools(std::string const &, Options)

Lists all AwsNodePool resources on a given AwsCluster.

Parameters
Name Description
parent std::string const &

Required. The parent AwsCluster which owns this collection of AwsNodePool resources.
AwsCluster names are formatted as projects/<project-id>/locations/<region>/awsClusters/<cluster-id>.
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
Type Description
StreamRange< google::cloud::gkemulticloud::v1::AwsNodePool >

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.AwsNodePool, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListAwsNodePools(google::cloud::gkemulticloud::v1::ListAwsNodePoolsRequest, Options)

Lists all AwsNodePool resources on a given AwsCluster.

Parameters
Name Description
request google::cloud::gkemulticloud::v1::ListAwsNodePoolsRequest

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.ListAwsNodePoolsRequest. 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
Type Description
StreamRange< google::cloud::gkemulticloud::v1::AwsNodePool >

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.AwsNodePool, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

DeleteAwsNodePool(std::string const &, Options)

Deletes a specific AwsNodePool resource.

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

Parameters
Name Description
name std::string const &

Required. The resource name the AwsNodePool to delete.
AwsNodePool names are formatted as projects/<project-id>/locations/<region>/awsClusters/<cluster-id>/awsNodePools/<node-pool-id>.
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
Type Description
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.

DeleteAwsNodePool(google::cloud::gkemulticloud::v1::DeleteAwsNodePoolRequest const &, Options)

Deletes a specific AwsNodePool resource.

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

Parameters
Name Description
request google::cloud::gkemulticloud::v1::DeleteAwsNodePoolRequest 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.DeleteAwsNodePoolRequest. 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
Type Description
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.

GetAwsServerConfig(std::string const &, Options)

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

Parameters
Name Description
name std::string const &

Required. The name of the AwsServerConfig resource to describe.
AwsServerConfig names are formatted as projects/<project-id>/locations/<region>/awsServerConfig.
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
Type Description
StatusOr< google::cloud::gkemulticloud::v1::AwsServerConfig >

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

GetAwsServerConfig(google::cloud::gkemulticloud::v1::GetAwsServerConfigRequest const &, Options)

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

Parameters
Name Description
request google::cloud::gkemulticloud::v1::GetAwsServerConfigRequest 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.GetAwsServerConfigRequest. 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
Type Description
StatusOr< google::cloud::gkemulticloud::v1::AwsServerConfig >

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