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. |
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. |
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 |
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 |
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 |
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. |
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 |
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 |
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 |
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. |
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 |
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 |
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 |
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. |
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 |
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 |
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 |
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. |
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 |
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 |
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 |
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 |
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 |
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. |
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. |
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 |
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 |
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 |
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. |
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 |
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 |
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 |
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. |
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 |
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 |
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 |
ListAwsNodePools(std::string const &, Options)
Lists all AwsNodePool resources on a given AwsCluster.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent |
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 |
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 |
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 |
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. |
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 |
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 |
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 |
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. |
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 |
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 |
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 |