Class AzureClustersClient (0.30.0)

GitHub RepositoryProduct Reference

Service Description: The AzureClusters API provides a single centrally managed service to create and manage Anthos clusters that run on Azure infrastructure.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   AzureClientName name = AzureClientName.of("[PROJECT]", "[LOCATION]", "[AZURE_CLIENT]");
   AzureClient response = azureClustersClient.getAzureClient(name);
 }
 

Note: close() needs to be called on the AzureClustersClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

  1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
  2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
  3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of AzureClustersSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 AzureClustersSettings azureClustersSettings =
     AzureClustersSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AzureClustersClient azureClustersClient = AzureClustersClient.create(azureClustersSettings);
 

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 AzureClustersSettings azureClustersSettings =
     AzureClustersSettings.newBuilder().setEndpoint(myEndpoint).build();
 AzureClustersClient azureClustersClient = AzureClustersClient.create(azureClustersSettings);
 

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 AzureClustersSettings azureClustersSettings =
     AzureClustersSettings.newHttpJsonBuilder().build();
 AzureClustersClient azureClustersClient = AzureClustersClient.create(azureClustersSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > AzureClustersClient

Static Methods

create()

public static final AzureClustersClient create()

Constructs an instance of AzureClustersClient with default settings.

Returns
TypeDescription
AzureClustersClient
Exceptions
TypeDescription
IOException

create(AzureClustersSettings settings)

public static final AzureClustersClient create(AzureClustersSettings settings)

Constructs an instance of AzureClustersClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
NameDescription
settingsAzureClustersSettings
Returns
TypeDescription
AzureClustersClient
Exceptions
TypeDescription
IOException

create(AzureClustersStub stub)

public static final AzureClustersClient create(AzureClustersStub stub)

Constructs an instance of AzureClustersClient, using the given stub for making calls. This is for advanced usage - prefer using create(AzureClustersSettings).

Parameter
NameDescription
stubAzureClustersStub
Returns
TypeDescription
AzureClustersClient

Constructors

AzureClustersClient(AzureClustersSettings settings)

protected AzureClustersClient(AzureClustersSettings settings)

Constructs an instance of AzureClustersClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
NameDescription
settingsAzureClustersSettings

AzureClustersClient(AzureClustersStub stub)

protected AzureClustersClient(AzureClustersStub stub)
Parameter
NameDescription
stubAzureClustersStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
NameDescription
durationlong
unitTimeUnit
Returns
TypeDescription
boolean
Exceptions
TypeDescription
InterruptedException

close()

public final void close()

createAzureClientAsync(CreateAzureClientRequest request)

public final OperationFuture<AzureClient,OperationMetadata> createAzureClientAsync(CreateAzureClientRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   CreateAzureClientRequest request =
       CreateAzureClientRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setAzureClient(AzureClient.newBuilder().build())
           .setAzureClientId("azureClientId-1735934475")
           .setValidateOnly(true)
           .build();
   AzureClient response = azureClustersClient.createAzureClientAsync(request).get();
 }
 
Parameter
NameDescription
requestCreateAzureClientRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<AzureClient,OperationMetadata>

createAzureClientAsync(LocationName parent, AzureClient azureClient, String azureClientId)

public final OperationFuture<AzureClient,OperationMetadata> createAzureClientAsync(LocationName parent, AzureClient azureClient, String azureClientId)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   AzureClient azureClient = AzureClient.newBuilder().build();
   String azureClientId = "azureClientId-1735934475";
   AzureClient response =
       azureClustersClient.createAzureClientAsync(parent, azureClient, azureClientId).get();
 }
 
Parameters
NameDescription
parentLocationName

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.

azureClientAzureClient

Required. The specification of the AzureClient to create.

azureClientIdString

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-/. Cannot be longer than 63 characters.

Returns
TypeDescription
OperationFuture<AzureClient,OperationMetadata>

createAzureClientAsync(String parent, AzureClient azureClient, String azureClientId)

public final OperationFuture<AzureClient,OperationMetadata> createAzureClientAsync(String parent, AzureClient azureClient, String azureClientId)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   AzureClient azureClient = AzureClient.newBuilder().build();
   String azureClientId = "azureClientId-1735934475";
   AzureClient response =
       azureClustersClient.createAzureClientAsync(parent, azureClient, azureClientId).get();
 }
 
Parameters
NameDescription
parentString

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.

azureClientAzureClient

Required. The specification of the AzureClient to create.

azureClientIdString

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-/. Cannot be longer than 63 characters.

Returns
TypeDescription
OperationFuture<AzureClient,OperationMetadata>

createAzureClientCallable()

public final UnaryCallable<CreateAzureClientRequest,Operation> createAzureClientCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   CreateAzureClientRequest request =
       CreateAzureClientRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setAzureClient(AzureClient.newBuilder().build())
           .setAzureClientId("azureClientId-1735934475")
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future =
       azureClustersClient.createAzureClientCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<CreateAzureClientRequest,Operation>

createAzureClientOperationCallable()

public final OperationCallable<CreateAzureClientRequest,AzureClient,OperationMetadata> createAzureClientOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   CreateAzureClientRequest request =
       CreateAzureClientRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setAzureClient(AzureClient.newBuilder().build())
           .setAzureClientId("azureClientId-1735934475")
           .setValidateOnly(true)
           .build();
   OperationFuture<AzureClient, OperationMetadata> future =
       azureClustersClient.createAzureClientOperationCallable().futureCall(request);
   // Do something.
   AzureClient response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<CreateAzureClientRequest,AzureClient,OperationMetadata>

