Class AwsClustersClient (2.31.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(NoAwaitTag, 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.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`parent`	`std::string const &`
`aws_cluster`	`google::cloud::gkemulticloud::v1::AwsCluster const &`
`aws_cluster_id`	`std::string const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

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 > >

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

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

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::gkemulticloud::v1::CreateAwsClusterRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

CreateAwsCluster(google::longrunning::Operation const &, Options)

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

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

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

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. For more information, see UpdateAwsClusterRequest.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::gkemulticloud::v1::AwsCluster > >

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

Updates an AwsCluster.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`aws_cluster`	`google::cloud::gkemulticloud::v1::AwsCluster const &`
`update_mask`	`google::protobuf::FieldMask const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

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 > >

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

Updates an AwsCluster.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::gkemulticloud::v1::UpdateAwsClusterRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

UpdateAwsCluster(google::longrunning::Operation const &, Options)

Updates an AwsCluster.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

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

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 >

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(NoAwaitTag, std::string const &, Options)

Deletes a specific AwsCluster resource.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`name`	`std::string const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

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.

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

Deletes a specific AwsCluster resource.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::gkemulticloud::v1::DeleteAwsClusterRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

DeleteAwsCluster(google::longrunning::Operation const &, Options)

Deletes a specific AwsCluster resource.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

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

GenerateAwsClusterAgentToken(google::cloud::gkemulticloud::v1::GenerateAwsClusterAgentTokenRequest const &, Options)

Generates an access token for a cluster agent.

Parameters
Name	Description
`request`	`google::cloud::gkemulticloud::v1::GenerateAwsClusterAgentTokenRequest 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.GenerateAwsClusterAgentTokenRequest. 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::GenerateAwsClusterAgentTokenResponse >`	the result of the RPC. The response message type (google.cloud.gkemulticloud.v1.GenerateAwsClusterAgentTokenResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

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(NoAwaitTag, std::string const &, google::cloud::gkemulticloud::v1::AwsNodePool const &, std::string const &, Options)

Creates a new AwsNodePool, attached to a given AwsCluster.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`parent`	`std::string const &`
`aws_node_pool`	`google::cloud::gkemulticloud::v1::AwsNodePool const &`
`aws_node_pool_id`	`std::string const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

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.

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

Creates a new AwsNodePool, attached to a given AwsCluster.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::gkemulticloud::v1::CreateAwsNodePoolRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

CreateAwsNodePool(google::longrunning::Operation const &, Options)

Creates a new AwsNodePool, attached to a given AwsCluster.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

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

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. For more information, see UpdateAwsNodePoolRequest.
`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(NoAwaitTag, google::cloud::gkemulticloud::v1::AwsNodePool const &, google::protobuf::FieldMask const &, Options)

Updates an AwsNodePool.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`aws_node_pool`	`google::cloud::gkemulticloud::v1::AwsNodePool const &`
`update_mask`	`google::protobuf::FieldMask const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

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.

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

Updates an AwsNodePool.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::gkemulticloud::v1::UpdateAwsNodePoolRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

UpdateAwsNodePool(google::longrunning::Operation const &, Options)

Updates an AwsNodePool.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

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

RollbackAwsNodePoolUpdate(std::string const &, Options)

Rolls back a previously aborted or failed AwsNodePool update request.

Makes no changes if the last update request successfully finished. If an update request is in progress, you cannot rollback the update. You must first cancel or let it finish unsuccessfully before you can rollback.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the AwsNodePool resource to rollback. `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::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.

RollbackAwsNodePoolUpdate(NoAwaitTag, std::string const &, Options)

Rolls back a previously aborted or failed AwsNodePool update request.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`name`	`std::string const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

RollbackAwsNodePoolUpdate(google::cloud::gkemulticloud::v1::RollbackAwsNodePoolUpdateRequest const &, Options)

Rolls back a previously aborted or failed AwsNodePool update request.

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

RollbackAwsNodePoolUpdate(NoAwaitTag, google::cloud::gkemulticloud::v1::RollbackAwsNodePoolUpdateRequest const &, Options)

Rolls back a previously aborted or failed AwsNodePool update request.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::gkemulticloud::v1::RollbackAwsNodePoolUpdateRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

RollbackAwsNodePoolUpdate(google::longrunning::Operation const &, Options)

Rolls back a previously aborted or failed AwsNodePool update request.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

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

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(NoAwaitTag, std::string const &, Options)

Deletes a specific AwsNodePool resource.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`name`	`std::string const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

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.

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

Deletes a specific AwsNodePool resource.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::gkemulticloud::v1::DeleteAwsNodePoolRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

DeleteAwsNodePool(google::longrunning::Operation const &, Options)

Deletes a specific AwsNodePool resource.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

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

GetAwsOpenIdConfig(google::cloud::gkemulticloud::v1::GetAwsOpenIdConfigRequest const &, Options)

Gets the OIDC discovery document for the cluster.

See the OpenID Connect Discovery 1.0 specification for details.

Parameters
Name	Description
`request`	`google::cloud::gkemulticloud::v1::GetAwsOpenIdConfigRequest 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.GetAwsOpenIdConfigRequest. 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::AwsOpenIdConfig >`	the result of the RPC. The response message type (google.cloud.gkemulticloud.v1.AwsOpenIdConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetAwsJsonWebKeys(google::cloud::gkemulticloud::v1::GetAwsJsonWebKeysRequest const &, Options)

Gets the public component of the cluster signing keys in JSON Web Key format.

Parameters
Name	Description
`request`	`google::cloud::gkemulticloud::v1::GetAwsJsonWebKeysRequest 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.GetAwsJsonWebKeysRequest. 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::AwsJsonWebKeys >`	the result of the RPC. The response message type (google.cloud.gkemulticloud.v1.AwsJsonWebKeys) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

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.

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

Lists operations that match the specified filter in the request.

If the server doesn't support this method, it returns UNIMPLEMENTED.

NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

Parameters
Name	Description
`name`	`std::string const &` The name of the operation's parent resource.
`filter`	`std::string const &` The standard list filter.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::longrunning::Operation >

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

ListOperations(google::longrunning::ListOperationsRequest, Options)

Lists operations that match the specified filter in the request.

If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters
Name	Description
`request`	`google::longrunning::ListOperationsRequest` 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.longrunning.ListOperationsRequest. 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::longrunning::Operation >

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

GetOperation(std::string const &, Options)

Gets the latest state of a long-running operation.

Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name	Description
`name`	`std::string const &` The name of the operation resource.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`	the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetOperation(google::longrunning::GetOperationRequest const &, Options)

Gets the latest state of a long-running operation.

Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name	Description
`request`	`google::longrunning::GetOperationRequest 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.longrunning.GetOperationRequest. 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::longrunning::Operation >`	the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeleteOperation(std::string const &, Options)

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name	Description
`name`	`std::string const &` The name of the operation resource to be deleted.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

DeleteOperation(google::longrunning::DeleteOperationRequest const &, Options)

Deletes a long-running operation.

Parameters
Name	Description
`request`	`google::longrunning::DeleteOperationRequest 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.longrunning.DeleteOperationRequest. 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
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

CancelOperation(std::string const &, Options)

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters
Name	Description
`name`	`std::string const &` The name of the operation resource to be cancelled.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

CancelOperation(google::longrunning::CancelOperationRequest const &, Options)

Starts asynchronous cancellation on a long-running operation.

Parameters
Name	Description
`request`	`google::longrunning::CancelOperationRequest 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.longrunning.CancelOperationRequest. 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
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.