com.google.cloud.dataproc.v1

Class ClusterControllerClient

java.lang.Object

com.google.cloud.dataproc.v1.ClusterControllerClient

All Implemented Interfaces:

BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator")
 @BetaApi
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:

 
 try (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   String projectId = "";
   String region = "";
   String clusterName = "";
   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:

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 ClusterControllerSettings to create(). For example:

To customize credentials:

 
 ClusterControllerSettings clusterControllerSettings =
     ClusterControllerSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ClusterControllerClient clusterControllerClient =
     ClusterControllerClient.create(clusterControllerSettings);
 
 

To customize the endpoint:

 
 ClusterControllerSettings clusterControllerSettings =
     ClusterControllerSettings.newBuilder().setEndpoint(myEndpoint).build();
 ClusterControllerClient clusterControllerClient =
     ClusterControllerClient.create(clusterControllerSettings);
 
 

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

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<com.google.cloud.dataproc.v1.Cluster,com.google.cloud.dataproc.v1.ClusterOperationMetadata>	createClusterAsync(com.google.cloud.dataproc.v1.CreateClusterRequest request) Creates a cluster in a project.
OperationFuture<com.google.cloud.dataproc.v1.Cluster,com.google.cloud.dataproc.v1.ClusterOperationMetadata>	createClusterAsync(String projectId, String region, com.google.cloud.dataproc.v1.Cluster cluster) Creates a cluster in a project.
UnaryCallable<com.google.cloud.dataproc.v1.CreateClusterRequest,Operation>	createClusterCallable() Creates a cluster in a project.
OperationCallable<com.google.cloud.dataproc.v1.CreateClusterRequest,com.google.cloud.dataproc.v1.Cluster,com.google.cloud.dataproc.v1.ClusterOperationMetadata>	createClusterOperationCallable() Creates a cluster in a project.
OperationFuture<Empty,com.google.cloud.dataproc.v1.ClusterOperationMetadata>	deleteClusterAsync(com.google.cloud.dataproc.v1.DeleteClusterRequest request) Deletes a cluster in a project.
OperationFuture<Empty,com.google.cloud.dataproc.v1.ClusterOperationMetadata>	deleteClusterAsync(String projectId, String region, String clusterName) Deletes a cluster in a project.
UnaryCallable<com.google.cloud.dataproc.v1.DeleteClusterRequest,Operation>	deleteClusterCallable() Deletes a cluster in a project.
OperationCallable<com.google.cloud.dataproc.v1.DeleteClusterRequest,Empty,com.google.cloud.dataproc.v1.ClusterOperationMetadata>	deleteClusterOperationCallable() Deletes a cluster in a project.
OperationFuture<Empty,com.google.cloud.dataproc.v1.DiagnoseClusterResults>	diagnoseClusterAsync(com.google.cloud.dataproc.v1.DiagnoseClusterRequest request) Gets cluster diagnostic information.
OperationFuture<Empty,com.google.cloud.dataproc.v1.DiagnoseClusterResults>	diagnoseClusterAsync(String projectId, String region, String clusterName) Gets cluster diagnostic information.
UnaryCallable<com.google.cloud.dataproc.v1.DiagnoseClusterRequest,Operation>	diagnoseClusterCallable() Gets cluster diagnostic information.
OperationCallable<com.google.cloud.dataproc.v1.DiagnoseClusterRequest,Empty,com.google.cloud.dataproc.v1.DiagnoseClusterResults>	diagnoseClusterOperationCallable() Gets cluster diagnostic information.
com.google.cloud.dataproc.v1.Cluster	getCluster(com.google.cloud.dataproc.v1.GetClusterRequest request) Gets the resource representation for a cluster in a project.
com.google.cloud.dataproc.v1.Cluster	getCluster(String projectId, String region, String clusterName) Gets the resource representation for a cluster in a project.
UnaryCallable<com.google.cloud.dataproc.v1.GetClusterRequest,com.google.cloud.dataproc.v1.Cluster>	getClusterCallable() Gets the resource representation for a cluster in a project.
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(com.google.cloud.dataproc.v1.ListClustersRequest request) Lists all regions/{region}/clusters in a project.
ClusterControllerClient.ListClustersPagedResponse	listClusters(String projectId, String region) Lists all regions/{region}/clusters in a project.
ClusterControllerClient.ListClustersPagedResponse	listClusters(String projectId, String region, String filter) Lists all regions/{region}/clusters in a project.
UnaryCallable<com.google.cloud.dataproc.v1.ListClustersRequest,com.google.cloud.dataproc.v1.ListClustersResponse>	listClustersCallable() Lists all regions/{region}/clusters in a project.
UnaryCallable<com.google.cloud.dataproc.v1.ListClustersRequest,ClusterControllerClient.ListClustersPagedResponse>	listClustersPagedCallable() Lists all regions/{region}/clusters in a project.
void	shutdown()
void	shutdownNow()
OperationFuture<com.google.cloud.dataproc.v1.Cluster,com.google.cloud.dataproc.v1.ClusterOperationMetadata>	updateClusterAsync(String projectId, String region, String clusterName, com.google.cloud.dataproc.v1.Cluster cluster, FieldMask updateMask) Updates a cluster in a project.
OperationFuture<com.google.cloud.dataproc.v1.Cluster,com.google.cloud.dataproc.v1.ClusterOperationMetadata>	updateClusterAsync(com.google.cloud.dataproc.v1.UpdateClusterRequest request) Updates a cluster in a project.
UnaryCallable<com.google.cloud.dataproc.v1.UpdateClusterRequest,Operation>	updateClusterCallable() Updates a cluster in a project.
OperationCallable<com.google.cloud.dataproc.v1.UpdateClusterRequest,com.google.cloud.dataproc.v1.Cluster,com.google.cloud.dataproc.v1.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

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
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

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
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 to use ClusterControllerSettings}.