createAzureClusterAsync(CreateAzureClusterRequest request)

public final OperationFuture<AzureCluster,OperationMetadata> createAzureClusterAsync(CreateAzureClusterRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   CreateAzureClusterRequest request =
       CreateAzureClusterRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setAzureCluster(AzureCluster.newBuilder().build())
           .setAzureClusterId("azureClusterId191689446")
           .setValidateOnly(true)
           .build();
   AzureCluster response = azureClustersClient.createAzureClusterAsync(request).get();
 }
 
Parameter
NameDescription
requestCreateAzureClusterRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<AzureCluster,OperationMetadata>

createAzureClusterAsync(LocationName parent, AzureCluster azureCluster, String azureClusterId)

public final OperationFuture<AzureCluster,OperationMetadata> createAzureClusterAsync(LocationName parent, AzureCluster azureCluster, String azureClusterId)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   AzureCluster azureCluster = AzureCluster.newBuilder().build();
   String azureClusterId = "azureClusterId191689446";
   AzureCluster response =
       azureClustersClient.createAzureClusterAsync(parent, azureCluster, azureClusterId).get();
 }
 
Parameters
NameDescription
parentLocationName

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.

azureClusterAzureCluster

Required. The specification of the AzureCluster to create.

azureClusterIdString

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-/. Cannot be longer than 63 characters.

Returns
TypeDescription
OperationFuture<AzureCluster,OperationMetadata>

createAzureClusterAsync(String parent, AzureCluster azureCluster, String azureClusterId)

public final OperationFuture<AzureCluster,OperationMetadata> createAzureClusterAsync(String parent, AzureCluster azureCluster, String azureClusterId)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   AzureCluster azureCluster = AzureCluster.newBuilder().build();
   String azureClusterId = "azureClusterId191689446";
   AzureCluster response =
       azureClustersClient.createAzureClusterAsync(parent, azureCluster, azureClusterId).get();
 }
 
Parameters
NameDescription
parentString

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.

azureClusterAzureCluster

Required. The specification of the AzureCluster to create.

azureClusterIdString

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-/. Cannot be longer than 63 characters.

Returns
TypeDescription
OperationFuture<AzureCluster,OperationMetadata>

createAzureClusterCallable()

public final UnaryCallable<CreateAzureClusterRequest,Operation> createAzureClusterCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   CreateAzureClusterRequest request =
       CreateAzureClusterRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setAzureCluster(AzureCluster.newBuilder().build())
           .setAzureClusterId("azureClusterId191689446")
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future =
       azureClustersClient.createAzureClusterCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<CreateAzureClusterRequest,Operation>

createAzureClusterOperationCallable()

public final OperationCallable<CreateAzureClusterRequest,AzureCluster,OperationMetadata> createAzureClusterOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   CreateAzureClusterRequest request =
       CreateAzureClusterRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setAzureCluster(AzureCluster.newBuilder().build())
           .setAzureClusterId("azureClusterId191689446")
           .setValidateOnly(true)
           .build();
   OperationFuture<AzureCluster, OperationMetadata> future =
       azureClustersClient.createAzureClusterOperationCallable().futureCall(request);
   // Do something.
   AzureCluster response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<CreateAzureClusterRequest,AzureCluster,OperationMetadata>

createAzureNodePoolAsync(AzureClusterName parent, AzureNodePool azureNodePool, String azureNodePoolId)

public final OperationFuture<AzureNodePool,OperationMetadata> createAzureNodePoolAsync(AzureClusterName parent, AzureNodePool azureNodePool, String azureNodePoolId)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   AzureClusterName parent = AzureClusterName.of("[PROJECT]", "[LOCATION]", "[AZURE_CLUSTER]");
   AzureNodePool azureNodePool = AzureNodePool.newBuilder().build();
   String azureNodePoolId = "azureNodePoolId-1766264088";
   AzureNodePool response =
       azureClustersClient
           .createAzureNodePoolAsync(parent, azureNodePool, azureNodePoolId)
           .get();
 }
 
Parameters
NameDescription
parentAzureClusterName

Required. The AzureCluster resource where this node pool will be created.

Location names are formatted as projects/<project-id>/locations/<region>.

See Resource Names for more details on Google Cloud resource names.

azureNodePoolAzureNodePool

Required. The specification of the AzureNodePool to create.

azureNodePoolIdString

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-/. Cannot be longer than 63 characters.

Returns
TypeDescription
OperationFuture<AzureNodePool,OperationMetadata>

createAzureNodePoolAsync(CreateAzureNodePoolRequest request)

public final OperationFuture<AzureNodePool,OperationMetadata> createAzureNodePoolAsync(CreateAzureNodePoolRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   CreateAzureNodePoolRequest request =
       CreateAzureNodePoolRequest.newBuilder()
           .setParent(
               AzureClusterName.of("[PROJECT]", "[LOCATION]", "[AZURE_CLUSTER]").toString())
           .setAzureNodePool(AzureNodePool.newBuilder().build())
           .setAzureNodePoolId("azureNodePoolId-1766264088")
           .setValidateOnly(true)
           .build();
   AzureNodePool response = azureClustersClient.createAzureNodePoolAsync(request).get();
 }
 
Parameter
NameDescription
requestCreateAzureNodePoolRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<AzureNodePool,OperationMetadata>

createAzureNodePoolAsync(String parent, AzureNodePool azureNodePool, String azureNodePoolId)

