ClusterControllerClient (Google Cloud Dataproc Parent 4.0.8 API)

java.lang.Object
- com.google.cloud.dataproc.v1.ClusterControllerClient

All Implemented Interfaces:: BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class ClusterControllerClient
extends Object
implements BackgroundResource

Service Description: The ClusterControllerService provides methods to manage clusters of Compute Engine instances.

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 (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   String projectId = "projectId-894832108";
   String region = "region-934795532";
   String clusterName = "clusterName-1141738587";
   Cluster response = clusterControllerClient.getCluster(projectId, region, clusterName);
 }

Note: close() needs to be called on the ClusterControllerClient 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:

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.
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.
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 ClusterControllerSettings 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
 ClusterControllerSettings clusterControllerSettings =
     ClusterControllerSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ClusterControllerClient clusterControllerClient =
     ClusterControllerClient.create(clusterControllerSettings);

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
 ClusterControllerSettings clusterControllerSettings =
     ClusterControllerSettings.newBuilder().setEndpoint(myEndpoint).build();
 ClusterControllerClient clusterControllerClient =
     ClusterControllerClient.create(clusterControllerSettings);

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
 ClusterControllerSettings clusterControllerSettings =
     ClusterControllerSettings.newBuilder()
         .setTransportChannelProvider(
             ClusterControllerSettings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 ClusterControllerClient clusterControllerClient =
     ClusterControllerClient.create(clusterControllerSettings);

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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ClusterControllerClient.ListClustersFixedSizeCollection`
`static class`	`ClusterControllerClient.ListClustersPage`
`static class`	`ClusterControllerClient.ListClustersPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ClusterControllerClient(ClusterControllerSettings settings)` Constructs an instance of ClusterControllerClient, using the given settings.
`protected`	`ClusterControllerClient(ClusterControllerStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static ClusterControllerClient`	`create()` Constructs an instance of ClusterControllerClient with default settings.
`static ClusterControllerClient`	`create(ClusterControllerSettings settings)` Constructs an instance of ClusterControllerClient, using the given settings.
`static ClusterControllerClient`	`create(ClusterControllerStub stub)` Constructs an instance of ClusterControllerClient, using the given stub for making calls.
`OperationFuture<Cluster,ClusterOperationMetadata>`	`createClusterAsync(CreateClusterRequest request)` Creates a cluster in a project.
`OperationFuture<Cluster,ClusterOperationMetadata>`	`createClusterAsync(String projectId, String region, Cluster cluster)` Creates a cluster in a project.
`UnaryCallable<CreateClusterRequest,Operation>`	`createClusterCallable()` Creates a cluster in a project.
`OperationCallable<CreateClusterRequest,Cluster,ClusterOperationMetadata>`	`createClusterOperationCallable()` Creates a cluster in a project.
`OperationFuture<Empty,ClusterOperationMetadata>`	`deleteClusterAsync(DeleteClusterRequest request)` Deletes a cluster in a project.
`OperationFuture<Empty,ClusterOperationMetadata>`	`deleteClusterAsync(String projectId, String region, String clusterName)` Deletes a cluster in a project.
`UnaryCallable<DeleteClusterRequest,Operation>`	`deleteClusterCallable()` Deletes a cluster in a project.
`OperationCallable<DeleteClusterRequest,Empty,ClusterOperationMetadata>`	`deleteClusterOperationCallable()` Deletes a cluster in a project.
`OperationFuture<DiagnoseClusterResults,ClusterOperationMetadata>`	`diagnoseClusterAsync(DiagnoseClusterRequest request)` Gets cluster diagnostic information.
`OperationFuture<DiagnoseClusterResults,ClusterOperationMetadata>`	`diagnoseClusterAsync(String projectId, String region, String clusterName)` Gets cluster diagnostic information.
`UnaryCallable<DiagnoseClusterRequest,Operation>`	`diagnoseClusterCallable()` Gets cluster diagnostic information.
`OperationCallable<DiagnoseClusterRequest,DiagnoseClusterResults,ClusterOperationMetadata>`	`diagnoseClusterOperationCallable()` Gets cluster diagnostic information.
`Cluster`	`getCluster(GetClusterRequest request)` Gets the resource representation for a cluster in a project.
`Cluster`	`getCluster(String projectId, String region, String clusterName)` Gets the resource representation for a cluster in a project.
`UnaryCallable<GetClusterRequest,Cluster>`	`getClusterCallable()` Gets the resource representation for a cluster in a project.
`OperationsClient`	`getHttpJsonOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`OperationsClient`	`getOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`ClusterControllerSettings`	`getSettings()`
`ClusterControllerStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`ClusterControllerClient.ListClustersPagedResponse`	`listClusters(ListClustersRequest request)` Lists all regions/{region}/clusters in a project alphabetically.
`ClusterControllerClient.ListClustersPagedResponse`	`listClusters(String projectId, String region)` Lists all regions/{region}/clusters in a project alphabetically.
`ClusterControllerClient.ListClustersPagedResponse`	`listClusters(String projectId, String region, String filter)` Lists all regions/{region}/clusters in a project alphabetically.
`UnaryCallable<ListClustersRequest,ListClustersResponse>`	`listClustersCallable()` Lists all regions/{region}/clusters in a project alphabetically.
`UnaryCallable<ListClustersRequest,ClusterControllerClient.ListClustersPagedResponse>`	`listClustersPagedCallable()` Lists all regions/{region}/clusters in a project alphabetically.
`void`	`shutdown()`
`void`	`shutdownNow()`
`OperationFuture<Cluster,ClusterOperationMetadata>`	`startClusterAsync(StartClusterRequest request)` Starts a cluster in a project.
`UnaryCallable<StartClusterRequest,Operation>`	`startClusterCallable()` Starts a cluster in a project.
`OperationCallable<StartClusterRequest,Cluster,ClusterOperationMetadata>`	`startClusterOperationCallable()` Starts a cluster in a project.
`OperationFuture<Cluster,ClusterOperationMetadata>`	`stopClusterAsync(StopClusterRequest request)` Stops a cluster in a project.
`UnaryCallable<StopClusterRequest,Operation>`	`stopClusterCallable()` Stops a cluster in a project.
`OperationCallable<StopClusterRequest,Cluster,ClusterOperationMetadata>`	`stopClusterOperationCallable()` Stops a cluster in a project.
`OperationFuture<Cluster,ClusterOperationMetadata>`	`updateClusterAsync(String projectId, String region, String clusterName, Cluster cluster, FieldMask updateMask)` Updates a cluster in a project.
`OperationFuture<Cluster,ClusterOperationMetadata>`	`updateClusterAsync(UpdateClusterRequest request)` Updates a cluster in a project.
`UnaryCallable<UpdateClusterRequest,Operation>`	`updateClusterCallable()` Updates a cluster in a project.
`OperationCallable<UpdateClusterRequest,Cluster,ClusterOperationMetadata>`	`updateClusterOperationCallable()` Updates a cluster in a project.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- ClusterControllerClient
```
protected ClusterControllerClient(ClusterControllerSettings settings)
                           throws IOException
```
  Constructs an instance of ClusterControllerClient, 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.
  
  Throws:
  
  IOException
- ClusterControllerClient
```
protected ClusterControllerClient(ClusterControllerStub stub)
```

Method Detail

create

public static final ClusterControllerClient create()
                                            throws IOException

Constructs an instance of ClusterControllerClient with default settings.

Throws:: IOException

create
```
public static final ClusterControllerClient create(ClusterControllerSettings settings)
                                            throws IOException
```
Constructs an instance of ClusterControllerClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create
```
public static final ClusterControllerClient create(ClusterControllerStub stub)
```
Constructs an instance of ClusterControllerClient, using the given stub for making calls. This is for advanced usage - prefer using create(ClusterControllerSettings).

getSettings

public final ClusterControllerSettings getSettings()

getStub

public ClusterControllerStub getStub()

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.

getHttpJsonOperationsClient
```
@BetaApi
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.

createClusterAsync

public final OperationFuture<Cluster,ClusterOperationMetadata> createClusterAsync(String projectId,
                                                                                  String region,
                                                                                  Cluster cluster)

Creates a cluster in a project. The returned [Operation.metadata][google.longrunning.Operation.metadata] will be [ClusterOperationMetadata](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata).

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 (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   String projectId = "projectId-894832108";
   String region = "region-934795532";
   Cluster cluster = Cluster.newBuilder().build();
   Cluster response =
       clusterControllerClient.createClusterAsync(projectId, region, cluster).get();
 }

Parameters:: projectId - Required. The ID of the Google Cloud Platform project that the cluster belongs to.; region - Required. The Dataproc region in which to handle the request.; cluster - Required. The cluster to create.
Throws:: ApiException - if the remote call fails

createClusterAsync

public final OperationFuture<Cluster,ClusterOperationMetadata> createClusterAsync(CreateClusterRequest request)

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 (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   CreateClusterRequest request =
       CreateClusterRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setRegion("region-934795532")
           .setCluster(Cluster.newBuilder().build())
           .setRequestId("requestId693933066")
           .setActionOnFailedPrimaryWorkers(FailureAction.forNumber(0))
           .build();
   Cluster response = clusterControllerClient.createClusterAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

createClusterOperationCallable

public final OperationCallable<CreateClusterRequest,Cluster,ClusterOperationMetadata> createClusterOperationCallable()

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 (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   CreateClusterRequest request =
       CreateClusterRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setRegion("region-934795532")
           .setCluster(Cluster.newBuilder().build())
           .setRequestId("requestId693933066")
           .setActionOnFailedPrimaryWorkers(FailureAction.forNumber(0))
           .build();
   OperationFuture<Cluster, ClusterOperationMetadata> future =
       clusterControllerClient.createClusterOperationCallable().futureCall(request);
   // Do something.
   Cluster response = future.get();
 }

createClusterCallable

public final UnaryCallable<CreateClusterRequest,Operation> createClusterCallable()

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 (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   CreateClusterRequest request =
       CreateClusterRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setRegion("region-934795532")
           .setCluster(Cluster.newBuilder().build())
           .setRequestId("requestId693933066")
           .setActionOnFailedPrimaryWorkers(FailureAction.forNumber(0))
           .build();
   ApiFuture<Operation> future =
       clusterControllerClient.createClusterCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

updateClusterAsync
```
public final OperationFuture<Cluster,ClusterOperationMetadata> updateClusterAsync(String projectId,
                                                                                  String region,
                                                                                  String clusterName,
                                                                                  Cluster cluster,
                                                                                  FieldMask updateMask)
```
Updates a cluster in a project. The returned [Operation.metadata][google.longrunning.Operation.metadata] will be [ClusterOperationMetadata](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata). The cluster must be in a [`RUNNING`][google.cloud.dataproc.v1.ClusterStatus.State] state or an error is returned.
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 (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   String projectId = "projectId-894832108";
   String region = "region-934795532";
   String clusterName = "clusterName-1141738587";
   Cluster cluster = Cluster.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Cluster response =
       clusterControllerClient
           .updateClusterAsync(projectId, region, clusterName, cluster, updateMask)
           .get();
 }
 
```
Parameters:

projectId - Required. The ID of the Google Cloud Platform project the cluster belongs to.

region - Required. The Dataproc region in which to handle the request.

clusterName - Required. The cluster name.

cluster - Required. The changes to the cluster.

updateMask - Required. Specifies the path, relative to `Cluster`, of the field to update. For example, to change the number of workers in a cluster to 5, the `update_mask` parameter would be specified as `config.worker_config.num_instances`, and the `PATCH` request body would specify the new value, as follows:
{ "config":{ "workerConfig":{ "numInstances":"5" } } } Similarly, to change the number of preemptible workers in a cluster to 5, the `update_mask` parameter would be `config.secondary_worker_config.num_instances`, and the `PATCH` request body would be set as follows:
{ "config":{ "secondaryWorkerConfig":{ "numInstances":"5" } } } <strong>Note:</strong> Currently, only the following fields can be updated:
<table> <tbody> <tr> <td><strong>Mask</strong></td> <td><strong>Purpose</strong></td> </tr> <tr> <td><strong><em>labels</em></strong></td> <td>Update labels</td> </tr> <tr> <td><strong><em>config.worker_config.num_instances</em></strong></td> <td>Resize primary worker group</td> </tr> <tr> <td><strong><em>config.secondary_worker_config.num_instances</em></strong></td> <td>Resize secondary worker group</td> </tr> <tr> <td>config.autoscaling_config.policy_uri</td><td>Use, stop using, or change autoscaling policies</td> </tr> </tbody> </table>

Throws:

ApiException - if the remote call fails

updateClusterAsync

public final OperationFuture<Cluster,ClusterOperationMetadata> updateClusterAsync(UpdateClusterRequest request)

Updates a cluster in a project. The returned [Operation.metadata][google.longrunning.Operation.metadata] will be [ClusterOperationMetadata](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata). The cluster must be in a [`RUNNING`][google.cloud.dataproc.v1.ClusterStatus.State] state or an error is returned.

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 (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   UpdateClusterRequest request =
       UpdateClusterRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setRegion("region-934795532")
           .setClusterName("clusterName-1141738587")
           .setCluster(Cluster.newBuilder().build())
           .setGracefulDecommissionTimeout(Duration.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   Cluster response = clusterControllerClient.updateClusterAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

updateClusterOperationCallable

public final OperationCallable<UpdateClusterRequest,Cluster,ClusterOperationMetadata> updateClusterOperationCallable()

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 (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   UpdateClusterRequest request =
       UpdateClusterRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setRegion("region-934795532")
           .setClusterName("clusterName-1141738587")
           .setCluster(Cluster.newBuilder().build())
           .setGracefulDecommissionTimeout(Duration.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Cluster, ClusterOperationMetadata> future =
       clusterControllerClient.updateClusterOperationCallable().futureCall(request);
   // Do something.
   Cluster response = future.get();
 }

updateClusterCallable

public final UnaryCallable<UpdateClusterRequest,Operation> updateClusterCallable()

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 (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   UpdateClusterRequest request =
       UpdateClusterRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setRegion("region-934795532")
           .setClusterName("clusterName-1141738587")
           .setCluster(Cluster.newBuilder().build())
           .setGracefulDecommissionTimeout(Duration.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       clusterControllerClient.updateClusterCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

stopClusterAsync

public final OperationFuture<Cluster,ClusterOperationMetadata> stopClusterAsync(StopClusterRequest request)

Stops a cluster in a project.

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 (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   StopClusterRequest request =
       StopClusterRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setRegion("region-934795532")
           .setClusterName("clusterName-1141738587")
           .setClusterUuid("clusterUuid-1141510955")
           .setRequestId("requestId693933066")
           .build();
   Cluster response = clusterControllerClient.stopClusterAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

stopClusterOperationCallable

public final OperationCallable<StopClusterRequest,Cluster,ClusterOperationMetadata> stopClusterOperationCallable()

Stops a cluster in a project.

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 (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   StopClusterRequest request =
       StopClusterRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setRegion("region-934795532")
           .setClusterName("clusterName-1141738587")
           .setClusterUuid("clusterUuid-1141510955")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Cluster, ClusterOperationMetadata> future =
       clusterControllerClient.stopClusterOperationCallable().futureCall(request);
   // Do something.
   Cluster response = future.get();
 }

stopClusterCallable

public final UnaryCallable<StopClusterRequest,Operation> stopClusterCallable()

Stops a cluster in a project.

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 (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   StopClusterRequest request =
       StopClusterRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setRegion("region-934795532")
           .setClusterName("clusterName-1141738587")
           .setClusterUuid("clusterUuid-1141510955")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       clusterControllerClient.stopClusterCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

startClusterAsync

public final OperationFuture<Cluster,ClusterOperationMetadata> startClusterAsync(StartClusterRequest request)

Starts a cluster in a project.

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 (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   StartClusterRequest request =
       StartClusterRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setRegion("region-934795532")
           .setClusterName("clusterName-1141738587")
           .setClusterUuid("clusterUuid-1141510955")
           .setRequestId("requestId693933066")
           .build();
   Cluster response = clusterControllerClient.startClusterAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

startClusterOperationCallable

public final OperationCallable<StartClusterRequest,Cluster,ClusterOperationMetadata> startClusterOperationCallable()

Starts a cluster in a project.

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 (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   StartClusterRequest request =
       StartClusterRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setRegion("region-934795532")
           .setClusterName("clusterName-1141738587")
           .setClusterUuid("clusterUuid-1141510955")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Cluster, ClusterOperationMetadata> future =
       clusterControllerClient.startClusterOperationCallable().futureCall(request);
   // Do something.
   Cluster response = future.get();
 }

startClusterCallable

public final UnaryCallable<StartClusterRequest,Operation> startClusterCallable()

Starts a cluster in a project.

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 (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   StartClusterRequest request =
       StartClusterRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setRegion("region-934795532")
           .setClusterName("clusterName-1141738587")
           .setClusterUuid("clusterUuid-1141510955")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       clusterControllerClient.startClusterCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

deleteClusterAsync

public final OperationFuture<Empty,ClusterOperationMetadata> deleteClusterAsync(String projectId,
                                                                                String region,
                                                                                String clusterName)

Deletes a cluster in a project. The returned [Operation.metadata][google.longrunning.Operation.metadata] will be [ClusterOperationMetadata](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata).

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 (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   String projectId = "projectId-894832108";
   String region = "region-934795532";
   String clusterName = "clusterName-1141738587";
   clusterControllerClient.deleteClusterAsync(projectId, region, clusterName).get();
 }

Parameters:: projectId - Required. The ID of the Google Cloud Platform project that the cluster belongs to.; region - Required. The Dataproc region in which to handle the request.; clusterName - Required. The cluster name.
Throws:: ApiException - if the remote call fails

deleteClusterAsync

public final OperationFuture<Empty,ClusterOperationMetadata> deleteClusterAsync(DeleteClusterRequest request)

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 (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   DeleteClusterRequest request =
       DeleteClusterRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setRegion("region-934795532")
           .setClusterName("clusterName-1141738587")
           .setClusterUuid("clusterUuid-1141510955")
           .setRequestId("requestId693933066")
           .build();
   clusterControllerClient.deleteClusterAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

deleteClusterOperationCallable

public final OperationCallable<DeleteClusterRequest,Empty,ClusterOperationMetadata> deleteClusterOperationCallable()

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 (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   DeleteClusterRequest request =
       DeleteClusterRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setRegion("region-934795532")
           .setClusterName("clusterName-1141738587")
           .setClusterUuid("clusterUuid-1141510955")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Empty, ClusterOperationMetadata> future =
       clusterControllerClient.deleteClusterOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }

deleteClusterCallable

public final UnaryCallable<DeleteClusterRequest,Operation> deleteClusterCallable()

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 (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   DeleteClusterRequest request =
       DeleteClusterRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setRegion("region-934795532")
           .setClusterName("clusterName-1141738587")
           .setClusterUuid("clusterUuid-1141510955")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       clusterControllerClient.deleteClusterCallable().futureCall(request);
   // Do something.
   future.get();
 }

getCluster

public final Cluster getCluster(String projectId,
                                String region,
                                String clusterName)

Gets the resource representation for a cluster in a project.

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 (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   String projectId = "projectId-894832108";
   String region = "region-934795532";
   String clusterName = "clusterName-1141738587";
   Cluster response = clusterControllerClient.getCluster(projectId, region, clusterName);
 }

Parameters:: projectId - Required. The ID of the Google Cloud Platform project that the cluster belongs to.; region - Required. The Dataproc region in which to handle the request.; clusterName - Required. The cluster name.
Throws:: ApiException - if the remote call fails

getCluster

public final Cluster getCluster(GetClusterRequest request)

Gets the resource representation for a cluster in a project.

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 (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   GetClusterRequest request =
       GetClusterRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setRegion("region-934795532")
           .setClusterName("clusterName-1141738587")
           .build();
   Cluster response = clusterControllerClient.getCluster(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

getClusterCallable

public final UnaryCallable<GetClusterRequest,Cluster> getClusterCallable()

Gets the resource representation for a cluster in a project.

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 (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   GetClusterRequest request =
       GetClusterRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setRegion("region-934795532")
           .setClusterName("clusterName-1141738587")
           .build();
   ApiFuture<Cluster> future = clusterControllerClient.getClusterCallable().futureCall(request);
   // Do something.
   Cluster response = future.get();
 }

listClusters

public final ClusterControllerClient.ListClustersPagedResponse listClusters(String projectId,
                                                                            String region)

Lists all regions/{region}/clusters in a project alphabetically.

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 (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   String projectId = "projectId-894832108";
   String region = "region-934795532";
   for (Cluster element : clusterControllerClient.listClusters(projectId, region).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: projectId - Required. The ID of the Google Cloud Platform project that the cluster belongs to.; region - Required. The Dataproc region in which to handle the request.
Throws:: ApiException - if the remote call fails

listClusters

public final ClusterControllerClient.ListClustersPagedResponse listClusters(String projectId,
                                                                            String region,
                                                                            String filter)

Lists all regions/{region}/clusters in a project alphabetically.

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 (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   String projectId = "projectId-894832108";
   String region = "region-934795532";
   String filter = "filter-1274492040";
   for (Cluster element :
       clusterControllerClient.listClusters(projectId, region, filter).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:

projectId - Required. The ID of the Google Cloud Platform project that the cluster belongs to.

region - Required. The Dataproc region in which to handle the request.

filter - Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:

field = value [AND [field = value]] ...

where **field** is one of `status.state`, `clusterName`, or `labels.[KEY]`, and `[KEY]` is a label key. **value** can be `*` to match all values. `status.state` can be one of the following: `ACTIVE`, `INACTIVE`, `CREATING`, `RUNNING`, `ERROR`, `DELETING`, or `UPDATING`. `ACTIVE` contains the `CREATING`, `UPDATING`, and `RUNNING` states. `INACTIVE` contains the `DELETING` and `ERROR` states. `clusterName` is the name of the cluster provided at creation time. Only the logical `AND` operator is supported; space-separated items are treated as having an implicit `AND` operator.

Example filter:

status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *

Throws:

ApiException - if the remote call fails

listClusters

public final ClusterControllerClient.ListClustersPagedResponse listClusters(ListClustersRequest request)

Lists all regions/{region}/clusters in a project alphabetically.

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 (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   ListClustersRequest request =
       ListClustersRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setRegion("region-934795532")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Cluster element : clusterControllerClient.listClusters(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

listClustersPagedCallable

public final UnaryCallable<ListClustersRequest,ClusterControllerClient.ListClustersPagedResponse> listClustersPagedCallable()

Lists all regions/{region}/clusters in a project alphabetically.

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 (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   ListClustersRequest request =
       ListClustersRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setRegion("region-934795532")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Cluster> future =
       clusterControllerClient.listClustersPagedCallable().futureCall(request);
   // Do something.
   for (Cluster element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listClustersCallable

public final UnaryCallable<ListClustersRequest,ListClustersResponse> listClustersCallable()

Lists all regions/{region}/clusters in a project alphabetically.

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 (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   ListClustersRequest request =
       ListClustersRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setRegion("region-934795532")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListClustersResponse response =
         clusterControllerClient.listClustersCallable().call(request);
     for (Cluster element : response.getClustersList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

diagnoseClusterAsync

public final OperationFuture<DiagnoseClusterResults,ClusterOperationMetadata> diagnoseClusterAsync(String projectId,
                                                                                                   String region,
                                                                                                   String clusterName)

Gets cluster diagnostic information. The returned [Operation.metadata][google.longrunning.Operation.metadata] will be [ClusterOperationMetadata](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata). After the operation completes, [Operation.response][google.longrunning.Operation.response] contains [DiagnoseClusterResults](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#diagnoseclusterresults).

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 (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   String projectId = "projectId-894832108";
   String region = "region-934795532";
   String clusterName = "clusterName-1141738587";
   DiagnoseClusterResults response =
       clusterControllerClient.diagnoseClusterAsync(projectId, region, clusterName).get();
 }

Parameters:: projectId - Required. The ID of the Google Cloud Platform project that the cluster belongs to.; region - Required. The Dataproc region in which to handle the request.; clusterName - Required. The cluster name.
Throws:: ApiException - if the remote call fails

diagnoseClusterAsync

public final OperationFuture<DiagnoseClusterResults,ClusterOperationMetadata> diagnoseClusterAsync(DiagnoseClusterRequest request)

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 (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   DiagnoseClusterRequest request =
       DiagnoseClusterRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setRegion("region-934795532")
           .setClusterName("clusterName-1141738587")
           .build();
   DiagnoseClusterResults response = clusterControllerClient.diagnoseClusterAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

diagnoseClusterOperationCallable

public final OperationCallable<DiagnoseClusterRequest,DiagnoseClusterResults,ClusterOperationMetadata> diagnoseClusterOperationCallable()

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 (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   DiagnoseClusterRequest request =
       DiagnoseClusterRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setRegion("region-934795532")
           .setClusterName("clusterName-1141738587")
           .build();
   OperationFuture<DiagnoseClusterResults, ClusterOperationMetadata> future =
       clusterControllerClient.diagnoseClusterOperationCallable().futureCall(request);
   // Do something.
   DiagnoseClusterResults response = future.get();
 }

diagnoseClusterCallable

public final UnaryCallable<DiagnoseClusterRequest,Operation> diagnoseClusterCallable()

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 (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   DiagnoseClusterRequest request =
       DiagnoseClusterRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setRegion("region-934795532")
           .setClusterName("clusterName-1141738587")
           .build();
   ApiFuture<Operation> future =
       clusterControllerClient.diagnoseClusterCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

close
```
public final void close()
```
Specified by:

close in interface AutoCloseable

shutdown
```
public void shutdown()
```
Specified by:

shutdown in interface BackgroundResource

isShutdown
```
public boolean isShutdown()
```
Specified by:

isShutdown in interface BackgroundResource

isTerminated
```
public boolean isTerminated()
```
Specified by:

isTerminated in interface BackgroundResource

shutdownNow
```
public void shutdownNow()
```
Specified by:

shutdownNow in interface BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:: awaitTermination in interface BackgroundResource
Throws:: InterruptedException

Class ClusterControllerClient

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ClusterControllerClient

ClusterControllerClient

Method Detail

create

create

create

getSettings

getStub

getOperationsClient

getHttpJsonOperationsClient

createClusterAsync

createClusterAsync

createClusterOperationCallable

createClusterCallable

updateClusterAsync

updateClusterAsync

updateClusterOperationCallable

updateClusterCallable

stopClusterAsync

stopClusterOperationCallable

stopClusterCallable

startClusterAsync

startClusterOperationCallable

startClusterCallable

deleteClusterAsync

deleteClusterAsync

deleteClusterOperationCallable

deleteClusterCallable

getCluster

getCluster

getClusterCallable

listClusters

listClusters

listClusters

listClustersPagedCallable

listClustersCallable

diagnoseClusterAsync

diagnoseClusterAsync

diagnoseClusterOperationCallable

diagnoseClusterCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination