Class AzureClustersClient (2.32.0)

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

AzureClustersClient(AzureClustersClient const &)

Copy and move support

Parameter
Name	Description
	`AzureClustersClient const &`

AzureClustersClient(AzureClustersClient &&)

Copy and move support

Parameter
Name	Description
	`AzureClustersClient &&`

AzureClustersClient(std::shared_ptr< AzureClustersConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< AzureClustersConnection >`
`opts`	`Options`

Operators

operator=(AzureClustersClient const &)

Copy and move support

Parameter
Name	Description
	`AzureClustersClient const &`

Returns
Type	Description
`AzureClustersClient &`

operator=(AzureClustersClient &&)

Copy and move support

Parameter
Name	Description
	`AzureClustersClient &&`

Returns
Type	Description
`AzureClustersClient &`

Functions

CreateAzureClient(std::string const &, google::cloud::gkemulticloud::v1::AzureClient const &, std::string const &, Options)

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

AzureClient resources hold client authentication information needed by the Anthos Multicloud API to manage Azure resources on your Azure subscription on your behalf.

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 AzureClient 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.
`azure_client`	`google::cloud::gkemulticloud::v1::AzureClient const &` Required. The specification of the AzureClient to create.
`azure_client_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 AzureClient resource name formatted as `projects/<project-id>/locations/<region>/azureClients/<client-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::AzureClient > >

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

CreateAzureClient(NoAwaitTag, std::string const &, google::cloud::gkemulticloud::v1::AzureClient const &, std::string const &, Options)

Creates a new AzureClient resource on a given Google Cloud 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 &`
`azure_client`	`google::cloud::gkemulticloud::v1::AzureClient const &`
`azure_client_id`	`std::string const &`
`opts`	`Options`

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

CreateAzureClient(google::cloud::gkemulticloud::v1::CreateAzureClientRequest const &, Options)

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

AzureClient resources hold client authentication information needed by the Anthos Multicloud API to manage Azure resources on your Azure subscription on your behalf.

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::CreateAzureClientRequest 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.CreateAzureClientRequest. 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::AzureClient > >

CreateAzureClient(NoAwaitTag, google::cloud::gkemulticloud::v1::CreateAzureClientRequest const &, Options)

Creates a new AzureClient resource on a given Google Cloud 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::CreateAzureClientRequest const &`
`opts`	`Options`

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

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

Creates a new AzureClient resource on a given Google Cloud 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::AzureClient > >`

GetAzureClient(std::string const &, Options)

Describes a specific AzureClient resource.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the AzureClient resource to describe. AzureClient names are formatted as `projects/<project-id>/locations/<region>/azureClients/<client-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::AzureClient >`	the result of the RPC. The response message type (google.cloud.gkemulticloud.v1.AzureClient) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetAzureClient(google::cloud::gkemulticloud::v1::GetAzureClientRequest const &, Options)

Describes a specific AzureClient resource.

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

ListAzureClients(std::string const &, Options)

Lists all AzureClient 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 AzureClient 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::AzureClient >

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

ListAzureClients(google::cloud::gkemulticloud::v1::ListAzureClientsRequest, Options)

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

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

DeleteAzureClient(std::string const &, Options)

Deletes a specific AzureClient resource.

If the client is used by one or more clusters, deletion will fail and a FAILED_PRECONDITION error will be returned.

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 AzureClient to delete. AzureClient names are formatted as `projects/<project-id>/locations/<region>/azureClients/<client-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.

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

Deletes a specific AzureClient 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 >`

DeleteAzureClient(google::cloud::gkemulticloud::v1::DeleteAzureClientRequest const &, Options)

Deletes a specific AzureClient resource.

If the client is used by one or more clusters, deletion will fail and a FAILED_PRECONDITION error will be returned.

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::DeleteAzureClientRequest 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.DeleteAzureClientRequest. 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.

DeleteAzureClient(NoAwaitTag, google::cloud::gkemulticloud::v1::DeleteAzureClientRequest const &, Options)

Deletes a specific AzureClient 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::DeleteAzureClientRequest const &`
`opts`	`Options`

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

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

Deletes a specific AzureClient 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 > >`

CreateAzureCluster(std::string const &, google::cloud::gkemulticloud::v1::AzureCluster const &, std::string const &, Options)

Creates a new AzureCluster 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 AzureCluster 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.
`azure_cluster`	`google::cloud::gkemulticloud::v1::AzureCluster const &` Required. The specification of the AzureCluster to create.
`azure_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 AzureCluster resource name formatted as `projects/<project-id>/locations/<region>/azureClusters/<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::AzureCluster > >

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

CreateAzureCluster(NoAwaitTag, std::string const &, google::cloud::gkemulticloud::v1::AzureCluster const &, std::string const &, Options)

Creates a new AzureCluster 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 &`
`azure_cluster`	`google::cloud::gkemulticloud::v1::AzureCluster const &`
`azure_cluster_id`	`std::string const &`
`opts`	`Options`

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

CreateAzureCluster(google::cloud::gkemulticloud::v1::CreateAzureClusterRequest const &, Options)

Creates a new AzureCluster 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::CreateAzureClusterRequest 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.CreateAzureClusterRequest. 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::AzureCluster > >

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

CreateAzureCluster(NoAwaitTag, google::cloud::gkemulticloud::v1::CreateAzureClusterRequest const &, Options)

Creates a new AzureCluster 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::CreateAzureClusterRequest const &`
`opts`	`Options`

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

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

Creates a new AzureCluster 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::AzureCluster > >`

UpdateAzureCluster(google::cloud::gkemulticloud::v1::AzureCluster const &, google::protobuf::FieldMask const &, Options)

Updates an AzureCluster.

Parameters
Name	Description
`azure_cluster`	`google::cloud::gkemulticloud::v1::AzureCluster const &` Required. The AzureCluster 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 AzureCluster: `description`. `azureClient`. `control_plane.version`. `control_plane.vm_size`. `annotations`. `authorization.admin_users`. `authorization.admin_groups`. `control_plane.root_volume.size_gib`. `azure_services_authentication`. `azure_services_authentication.tenant_id`. `azure_services_authentication.application_id`. `control_plane.proxy_config`. `control_plane.proxy_config.resource_group_id`. `control_plane.proxy_config.secret_id`. `control_plane.ssh_config.authorized_key`. `logging_config.component_config.enable_components` `monitoring_config.managed_prometheus_config.enabled`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

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

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

UpdateAzureCluster(NoAwaitTag, google::cloud::gkemulticloud::v1::AzureCluster const &, google::protobuf::FieldMask const &, Options)

Updates an AzureCluster.

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`
`azure_cluster`	`google::cloud::gkemulticloud::v1::AzureCluster const &`
`update_mask`	`google::protobuf::FieldMask const &`
`opts`	`Options`

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

UpdateAzureCluster(google::cloud::gkemulticloud::v1::UpdateAzureClusterRequest const &, Options)

Updates an AzureCluster.

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

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

UpdateAzureCluster(NoAwaitTag, google::cloud::gkemulticloud::v1::UpdateAzureClusterRequest const &, Options)

Updates an AzureCluster.

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::UpdateAzureClusterRequest const &`
`opts`	`Options`

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

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

Updates an AzureCluster.

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::AzureCluster > >`

GetAzureCluster(std::string const &, Options)

Describes a specific AzureCluster resource.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the AzureCluster resource to describe. `AzureCluster` names are formatted as `projects/<project-id>/locations/<region>/azureClusters/<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::AzureCluster >`	the result of the RPC. The response message type (google.cloud.gkemulticloud.v1.AzureCluster) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetAzureCluster(google::cloud::gkemulticloud::v1::GetAzureClusterRequest const &, Options)

Describes a specific AzureCluster resource.

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

ListAzureClusters(std::string const &, Options)

Lists all AzureCluster 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 AzureCluster 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::AzureCluster >

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

ListAzureClusters(google::cloud::gkemulticloud::v1::ListAzureClustersRequest, Options)

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

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

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

DeleteAzureCluster(std::string const &, Options)

Deletes a specific AzureCluster resource.

Fails if the cluster has one or more associated AzureNodePool 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 AzureCluster to delete. `AzureCluster` names are formatted as `projects/<project-id>/locations/<region>/azureClusters/<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.

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

Deletes a specific AzureCluster 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 >`

DeleteAzureCluster(google::cloud::gkemulticloud::v1::DeleteAzureClusterRequest const &, Options)

Deletes a specific AzureCluster resource.

Fails if the cluster has one or more associated AzureNodePool 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::DeleteAzureClusterRequest 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.DeleteAzureClusterRequest. 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.

DeleteAzureCluster(NoAwaitTag, google::cloud::gkemulticloud::v1::DeleteAzureClusterRequest const &, Options)

Deletes a specific AzureCluster 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::DeleteAzureClusterRequest const &`
`opts`	`Options`

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

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

Deletes a specific AzureCluster 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 > >`

GenerateAzureClusterAgentToken(google::cloud::gkemulticloud::v1::GenerateAzureClusterAgentTokenRequest const &, Options)

Generates an access token for a cluster agent.

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

GenerateAzureAccessToken(google::cloud::gkemulticloud::v1::GenerateAzureAccessTokenRequest const &, Options)

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

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

CreateAzureNodePool(std::string const &, google::cloud::gkemulticloud::v1::AzureNodePool const &, std::string const &, Options)

Creates a new AzureNodePool, attached to a given AzureCluster.

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 AzureCluster resource where this node pool will be created. `AzureCluster` names are formatted as `projects/<project-id>/locations/<region>/azureClusters/<cluster-id>`. See Resource Names for more details on Google Cloud resource names.
`azure_node_pool`	`google::cloud::gkemulticloud::v1::AzureNodePool const &` Required. The specification of the AzureNodePool to create.
`azure_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 AzureNodePool resource name formatted as `projects/<project-id>/locations/<region>/azureClusters/<cluster-id>/azureNodePools/<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::AzureNodePool > >

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

CreateAzureNodePool(NoAwaitTag, std::string const &, google::cloud::gkemulticloud::v1::AzureNodePool const &, std::string const &, Options)

Creates a new AzureNodePool, attached to a given AzureCluster.

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 &`
`azure_node_pool`	`google::cloud::gkemulticloud::v1::AzureNodePool const &`
`azure_node_pool_id`	`std::string const &`
`opts`	`Options`

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

CreateAzureNodePool(google::cloud::gkemulticloud::v1::CreateAzureNodePoolRequest const &, Options)

Creates a new AzureNodePool, attached to a given AzureCluster.

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::CreateAzureNodePoolRequest 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.CreateAzureNodePoolRequest. 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::AzureNodePool > >

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

CreateAzureNodePool(NoAwaitTag, google::cloud::gkemulticloud::v1::CreateAzureNodePoolRequest const &, Options)

Creates a new AzureNodePool, attached to a given AzureCluster.

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::CreateAzureNodePoolRequest const &`
`opts`	`Options`

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

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

Creates a new AzureNodePool, attached to a given AzureCluster.

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::AzureNodePool > >`

UpdateAzureNodePool(google::cloud::gkemulticloud::v1::AzureNodePool const &, google::protobuf::FieldMask const &, Options)

Updates an AzureNodePool.

Parameters
Name	Description
`azure_node_pool`	`google::cloud::gkemulticloud::v1::AzureNodePool const &` Required. The AzureNodePool 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 AzureNodePool: *. `annotations`. `version`. `autoscaling.min_node_count`. `autoscaling.max_node_count`. `config.ssh_config.authorized_key`. `management.auto_repair`. `management`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

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

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

UpdateAzureNodePool(NoAwaitTag, google::cloud::gkemulticloud::v1::AzureNodePool const &, google::protobuf::FieldMask const &, Options)

Updates an AzureNodePool.

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`
`azure_node_pool`	`google::cloud::gkemulticloud::v1::AzureNodePool const &`
`update_mask`	`google::protobuf::FieldMask const &`
`opts`	`Options`

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

UpdateAzureNodePool(google::cloud::gkemulticloud::v1::UpdateAzureNodePoolRequest const &, Options)

Updates an AzureNodePool.

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

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

UpdateAzureNodePool(NoAwaitTag, google::cloud::gkemulticloud::v1::UpdateAzureNodePoolRequest const &, Options)

Updates an AzureNodePool.

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::UpdateAzureNodePoolRequest const &`
`opts`	`Options`

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

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

Updates an AzureNodePool.

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::AzureNodePool > >`

GetAzureNodePool(std::string const &, Options)

Describes a specific AzureNodePool resource.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the AzureNodePool resource to describe. `AzureNodePool` names are formatted as `projects/<project-id>/locations/<region>/azureClusters/<cluster-id>/azureNodePools/<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::AzureNodePool >`	the result of the RPC. The response message type (google.cloud.gkemulticloud.v1.AzureNodePool) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetAzureNodePool(google::cloud::gkemulticloud::v1::GetAzureNodePoolRequest const &, Options)

Describes a specific AzureNodePool resource.

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

ListAzureNodePools(std::string const &, Options)

Lists all AzureNodePool resources on a given AzureCluster.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent `AzureCluster` which owns this collection of AzureNodePool resources. `AzureCluster` names are formatted as `projects/<project-id>/locations/<region>/azureClusters/<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::AzureNodePool >

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

ListAzureNodePools(google::cloud::gkemulticloud::v1::ListAzureNodePoolsRequest, Options)

Lists all AzureNodePool resources on a given AzureCluster.

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

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

DeleteAzureNodePool(std::string const &, Options)

Deletes a specific AzureNodePool 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 AzureNodePool to delete. `AzureNodePool` names are formatted as `projects/<project-id>/locations/<region>/azureClusters/<cluster-id>/azureNodePools/<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.

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

Deletes a specific AzureNodePool 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 >`

DeleteAzureNodePool(google::cloud::gkemulticloud::v1::DeleteAzureNodePoolRequest const &, Options)

Deletes a specific AzureNodePool 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::DeleteAzureNodePoolRequest 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.DeleteAzureNodePoolRequest. 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.

DeleteAzureNodePool(NoAwaitTag, google::cloud::gkemulticloud::v1::DeleteAzureNodePoolRequest const &, Options)

Deletes a specific AzureNodePool 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::DeleteAzureNodePoolRequest const &`
`opts`	`Options`

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

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

Deletes a specific AzureNodePool 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 > >`

GetAzureOpenIdConfig(std::string const &, Options)

Gets the OIDC discovery document for the cluster.

See the OpenID Connect Discovery 1.0 specification for details.

Parameters
Name	Description
`azure_cluster`	`std::string const &` Required. The AzureCluster, which owns the OIDC discovery document. Format: `projects/<project-id>/locations/<region>/azureClusters/<cluster-id>`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

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

GetAzureJsonWebKeys(std::string const &, Options)

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

Parameters
Name	Description
`azure_cluster`	`std::string const &` Required. The AzureCluster, which owns the JsonWebKeys. Format: `projects/<project-id>/locations/<region>/azureClusters/<cluster-id>`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

GetAzureJsonWebKeys(google::cloud::gkemulticloud::v1::GetAzureJsonWebKeysRequest const &, Options)

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

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

GetAzureServerConfig(std::string const &, Options)

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

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the AzureServerConfig resource to describe. `AzureServerConfig` names are formatted as `projects/<project-id>/locations/<region>/azureServerConfig`. 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::AzureServerConfig >`	the result of the RPC. The response message type (google.cloud.gkemulticloud.v1.AzureServerConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetAzureServerConfig(google::cloud::gkemulticloud::v1::GetAzureServerConfigRequest const &, Options)

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

Parameters
Name	Description
`request`	`google::cloud::gkemulticloud::v1::GetAzureServerConfigRequest 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.GetAzureServerConfigRequest. 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::AzureServerConfig >`	the result of the RPC. The response message type (google.cloud.gkemulticloud.v1.AzureServerConfig) 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.

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.