public final OperationFuture<AzureNodePool,OperationMetadata> createAzureNodePoolAsync(String parent, AzureNodePool azureNodePool, String azureNodePoolId)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   String parent = AzureClusterName.of("[PROJECT]", "[LOCATION]", "[AZURE_CLUSTER]").toString();
   AzureNodePool azureNodePool = AzureNodePool.newBuilder().build();
   String azureNodePoolId = "azureNodePoolId-1766264088";
   AzureNodePool response =
       azureClustersClient
           .createAzureNodePoolAsync(parent, azureNodePool, azureNodePoolId)
           .get();
 }
 
Parameters
NameDescription
parentString

Required. The AzureCluster resource where this node pool will be created.

Location names are formatted as projects/<project-id>/locations/<region>.

See Resource Names for more details on Google Cloud resource names.

azureNodePoolAzureNodePool

Required. The specification of the AzureNodePool to create.

azureNodePoolIdString

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-/. Cannot be longer than 63 characters.

Returns
TypeDescription
OperationFuture<AzureNodePool,OperationMetadata>

createAzureNodePoolCallable()

public final UnaryCallable<CreateAzureNodePoolRequest,Operation> createAzureNodePoolCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   CreateAzureNodePoolRequest request =
       CreateAzureNodePoolRequest.newBuilder()
           .setParent(
               AzureClusterName.of("[PROJECT]", "[LOCATION]", "[AZURE_CLUSTER]").toString())
           .setAzureNodePool(AzureNodePool.newBuilder().build())
           .setAzureNodePoolId("azureNodePoolId-1766264088")
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future =
       azureClustersClient.createAzureNodePoolCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<CreateAzureNodePoolRequest,Operation>

createAzureNodePoolOperationCallable()

public final OperationCallable<CreateAzureNodePoolRequest,AzureNodePool,OperationMetadata> createAzureNodePoolOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   CreateAzureNodePoolRequest request =
       CreateAzureNodePoolRequest.newBuilder()
           .setParent(
               AzureClusterName.of("[PROJECT]", "[LOCATION]", "[AZURE_CLUSTER]").toString())
           .setAzureNodePool(AzureNodePool.newBuilder().build())
           .setAzureNodePoolId("azureNodePoolId-1766264088")
           .setValidateOnly(true)
           .build();
   OperationFuture<AzureNodePool, OperationMetadata> future =
       azureClustersClient.createAzureNodePoolOperationCallable().futureCall(request);
   // Do something.
   AzureNodePool response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<CreateAzureNodePoolRequest,AzureNodePool,OperationMetadata>

deleteAzureClientAsync(AzureClientName name)

public final OperationFuture<Empty,OperationMetadata> deleteAzureClientAsync(AzureClientName name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   AzureClientName name = AzureClientName.of("[PROJECT]", "[LOCATION]", "[AZURE_CLIENT]");
   azureClustersClient.deleteAzureClientAsync(name).get();
 }
 
Parameter
NameDescription
nameAzureClientName

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.

Returns
TypeDescription
OperationFuture<Empty,OperationMetadata>