getSettings

public final ClusterControllerSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public ClusterControllerStub getStub()

getOperationsClient

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
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.

createClusterAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<com.google.cloud.dataproc.v1.Cluster,com.google.cloud.dataproc.v1.ClusterOperationMetadata> createClusterAsync(String projectId,
                                                                                                                                                                                                                                                      String region,
                                                                                                                                                                                                                                                      com.google.cloud.dataproc.v1.Cluster cluster)

Creates a cluster in a project.

Sample code:

 try (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   String projectId = "";
   String region = "";
   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 Cloud Dataproc region in which to handle the request.

cluster - Required. The cluster to create.

Throws:

ApiException - if the remote call fails

createClusterAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<com.google.cloud.dataproc.v1.Cluster,com.google.cloud.dataproc.v1.ClusterOperationMetadata> createClusterAsync(com.google.cloud.dataproc.v1.CreateClusterRequest request)

Creates a cluster in a project.

Sample code:

 try (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   String projectId = "";
   String region = "";
   Cluster cluster = Cluster.newBuilder().build();
   CreateClusterRequest request = CreateClusterRequest.newBuilder()
     .setProjectId(projectId)
     .setRegion(region)
     .setCluster(cluster)
     .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

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final OperationCallable<com.google.cloud.dataproc.v1.CreateClusterRequest,com.google.cloud.dataproc.v1.Cluster,com.google.cloud.dataproc.v1.ClusterOperationMetadata> createClusterOperationCallable()

Creates a cluster in a project.

Sample code:

 try (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   String projectId = "";
   String region = "";
   Cluster cluster = Cluster.newBuilder().build();
   CreateClusterRequest request = CreateClusterRequest.newBuilder()
     .setProjectId(projectId)
     .setRegion(region)
     .setCluster(cluster)
     .build();
   OperationFuture<Cluster, ClusterOperationMetadata> future = clusterControllerClient.createClusterOperationCallable().futureCall(request);
   // Do something
   Cluster response = future.get();
 }
 

createClusterCallable

public final UnaryCallable<com.google.cloud.dataproc.v1.CreateClusterRequest,Operation> createClusterCallable()

Creates a cluster in a project.

Sample code:

 try (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   String projectId = "";
   String region = "";
   Cluster cluster = Cluster.newBuilder().build();
   CreateClusterRequest request = CreateClusterRequest.newBuilder()
     .setProjectId(projectId)
     .setRegion(region)
     .setCluster(cluster)
     .build();
   ApiFuture<Operation> future = clusterControllerClient.createClusterCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

updateClusterAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<com.google.cloud.dataproc.v1.Cluster,com.google.cloud.dataproc.v1.ClusterOperationMetadata> updateClusterAsync(String projectId,
                                                                                                                                                                                                                                                      String region,
                                                                                                                                                                                                                                                      String clusterName,
                                                                                                                                                                                                                                                      com.google.cloud.dataproc.v1.Cluster cluster,
                                                                                                                                                                                                                                                      FieldMask updateMask)

Updates a cluster in a project.

Sample code:

 try (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   String projectId = "";
   String region = "";
   String clusterName = "";
   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 Cloud 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> </tbody> </table>

Throws:

ApiException - if the remote call fails

updateClusterAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<com.google.cloud.dataproc.v1.Cluster,com.google.cloud.dataproc.v1.ClusterOperationMetadata> updateClusterAsync(com.google.cloud.dataproc.v1.UpdateClusterRequest request)

Updates a cluster in a project.

Sample code:

 try (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   String projectId = "";
   String region = "";
   String clusterName = "";
   Cluster cluster = Cluster.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   UpdateClusterRequest request = UpdateClusterRequest.newBuilder()
     .setProjectId(projectId)
     .setRegion(region)
     .setClusterName(clusterName)
     .setCluster(cluster)
     .setUpdateMask(updateMask)
     .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

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final OperationCallable<com.google.cloud.dataproc.v1.UpdateClusterRequest,com.google.cloud.dataproc.v1.Cluster,com.google.cloud.dataproc.v1.ClusterOperationMetadata> updateClusterOperationCallable()

Updates a cluster in a project.

Sample code:

 try (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   String projectId = "";
   String region = "";
   String clusterName = "";
   Cluster cluster = Cluster.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   UpdateClusterRequest request = UpdateClusterRequest.newBuilder()
     .setProjectId(projectId)
     .setRegion(region)
     .setClusterName(clusterName)
     .setCluster(cluster)
     .setUpdateMask(updateMask)
     .build();
   OperationFuture<Cluster, ClusterOperationMetadata> future = clusterControllerClient.updateClusterOperationCallable().futureCall(request);
   // Do something
   Cluster response = future.get();
 }
 

updateClusterCallable

public final UnaryCallable<com.google.cloud.dataproc.v1.UpdateClusterRequest,Operation> updateClusterCallable()

Updates a cluster in a project.

Sample code:

 try (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   String projectId = "";
   String region = "";
   String clusterName = "";
   Cluster cluster = Cluster.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   UpdateClusterRequest request = UpdateClusterRequest.newBuilder()
     .setProjectId(projectId)
     .setRegion(region)
     .setClusterName(clusterName)
     .setCluster(cluster)
     .setUpdateMask(updateMask)
     .build();
   ApiFuture<Operation> future = clusterControllerClient.updateClusterCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

deleteClusterAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<Empty,com.google.cloud.dataproc.v1.ClusterOperationMetadata> deleteClusterAsync(String projectId,
                                                                                                                                                                                                                       String region,
                                                                                                                                                                                                                       String clusterName)

Deletes a cluster in a project.

Sample code:

 try (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   String projectId = "";
   String region = "";
   String clusterName = "";
   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 Cloud Dataproc region in which to handle the request.

clusterName - Required. The cluster name.

Throws:

ApiException - if the remote call fails

deleteClusterAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<Empty,com.google.cloud.dataproc.v1.ClusterOperationMetadata> deleteClusterAsync(com.google.cloud.dataproc.v1.DeleteClusterRequest request)

Deletes a cluster in a project.

Sample code:

 try (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   String projectId = "";
   String region = "";
   String clusterName = "";
   DeleteClusterRequest request = DeleteClusterRequest.newBuilder()
     .setProjectId(projectId)
     .setRegion(region)
     .setClusterName(clusterName)
     .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

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final OperationCallable<com.google.cloud.dataproc.v1.DeleteClusterRequest,Empty,com.google.cloud.dataproc.v1.ClusterOperationMetadata> deleteClusterOperationCallable()

Deletes a cluster in a project.

Sample code:

 try (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   String projectId = "";
   String region = "";
   String clusterName = "";
   DeleteClusterRequest request = DeleteClusterRequest.newBuilder()
     .setProjectId(projectId)
     .setRegion(region)
     .setClusterName(clusterName)
     .build();
   OperationFuture<Empty, ClusterOperationMetadata> future = clusterControllerClient.deleteClusterOperationCallable().futureCall(request);
   // Do something
   future.get();
 }
 

deleteClusterCallable

public final UnaryCallable<com.google.cloud.dataproc.v1.DeleteClusterRequest,Operation> deleteClusterCallable()

Deletes a cluster in a project.

Sample code:

 try (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   String projectId = "";
   String region = "";
   String clusterName = "";
   DeleteClusterRequest request = DeleteClusterRequest.newBuilder()
     .setProjectId(projectId)
     .setRegion(region)
     .setClusterName(clusterName)
     .build();
   ApiFuture<Operation> future = clusterControllerClient.deleteClusterCallable().futureCall(request);
   // Do something
   future.get();
 }
 

getCluster

public final com.google.cloud.dataproc.v1.Cluster getCluster(String projectId,
                                                             String region,
                                                             String clusterName)

Gets the resource representation for a cluster in a project.

Sample code:

 try (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   String projectId = "";
   String region = "";
   String clusterName = "";
   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 Cloud Dataproc region in which to handle the request.

clusterName - Required. The cluster name.

Throws:

ApiException - if the remote call fails

getCluster

public final com.google.cloud.dataproc.v1.Cluster getCluster(com.google.cloud.dataproc.v1.GetClusterRequest request)

Gets the resource representation for a cluster in a project.

Sample code:

 try (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   String projectId = "";
   String region = "";
   String clusterName = "";
   GetClusterRequest request = GetClusterRequest.newBuilder()
     .setProjectId(projectId)
     .setRegion(region)
     .setClusterName(clusterName)
     .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<com.google.cloud.dataproc.v1.GetClusterRequest,com.google.cloud.dataproc.v1.Cluster> getClusterCallable()

Gets the resource representation for a cluster in a project.

Sample code:

 try (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   String projectId = "";
   String region = "";
   String clusterName = "";
   GetClusterRequest request = GetClusterRequest.newBuilder()
     .setProjectId(projectId)
     .setRegion(region)
     .setClusterName(clusterName)
     .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.

Sample code:

 try (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   String projectId = "";
   String region = "";
   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 Cloud 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.

Sample code:

 try (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   String projectId = "";
   String region = "";
   String filter = "";
   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 Cloud 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(com.google.cloud.dataproc.v1.ListClustersRequest request)

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

Sample code:

 try (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   String projectId = "";
   String region = "";
   ListClustersRequest request = ListClustersRequest.newBuilder()
     .setProjectId(projectId)
     .setRegion(region)
     .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<com.google.cloud.dataproc.v1.ListClustersRequest,ClusterControllerClient.ListClustersPagedResponse> listClustersPagedCallable()

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

Sample code:

 try (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   String projectId = "";
   String region = "";
   ListClustersRequest request = ListClustersRequest.newBuilder()
     .setProjectId(projectId)
     .setRegion(region)
     .build();
   ApiFuture<ListClustersPagedResponse> future = clusterControllerClient.listClustersPagedCallable().futureCall(request);
   // Do something
   for (Cluster element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listClustersCallable

public final UnaryCallable<com.google.cloud.dataproc.v1.ListClustersRequest,com.google.cloud.dataproc.v1.ListClustersResponse> listClustersCallable()

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

Sample code:

 try (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   String projectId = "";
   String region = "";
   ListClustersRequest request = ListClustersRequest.newBuilder()
     .setProjectId(projectId)
     .setRegion(region)
     .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

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<Empty,com.google.cloud.dataproc.v1.DiagnoseClusterResults> diagnoseClusterAsync(String projectId,
                                                                                                                                                                                                                       String region,
                                                                                                                                                                                                                       String clusterName)

Gets cluster diagnostic information. After the operation completes, the Operation.response field contains `DiagnoseClusterOutputLocation`.

Sample code:

 try (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   String projectId = "";
   String region = "";
   String clusterName = "";
   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 Cloud Dataproc region in which to handle the request.

clusterName - Required. The cluster name.

Throws:

ApiException - if the remote call fails

diagnoseClusterAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<Empty,com.google.cloud.dataproc.v1.DiagnoseClusterResults> diagnoseClusterAsync(com.google.cloud.dataproc.v1.DiagnoseClusterRequest request)

Gets cluster diagnostic information. After the operation completes, the Operation.response field contains `DiagnoseClusterOutputLocation`.

Sample code:

 try (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   String projectId = "";
   String region = "";
   String clusterName = "";
   DiagnoseClusterRequest request = DiagnoseClusterRequest.newBuilder()
     .setProjectId(projectId)
     .setRegion(region)
     .setClusterName(clusterName)
     .build();
   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

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final OperationCallable<com.google.cloud.dataproc.v1.DiagnoseClusterRequest,Empty,com.google.cloud.dataproc.v1.DiagnoseClusterResults> diagnoseClusterOperationCallable()

Gets cluster diagnostic information. After the operation completes, the Operation.response field contains `DiagnoseClusterOutputLocation`.

Sample code:

 try (ClusterControllerClient clusterControllerClient = ClusterControllerClient.create()) {
   String projectId = "";
   String region = "";
   String clusterName = "";
   DiagnoseClusterRequest request = DiagnoseClusterRequest.newBuilder()
     .setProjectId(projectId)
     .setRegion(region)
     .setClusterName(clusterName)
     .build();
   OperationFuture<Empty, DiagnoseClusterResults> future = clusterControllerClient.diagnoseClusterOperationCallable().futureCall(request);
   // Do something
   future.get();
 }
 

diagnoseClusterCallable

public final UnaryCallable<com.google.cloud.dataproc.v1.DiagnoseClusterRequest,Operation> diagnoseClusterCallable()

Gets cluster diagnostic information. After the operation completes, the Operation.response field contains `DiagnoseClusterOutputLocation`.

Sample code:

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