deleteAzureClientAsync(DeleteAzureClientRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteAzureClientAsync(DeleteAzureClientRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   DeleteAzureClientRequest request =
       DeleteAzureClientRequest.newBuilder()
           .setName(AzureClientName.of("[PROJECT]", "[LOCATION]", "[AZURE_CLIENT]").toString())
           .setAllowMissing(true)
           .setValidateOnly(true)
           .build();
   azureClustersClient.deleteAzureClientAsync(request).get();
 }
 
Parameter
NameDescription
requestDeleteAzureClientRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<Empty,OperationMetadata>

deleteAzureClientAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteAzureClientAsync(String name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   String name = AzureClientName.of("[PROJECT]", "[LOCATION]", "[AZURE_CLIENT]").toString();
   azureClustersClient.deleteAzureClientAsync(name).get();
 }
 
Parameter
NameDescription
nameString

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.

Returns
TypeDescription
OperationFuture<Empty,OperationMetadata>

deleteAzureClientCallable()

public final UnaryCallable<DeleteAzureClientRequest,Operation> deleteAzureClientCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   DeleteAzureClientRequest request =
       DeleteAzureClientRequest.newBuilder()
           .setName(AzureClientName.of("[PROJECT]", "[LOCATION]", "[AZURE_CLIENT]").toString())
           .setAllowMissing(true)
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future =
       azureClustersClient.deleteAzureClientCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
UnaryCallable<DeleteAzureClientRequest,Operation>

deleteAzureClientOperationCallable()

public final OperationCallable<DeleteAzureClientRequest,Empty,OperationMetadata> deleteAzureClientOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   DeleteAzureClientRequest request =
       DeleteAzureClientRequest.newBuilder()
           .setName(AzureClientName.of("[PROJECT]", "[LOCATION]", "[AZURE_CLIENT]").toString())
           .setAllowMissing(true)
           .setValidateOnly(true)
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       azureClustersClient.deleteAzureClientOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
OperationCallable<DeleteAzureClientRequest,Empty,OperationMetadata>

deleteAzureClusterAsync(AzureClusterName name)

public final OperationFuture<Empty,OperationMetadata> deleteAzureClusterAsync(AzureClusterName name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   AzureClusterName name = AzureClusterName.of("[PROJECT]", "[LOCATION]", "[AZURE_CLUSTER]");
   azureClustersClient.deleteAzureClusterAsync(name).get();
 }
 
Parameter
NameDescription
nameAzureClusterName

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.

Returns
TypeDescription
OperationFuture<Empty,OperationMetadata>

deleteAzureClusterAsync(DeleteAzureClusterRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteAzureClusterAsync(DeleteAzureClusterRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   DeleteAzureClusterRequest request =
       DeleteAzureClusterRequest.newBuilder()
           .setName(AzureClusterName.of("[PROJECT]", "[LOCATION]", "[AZURE_CLUSTER]").toString())
           .setAllowMissing(true)
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .build();
   azureClustersClient.deleteAzureClusterAsync(request).get();
 }
 
Parameter
NameDescription
requestDeleteAzureClusterRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<Empty,OperationMetadata>

deleteAzureClusterAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteAzureClusterAsync(String name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   String name = AzureClusterName.of("[PROJECT]", "[LOCATION]", "[AZURE_CLUSTER]").toString();
   azureClustersClient.deleteAzureClusterAsync(name).get();
 }
 
Parameter
NameDescription
nameString

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.

Returns
TypeDescription
OperationFuture<Empty,OperationMetadata>

deleteAzureClusterCallable()

public final UnaryCallable<DeleteAzureClusterRequest,Operation> deleteAzureClusterCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   DeleteAzureClusterRequest request =
       DeleteAzureClusterRequest.newBuilder()
           .setName(AzureClusterName.of("[PROJECT]", "[LOCATION]", "[AZURE_CLUSTER]").toString())
           .setAllowMissing(true)
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .build();
   ApiFuture<Operation> future =
       azureClustersClient.deleteAzureClusterCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
UnaryCallable<DeleteAzureClusterRequest,Operation>

deleteAzureClusterOperationCallable()

public final OperationCallable<DeleteAzureClusterRequest,Empty,OperationMetadata> deleteAzureClusterOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   DeleteAzureClusterRequest request =
       DeleteAzureClusterRequest.newBuilder()
           .setName(AzureClusterName.of("[PROJECT]", "[LOCATION]", "[AZURE_CLUSTER]").toString())
           .setAllowMissing(true)
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       azureClustersClient.deleteAzureClusterOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
OperationCallable<DeleteAzureClusterRequest,Empty,OperationMetadata>

deleteAzureNodePoolAsync(AzureNodePoolName name)

public final OperationFuture<Empty,OperationMetadata> deleteAzureNodePoolAsync(AzureNodePoolName name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   AzureNodePoolName name =
       AzureNodePoolName.of("[PROJECT]", "[LOCATION]", "[AZURE_CLUSTER]", "[AZURE_NODE_POOL]");
   azureClustersClient.deleteAzureNodePoolAsync(name).get();
 }
 
Parameter
NameDescription
nameAzureNodePoolName

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.

Returns
TypeDescription
OperationFuture<Empty,OperationMetadata>

deleteAzureNodePoolAsync(DeleteAzureNodePoolRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteAzureNodePoolAsync(DeleteAzureNodePoolRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   DeleteAzureNodePoolRequest request =
       DeleteAzureNodePoolRequest.newBuilder()
           .setName(
               AzureNodePoolName.of(
                       "[PROJECT]", "[LOCATION]", "[AZURE_CLUSTER]", "[AZURE_NODE_POOL]")
                   .toString())
           .setValidateOnly(true)
           .setAllowMissing(true)
           .setEtag("etag3123477")
           .build();
   azureClustersClient.deleteAzureNodePoolAsync(request).get();
 }
 
Parameter
NameDescription
requestDeleteAzureNodePoolRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<Empty,OperationMetadata>

deleteAzureNodePoolAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteAzureNodePoolAsync(String name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   String name =
       AzureNodePoolName.of("[PROJECT]", "[LOCATION]", "[AZURE_CLUSTER]", "[AZURE_NODE_POOL]")
           .toString();
   azureClustersClient.deleteAzureNodePoolAsync(name).get();
 }
 
Parameter
NameDescription
nameString

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.

Returns
TypeDescription
OperationFuture<Empty,OperationMetadata>

deleteAzureNodePoolCallable()

public final UnaryCallable<DeleteAzureNodePoolRequest,Operation> deleteAzureNodePoolCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   DeleteAzureNodePoolRequest request =
       DeleteAzureNodePoolRequest.newBuilder()
           .setName(
               AzureNodePoolName.of(
                       "[PROJECT]", "[LOCATION]", "[AZURE_CLUSTER]", "[AZURE_NODE_POOL]")
                   .toString())
           .setValidateOnly(true)
           .setAllowMissing(true)
           .setEtag("etag3123477")
           .build();
   ApiFuture<Operation> future =
       azureClustersClient.deleteAzureNodePoolCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
UnaryCallable<DeleteAzureNodePoolRequest,Operation>

deleteAzureNodePoolOperationCallable()

public final OperationCallable<DeleteAzureNodePoolRequest,Empty,OperationMetadata> deleteAzureNodePoolOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   DeleteAzureNodePoolRequest request =
       DeleteAzureNodePoolRequest.newBuilder()
           .setName(
               AzureNodePoolName.of(
                       "[PROJECT]", "[LOCATION]", "[AZURE_CLUSTER]", "[AZURE_NODE_POOL]")
                   .toString())
           .setValidateOnly(true)
           .setAllowMissing(true)
           .setEtag("etag3123477")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       azureClustersClient.deleteAzureNodePoolOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
OperationCallable<DeleteAzureNodePoolRequest,Empty,OperationMetadata>

generateAzureAccessToken(GenerateAzureAccessTokenRequest request)

public final GenerateAzureAccessTokenResponse generateAzureAccessToken(GenerateAzureAccessTokenRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   GenerateAzureAccessTokenRequest request =
       GenerateAzureAccessTokenRequest.newBuilder()
           .setAzureCluster(
               AzureClusterName.of("[PROJECT]", "[LOCATION]", "[AZURE_CLUSTER]").toString())
           .build();
   GenerateAzureAccessTokenResponse response =
       azureClustersClient.generateAzureAccessToken(request);
 }
 
Parameter
NameDescription
requestGenerateAzureAccessTokenRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
GenerateAzureAccessTokenResponse

generateAzureAccessTokenCallable()

public final UnaryCallable<GenerateAzureAccessTokenRequest,GenerateAzureAccessTokenResponse> generateAzureAccessTokenCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   GenerateAzureAccessTokenRequest request =
       GenerateAzureAccessTokenRequest.newBuilder()
           .setAzureCluster(
               AzureClusterName.of("[PROJECT]", "[LOCATION]", "[AZURE_CLUSTER]").toString())
           .build();
   ApiFuture<GenerateAzureAccessTokenResponse> future =
       azureClustersClient.generateAzureAccessTokenCallable().futureCall(request);
   // Do something.
   GenerateAzureAccessTokenResponse response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<GenerateAzureAccessTokenRequest,GenerateAzureAccessTokenResponse>

getAzureClient(AzureClientName name)

public final AzureClient getAzureClient(AzureClientName name)

Describes a specific AzureClient resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   AzureClientName name = AzureClientName.of("[PROJECT]", "[LOCATION]", "[AZURE_CLIENT]");
   AzureClient response = azureClustersClient.getAzureClient(name);
 }
 
Parameter
NameDescription
nameAzureClientName

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.

Returns
TypeDescription
AzureClient

getAzureClient(GetAzureClientRequest request)

public final AzureClient getAzureClient(GetAzureClientRequest request)

Describes a specific AzureClient resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   GetAzureClientRequest request =
       GetAzureClientRequest.newBuilder()
           .setName(AzureClientName.of("[PROJECT]", "[LOCATION]", "[AZURE_CLIENT]").toString())
           .build();
   AzureClient response = azureClustersClient.getAzureClient(request);
 }
 
Parameter
NameDescription
requestGetAzureClientRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
AzureClient

getAzureClient(String name)

public final AzureClient getAzureClient(String name)

Describes a specific AzureClient resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   String name = AzureClientName.of("[PROJECT]", "[LOCATION]", "[AZURE_CLIENT]").toString();
   AzureClient response = azureClustersClient.getAzureClient(name);
 }
 
Parameter
NameDescription
nameString

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.

Returns
TypeDescription
AzureClient

getAzureClientCallable()

public final UnaryCallable<GetAzureClientRequest,AzureClient> getAzureClientCallable()

Describes a specific AzureClient resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   GetAzureClientRequest request =
       GetAzureClientRequest.newBuilder()
           .setName(AzureClientName.of("[PROJECT]", "[LOCATION]", "[AZURE_CLIENT]").toString())
           .build();
   ApiFuture<AzureClient> future =
       azureClustersClient.getAzureClientCallable().futureCall(request);
   // Do something.
   AzureClient response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<GetAzureClientRequest,AzureClient>

getAzureCluster(AzureClusterName name)

public final AzureCluster getAzureCluster(AzureClusterName name)

Describes a specific AzureCluster resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   AzureClusterName name = AzureClusterName.of("[PROJECT]", "[LOCATION]", "[AZURE_CLUSTER]");
   AzureCluster response = azureClustersClient.getAzureCluster(name);
 }
 
Parameter
NameDescription
nameAzureClusterName

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.

Returns
TypeDescription
AzureCluster

getAzureCluster(GetAzureClusterRequest request)

public final AzureCluster getAzureCluster(GetAzureClusterRequest request)

Describes a specific AzureCluster resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   GetAzureClusterRequest request =
       GetAzureClusterRequest.newBuilder()
           .setName(AzureClusterName.of("[PROJECT]", "[LOCATION]", "[AZURE_CLUSTER]").toString())
           .build();
   AzureCluster response = azureClustersClient.getAzureCluster(request);
 }
 
Parameter
NameDescription
requestGetAzureClusterRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
AzureCluster

getAzureCluster(String name)

public final AzureCluster getAzureCluster(String name)

Describes a specific AzureCluster resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   String name = AzureClusterName.of("[PROJECT]", "[LOCATION]", "[AZURE_CLUSTER]").toString();
   AzureCluster response = azureClustersClient.getAzureCluster(name);
 }
 
Parameter
NameDescription
nameString

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.

Returns
TypeDescription
AzureCluster

getAzureClusterCallable()

public final UnaryCallable<GetAzureClusterRequest,AzureCluster> getAzureClusterCallable()

Describes a specific AzureCluster resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   GetAzureClusterRequest request =
       GetAzureClusterRequest.newBuilder()
           .setName(AzureClusterName.of("[PROJECT]", "[LOCATION]", "[AZURE_CLUSTER]").toString())
           .build();
   ApiFuture<AzureCluster> future =
       azureClustersClient.getAzureClusterCallable().futureCall(request);
   // Do something.
   AzureCluster response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<GetAzureClusterRequest,AzureCluster>

getAzureNodePool(AzureNodePoolName name)

public final AzureNodePool getAzureNodePool(AzureNodePoolName name)

Describes a specific AzureNodePool resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   AzureNodePoolName name =
       AzureNodePoolName.of("[PROJECT]", "[LOCATION]", "[AZURE_CLUSTER]", "[AZURE_NODE_POOL]");
   AzureNodePool response = azureClustersClient.getAzureNodePool(name);
 }
 
Parameter
NameDescription
nameAzureNodePoolName

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.

Returns
TypeDescription
AzureNodePool

getAzureNodePool(GetAzureNodePoolRequest request)

public final AzureNodePool getAzureNodePool(GetAzureNodePoolRequest request)

Describes a specific AzureNodePool resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   GetAzureNodePoolRequest request =
       GetAzureNodePoolRequest.newBuilder()
           .setName(
               AzureNodePoolName.of(
                       "[PROJECT]", "[LOCATION]", "[AZURE_CLUSTER]", "[AZURE_NODE_POOL]")
                   .toString())
           .build();
   AzureNodePool response = azureClustersClient.getAzureNodePool(request);
 }
 
Parameter
NameDescription
requestGetAzureNodePoolRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
AzureNodePool

getAzureNodePool(String name)

public final AzureNodePool getAzureNodePool(String name)

Describes a specific AzureNodePool resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   String name =
       AzureNodePoolName.of("[PROJECT]", "[LOCATION]", "[AZURE_CLUSTER]", "[AZURE_NODE_POOL]")
           .toString();
   AzureNodePool response = azureClustersClient.getAzureNodePool(name);
 }
 
Parameter
NameDescription
nameString

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.

Returns
TypeDescription
AzureNodePool

getAzureNodePoolCallable()

public final UnaryCallable<GetAzureNodePoolRequest,AzureNodePool> getAzureNodePoolCallable()

Describes a specific AzureNodePool resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   GetAzureNodePoolRequest request =
       GetAzureNodePoolRequest.newBuilder()
           .setName(
               AzureNodePoolName.of(
                       "[PROJECT]", "[LOCATION]", "[AZURE_CLUSTER]", "[AZURE_NODE_POOL]")
                   .toString())
           .build();
   ApiFuture<AzureNodePool> future =
       azureClustersClient.getAzureNodePoolCallable().futureCall(request);
   // Do something.
   AzureNodePool response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<GetAzureNodePoolRequest,AzureNodePool>

getAzureServerConfig(AzureServerConfigName name)

public final AzureServerConfig getAzureServerConfig(AzureServerConfigName name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   AzureServerConfigName name = AzureServerConfigName.of("[PROJECT]", "[LOCATION]");
   AzureServerConfig response = azureClustersClient.getAzureServerConfig(name);
 }
 
Parameter
NameDescription
nameAzureServerConfigName

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.

Returns
TypeDescription
AzureServerConfig

getAzureServerConfig(GetAzureServerConfigRequest request)

public final AzureServerConfig getAzureServerConfig(GetAzureServerConfigRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   GetAzureServerConfigRequest request =
       GetAzureServerConfigRequest.newBuilder()
           .setName(AzureServerConfigName.of("[PROJECT]", "[LOCATION]").toString())
           .build();
   AzureServerConfig response = azureClustersClient.getAzureServerConfig(request);
 }
 
Parameter
NameDescription
requestGetAzureServerConfigRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
AzureServerConfig

getAzureServerConfig(String name)

public final AzureServerConfig getAzureServerConfig(String name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   String name = AzureServerConfigName.of("[PROJECT]", "[LOCATION]").toString();
   AzureServerConfig response = azureClustersClient.getAzureServerConfig(name);
 }
 
Parameter
NameDescription
nameString

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.

Returns
TypeDescription
AzureServerConfig

getAzureServerConfigCallable()

public final UnaryCallable<GetAzureServerConfigRequest,AzureServerConfig> getAzureServerConfigCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   GetAzureServerConfigRequest request =
       GetAzureServerConfigRequest.newBuilder()
           .setName(AzureServerConfigName.of("[PROJECT]", "[LOCATION]").toString())
           .build();
   ApiFuture<AzureServerConfig> future =
       azureClustersClient.getAzureServerConfigCallable().futureCall(request);
   // Do something.
   AzureServerConfig response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<GetAzureServerConfigRequest,AzureServerConfig>

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
TypeDescription
OperationsClient

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
TypeDescription
OperationsClient

getSettings()

public final AzureClustersSettings getSettings()
Returns
TypeDescription
AzureClustersSettings

getStub()

public AzureClustersStub getStub()
Returns
TypeDescription
AzureClustersStub

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
boolean

listAzureClients(ListAzureClientsRequest request)

public final AzureClustersClient.ListAzureClientsPagedResponse listAzureClients(ListAzureClientsRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   ListAzureClientsRequest request =
       ListAzureClientsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (AzureClient element : azureClustersClient.listAzureClients(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
requestListAzureClientsRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
AzureClustersClient.ListAzureClientsPagedResponse

listAzureClients(LocationName parent)

public final AzureClustersClient.ListAzureClientsPagedResponse listAzureClients(LocationName parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (AzureClient element : azureClustersClient.listAzureClients(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentLocationName

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.

Returns
TypeDescription
AzureClustersClient.ListAzureClientsPagedResponse

listAzureClients(String parent)

public final AzureClustersClient.ListAzureClientsPagedResponse listAzureClients(String parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (AzureClient element : azureClustersClient.listAzureClients(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentString

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.

Returns
TypeDescription
AzureClustersClient.ListAzureClientsPagedResponse

listAzureClientsCallable()

public final UnaryCallable<ListAzureClientsRequest,ListAzureClientsResponse> listAzureClientsCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   ListAzureClientsRequest request =
       ListAzureClientsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListAzureClientsResponse response =
         azureClustersClient.listAzureClientsCallable().call(request);
     for (AzureClient element : response.getAzureClientsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListAzureClientsRequest,ListAzureClientsResponse>

listAzureClientsPagedCallable()

public final UnaryCallable<ListAzureClientsRequest,AzureClustersClient.ListAzureClientsPagedResponse> listAzureClientsPagedCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   ListAzureClientsRequest request =
       ListAzureClientsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<AzureClient> future =
       azureClustersClient.listAzureClientsPagedCallable().futureCall(request);
   // Do something.
   for (AzureClient element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListAzureClientsRequest,ListAzureClientsPagedResponse>

listAzureClusters(ListAzureClustersRequest request)

public final AzureClustersClient.ListAzureClustersPagedResponse listAzureClusters(ListAzureClustersRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   ListAzureClustersRequest request =
       ListAzureClustersRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (AzureCluster element : azureClustersClient.listAzureClusters(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
requestListAzureClustersRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
AzureClustersClient.ListAzureClustersPagedResponse

listAzureClusters(LocationName parent)

public final AzureClustersClient.ListAzureClustersPagedResponse listAzureClusters(LocationName parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (AzureCluster element : azureClustersClient.listAzureClusters(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentLocationName

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.

Returns
TypeDescription
AzureClustersClient.ListAzureClustersPagedResponse

listAzureClusters(String parent)

public final AzureClustersClient.ListAzureClustersPagedResponse listAzureClusters(String parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (AzureCluster element : azureClustersClient.listAzureClusters(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentString

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.

Returns
TypeDescription
AzureClustersClient.ListAzureClustersPagedResponse

listAzureClustersCallable()

public final UnaryCallable<ListAzureClustersRequest,ListAzureClustersResponse> listAzureClustersCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   ListAzureClustersRequest request =
       ListAzureClustersRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListAzureClustersResponse response =
         azureClustersClient.listAzureClustersCallable().call(request);
     for (AzureCluster element : response.getAzureClustersList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListAzureClustersRequest,ListAzureClustersResponse>

listAzureClustersPagedCallable()

public final UnaryCallable<ListAzureClustersRequest,AzureClustersClient.ListAzureClustersPagedResponse> listAzureClustersPagedCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   ListAzureClustersRequest request =
       ListAzureClustersRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<AzureCluster> future =
       azureClustersClient.listAzureClustersPagedCallable().futureCall(request);
   // Do something.
   for (AzureCluster element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListAzureClustersRequest,ListAzureClustersPagedResponse>

listAzureNodePools(AzureClusterName parent)

public final AzureClustersClient.ListAzureNodePoolsPagedResponse listAzureNodePools(AzureClusterName parent)

Lists all AzureNodePool resources on a given AzureCluster.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   AzureClusterName parent = AzureClusterName.of("[PROJECT]", "[LOCATION]", "[AZURE_CLUSTER]");
   for (AzureNodePool element : azureClustersClient.listAzureNodePools(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentAzureClusterName

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.

Returns
TypeDescription
AzureClustersClient.ListAzureNodePoolsPagedResponse

listAzureNodePools(ListAzureNodePoolsRequest request)

public final AzureClustersClient.ListAzureNodePoolsPagedResponse listAzureNodePools(ListAzureNodePoolsRequest request)

Lists all AzureNodePool resources on a given AzureCluster.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   ListAzureNodePoolsRequest request =
       ListAzureNodePoolsRequest.newBuilder()
           .setParent(
               AzureClusterName.of("[PROJECT]", "[LOCATION]", "[AZURE_CLUSTER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (AzureNodePool element : azureClustersClient.listAzureNodePools(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
requestListAzureNodePoolsRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
AzureClustersClient.ListAzureNodePoolsPagedResponse

listAzureNodePools(String parent)

public final AzureClustersClient.ListAzureNodePoolsPagedResponse listAzureNodePools(String parent)

Lists all AzureNodePool resources on a given AzureCluster.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   String parent = AzureClusterName.of("[PROJECT]", "[LOCATION]", "[AZURE_CLUSTER]").toString();
   for (AzureNodePool element : azureClustersClient.listAzureNodePools(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentString

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.

Returns
TypeDescription
AzureClustersClient.ListAzureNodePoolsPagedResponse

listAzureNodePoolsCallable()

public final UnaryCallable<ListAzureNodePoolsRequest,ListAzureNodePoolsResponse> listAzureNodePoolsCallable()

Lists all AzureNodePool resources on a given AzureCluster.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   ListAzureNodePoolsRequest request =
       ListAzureNodePoolsRequest.newBuilder()
           .setParent(
               AzureClusterName.of("[PROJECT]", "[LOCATION]", "[AZURE_CLUSTER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListAzureNodePoolsResponse response =
         azureClustersClient.listAzureNodePoolsCallable().call(request);
     for (AzureNodePool element : response.getAzureNodePoolsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListAzureNodePoolsRequest,ListAzureNodePoolsResponse>

listAzureNodePoolsPagedCallable()

public final UnaryCallable<ListAzureNodePoolsRequest,AzureClustersClient.ListAzureNodePoolsPagedResponse> listAzureNodePoolsPagedCallable()

Lists all AzureNodePool resources on a given AzureCluster.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   ListAzureNodePoolsRequest request =
       ListAzureNodePoolsRequest.newBuilder()
           .setParent(
               AzureClusterName.of("[PROJECT]", "[LOCATION]", "[AZURE_CLUSTER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<AzureNodePool> future =
       azureClustersClient.listAzureNodePoolsPagedCallable().futureCall(request);
   // Do something.
   for (AzureNodePool element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListAzureNodePoolsRequest,ListAzureNodePoolsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateAzureClusterAsync(AzureCluster azureCluster, FieldMask updateMask)

public final OperationFuture<AzureCluster,OperationMetadata> updateAzureClusterAsync(AzureCluster azureCluster, FieldMask updateMask)

Updates an AzureCluster.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   AzureCluster azureCluster = AzureCluster.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   AzureCluster response =
       azureClustersClient.updateAzureClusterAsync(azureCluster, updateMask).get();
 }
 
Parameters
NameDescription
azureClusterAzureCluster

Required. The AzureCluster resource to update.

updateMaskFieldMask

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

Returns
TypeDescription
OperationFuture<AzureCluster,OperationMetadata>

updateAzureClusterAsync(UpdateAzureClusterRequest request)

public final OperationFuture<AzureCluster,OperationMetadata> updateAzureClusterAsync(UpdateAzureClusterRequest request)

Updates an AzureCluster.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   UpdateAzureClusterRequest request =
       UpdateAzureClusterRequest.newBuilder()
           .setAzureCluster(AzureCluster.newBuilder().build())
           .setValidateOnly(true)
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   AzureCluster response = azureClustersClient.updateAzureClusterAsync(request).get();
 }
 
Parameter
NameDescription
requestUpdateAzureClusterRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<AzureCluster,OperationMetadata>

updateAzureClusterCallable()

public final UnaryCallable<UpdateAzureClusterRequest,Operation> updateAzureClusterCallable()

Updates an AzureCluster.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   UpdateAzureClusterRequest request =
       UpdateAzureClusterRequest.newBuilder()
           .setAzureCluster(AzureCluster.newBuilder().build())
           .setValidateOnly(true)
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       azureClustersClient.updateAzureClusterCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<UpdateAzureClusterRequest,Operation>

updateAzureClusterOperationCallable()

public final OperationCallable<UpdateAzureClusterRequest,AzureCluster,OperationMetadata> updateAzureClusterOperationCallable()

Updates an AzureCluster.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   UpdateAzureClusterRequest request =
       UpdateAzureClusterRequest.newBuilder()
           .setAzureCluster(AzureCluster.newBuilder().build())
           .setValidateOnly(true)
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OperationFuture<AzureCluster, OperationMetadata> future =
       azureClustersClient.updateAzureClusterOperationCallable().futureCall(request);
   // Do something.
   AzureCluster response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<UpdateAzureClusterRequest,AzureCluster,OperationMetadata>

updateAzureNodePoolAsync(AzureNodePool azureNodePool, FieldMask updateMask)

public final OperationFuture<AzureNodePool,OperationMetadata> updateAzureNodePoolAsync(AzureNodePool azureNodePool, FieldMask updateMask)

Updates an AzureNodePool.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   AzureNodePool azureNodePool = AzureNodePool.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   AzureNodePool response =
       azureClustersClient.updateAzureNodePoolAsync(azureNodePool, updateMask).get();
 }
 
Parameters
NameDescription
azureNodePoolAzureNodePool

Required. The AzureNodePool resource to update.

updateMaskFieldMask

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.

Returns
TypeDescription
OperationFuture<AzureNodePool,OperationMetadata>

updateAzureNodePoolAsync(UpdateAzureNodePoolRequest request)

public final OperationFuture<AzureNodePool,OperationMetadata> updateAzureNodePoolAsync(UpdateAzureNodePoolRequest request)

Updates an AzureNodePool.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   UpdateAzureNodePoolRequest request =
       UpdateAzureNodePoolRequest.newBuilder()
           .setAzureNodePool(AzureNodePool.newBuilder().build())
           .setValidateOnly(true)
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   AzureNodePool response = azureClustersClient.updateAzureNodePoolAsync(request).get();
 }
 
Parameter
NameDescription
requestUpdateAzureNodePoolRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<AzureNodePool,OperationMetadata>

updateAzureNodePoolCallable()

public final UnaryCallable<UpdateAzureNodePoolRequest,Operation> updateAzureNodePoolCallable()

Updates an AzureNodePool.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   UpdateAzureNodePoolRequest request =
       UpdateAzureNodePoolRequest.newBuilder()
           .setAzureNodePool(AzureNodePool.newBuilder().build())
           .setValidateOnly(true)
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       azureClustersClient.updateAzureNodePoolCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<UpdateAzureNodePoolRequest,Operation>

updateAzureNodePoolOperationCallable()

public final OperationCallable<UpdateAzureNodePoolRequest,AzureNodePool,OperationMetadata> updateAzureNodePoolOperationCallable()

Updates an AzureNodePool.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   UpdateAzureNodePoolRequest request =
       UpdateAzureNodePoolRequest.newBuilder()
           .setAzureNodePool(AzureNodePool.newBuilder().build())
           .setValidateOnly(true)
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OperationFuture<AzureNodePool, OperationMetadata> future =
       azureClustersClient.updateAzureNodePoolOperationCallable().futureCall(request);
   // Do something.
   AzureNodePool response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<UpdateAzureNodePoolRequest,AzureNodePool,OperationMetadata>