- 4.44.0 (latest)
- 4.43.0
- 4.42.0
- 4.41.0
- 4.40.0
- 4.39.0
- 4.38.0
- 4.37.0
- 4.36.0
- 4.34.0
- 4.33.0
- 4.32.0
- 4.31.0
- 4.30.0
- 4.29.0
- 4.28.0
- 4.27.0
- 4.26.0
- 4.25.0
- 4.24.0
- 4.21.0
- 4.20.0
- 4.19.0
- 4.18.0
- 4.17.0
- 4.16.0
- 4.15.0
- 4.14.0
- 4.13.0
- 4.12.0
- 4.11.0
- 4.10.0
- 4.9.0
- 4.8.0
- 4.6.0
- 4.5.0
- 4.4.0
- 4.3.0
- 4.2.0
- 4.1.0
- 4.0.8
- 3.1.2
- 3.0.3
- 2.3.1
public class ClusterControllerClient 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.newHttpJsonBuilder().build();
ClusterControllerClient clusterControllerClient =
ClusterControllerClient.create(clusterControllerSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceStatic Methods
create()
public static final ClusterControllerClient create()
Constructs an instance of ClusterControllerClient with default settings.
Returns | |
---|---|
Type | Description |
ClusterControllerClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(ClusterControllerSettings settings)
public static final ClusterControllerClient create(ClusterControllerSettings settings)
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.
Parameter | |
---|---|
Name | Description |
settings | ClusterControllerSettings |
Returns | |
---|---|
Type | Description |
ClusterControllerClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(ClusterControllerStub stub)
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).
Parameter | |
---|---|
Name | Description |
stub | ClusterControllerStub |
Returns | |
---|---|
Type | Description |
ClusterControllerClient |
Constructors
ClusterControllerClient(ClusterControllerSettings settings)
protected ClusterControllerClient(ClusterControllerSettings settings)
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.
Parameter | |
---|---|
Name | Description |
settings | ClusterControllerSettings |
ClusterControllerClient(ClusterControllerStub stub)
protected ClusterControllerClient(ClusterControllerStub stub)
Parameter | |
---|---|
Name | Description |
stub | ClusterControllerStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Parameters | |
---|---|
Name | Description |
duration | long |
unit | TimeUnit |
Returns | |
---|---|
Type | Description |
boolean |
Exceptions | |
---|---|
Type | Description |
InterruptedException |
close()
public final void close()
createClusterAsync(CreateClusterRequest request)
public final OperationFuture<Cluster,ClusterOperationMetadata> createClusterAsync(CreateClusterRequest request)
Creates a cluster in a project. The returned Operation.metadata will be 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()) {
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();
}
Parameter | |
---|---|
Name | Description |
request | CreateClusterRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Cluster,ClusterOperationMetadata> |
createClusterAsync(String projectId, String region, Cluster cluster)
public final OperationFuture<Cluster,ClusterOperationMetadata> createClusterAsync(String projectId, String region, Cluster cluster)
Creates a cluster in a project. The returned Operation.metadata will be 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 | |
---|---|
Name | Description |
projectId | String Required. The ID of the Google Cloud Platform project that the cluster belongs to. |
region | String Required. The Dataproc region in which to handle the request. |
cluster | Cluster Required. The cluster to create. |
Returns | |
---|---|
Type | Description |
OperationFuture<Cluster,ClusterOperationMetadata> |
createClusterCallable()
public final UnaryCallable<CreateClusterRequest,Operation> createClusterCallable()
Creates a cluster in a project. The returned Operation.metadata will be 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()) {
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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateClusterRequest,Operation> |
createClusterOperationCallable()
public final OperationCallable<CreateClusterRequest,Cluster,ClusterOperationMetadata> createClusterOperationCallable()
Creates a cluster in a project. The returned Operation.metadata will be 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()) {
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();
}
Returns | |
---|---|
Type | Description |
OperationCallable<CreateClusterRequest,Cluster,ClusterOperationMetadata> |
deleteClusterAsync(DeleteClusterRequest request)
public final OperationFuture<Empty,ClusterOperationMetadata> deleteClusterAsync(DeleteClusterRequest request)
Deletes a cluster in a project. The returned Operation.metadata will be 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()) {
DeleteClusterRequest request =
DeleteClusterRequest.newBuilder()
.setProjectId("projectId-894832108")
.setRegion("region-934795532")
.setClusterName("clusterName-1141738587")
.setClusterUuid("clusterUuid-1141510955")
.setRequestId("requestId693933066")
.build();
clusterControllerClient.deleteClusterAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | DeleteClusterRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,ClusterOperationMetadata> |
deleteClusterAsync(String projectId, String region, String clusterName)
public final OperationFuture<Empty,ClusterOperationMetadata> deleteClusterAsync(String projectId, String region, String clusterName)
Deletes a cluster in a project. The returned Operation.metadata will be 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 | |
---|---|
Name | Description |
projectId | String Required. The ID of the Google Cloud Platform project that the cluster belongs to. |
region | String Required. The Dataproc region in which to handle the request. |
clusterName | String Required. The cluster name. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,ClusterOperationMetadata> |
deleteClusterCallable()
public final UnaryCallable<DeleteClusterRequest,Operation> deleteClusterCallable()
Deletes a cluster in a project. The returned Operation.metadata will be 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()) {
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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteClusterRequest,Operation> |
deleteClusterOperationCallable()
public final OperationCallable<DeleteClusterRequest,Empty,ClusterOperationMetadata> deleteClusterOperationCallable()
Deletes a cluster in a project. The returned Operation.metadata will be 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()) {
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();
}
Returns | |
---|---|
Type | Description |
OperationCallable<DeleteClusterRequest,Empty,ClusterOperationMetadata> |
diagnoseClusterAsync(DiagnoseClusterRequest request)
public final OperationFuture<DiagnoseClusterResults,ClusterOperationMetadata> diagnoseClusterAsync(DiagnoseClusterRequest request)
Gets cluster diagnostic information. The returned Operation.metadata will be ClusterOperationMetadata. After the operation completes, Operation.response contains 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()) {
DiagnoseClusterRequest request =
DiagnoseClusterRequest.newBuilder()
.setProjectId("projectId-894832108")
.setRegion("region-934795532")
.setClusterName("clusterName-1141738587")
.build();
DiagnoseClusterResults response = clusterControllerClient.diagnoseClusterAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | DiagnoseClusterRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<DiagnoseClusterResults,ClusterOperationMetadata> |
diagnoseClusterAsync(String projectId, String region, String clusterName)
public final OperationFuture<DiagnoseClusterResults,ClusterOperationMetadata> diagnoseClusterAsync(String projectId, String region, String clusterName)
Gets cluster diagnostic information. The returned Operation.metadata will be ClusterOperationMetadata. After the operation completes, Operation.response contains 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 | |
---|---|
Name | Description |
projectId | String Required. The ID of the Google Cloud Platform project that the cluster belongs to. |
region | String Required. The Dataproc region in which to handle the request. |
clusterName | String Required. The cluster name. |
Returns | |
---|---|
Type | Description |
OperationFuture<DiagnoseClusterResults,ClusterOperationMetadata> |
diagnoseClusterCallable()
public final UnaryCallable<DiagnoseClusterRequest,Operation> diagnoseClusterCallable()
Gets cluster diagnostic information. The returned Operation.metadata will be ClusterOperationMetadata. After the operation completes, Operation.response contains 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()) {
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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DiagnoseClusterRequest,Operation> |
diagnoseClusterOperationCallable()
public final OperationCallable<DiagnoseClusterRequest,DiagnoseClusterResults,ClusterOperationMetadata> diagnoseClusterOperationCallable()
Gets cluster diagnostic information. The returned Operation.metadata will be ClusterOperationMetadata. After the operation completes, Operation.response contains 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()) {
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();
}
Returns | |
---|---|
Type | Description |
OperationCallable<DiagnoseClusterRequest,DiagnoseClusterResults,ClusterOperationMetadata> |
getCluster(GetClusterRequest request)
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);
}
Parameter | |
---|---|
Name | Description |
request | GetClusterRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Cluster |
getCluster(String projectId, String region, String clusterName)
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 | |
---|---|
Name | Description |
projectId | String Required. The ID of the Google Cloud Platform project that the cluster belongs to. |
region | String Required. The Dataproc region in which to handle the request. |
clusterName | String Required. The cluster name. |
Returns | |
---|---|
Type | Description |
Cluster |
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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetClusterRequest,Cluster> |
getHttpJsonOperationsClient()
public final OperationsClient getHttpJsonOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
Returns | |
---|---|
Type | Description |
OperationsClient |
getOperationsClient()
public final OperationsClient getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
Returns | |
---|---|
Type | Description |
OperationsClient |
getSettings()
public final ClusterControllerSettings getSettings()
Returns | |
---|---|
Type | Description |
ClusterControllerSettings |
getStub()
public ClusterControllerStub getStub()
Returns | |
---|---|
Type | Description |
ClusterControllerStub |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
listClusters(ListClustersRequest request)
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);
}
}
Parameter | |
---|---|
Name | Description |
request | ListClustersRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ClusterControllerClient.ListClustersPagedResponse |
listClusters(String projectId, String region)
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 | |
---|---|
Name | Description |
projectId | String Required. The ID of the Google Cloud Platform project that the cluster belongs to. |
region | String Required. The Dataproc region in which to handle the request. |
Returns | |
---|---|
Type | Description |
ClusterControllerClient.ListClustersPagedResponse |
listClusters(String projectId, String region, String filter)
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 | |
---|---|
Name | Description |
projectId | String Required. The ID of the Google Cloud Platform project that the cluster belongs to. |
region | String Required. The Dataproc region in which to handle the request. |
filter | String 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 Example filter: status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = * |
Returns | |
---|---|
Type | Description |
ClusterControllerClient.ListClustersPagedResponse |
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;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListClustersRequest,ListClustersResponse> |
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);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListClustersRequest,ListClustersPagedResponse> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
startClusterAsync(StartClusterRequest request)
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();
}
Parameter | |
---|---|
Name | Description |
request | StartClusterRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Cluster,ClusterOperationMetadata> |
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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<StartClusterRequest,Operation> |
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();
}
Returns | |
---|---|
Type | Description |
OperationCallable<StartClusterRequest,Cluster,ClusterOperationMetadata> |
stopClusterAsync(StopClusterRequest request)
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();
}
Parameter | |
---|---|
Name | Description |
request | StopClusterRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Cluster,ClusterOperationMetadata> |
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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<StopClusterRequest,Operation> |
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();
}
Returns | |
---|---|
Type | Description |
OperationCallable<StopClusterRequest,Cluster,ClusterOperationMetadata> |
updateClusterAsync(UpdateClusterRequest request)
public final OperationFuture<Cluster,ClusterOperationMetadata> updateClusterAsync(UpdateClusterRequest request)
Updates a cluster in a project. The returned
Operation.metadata will be
ClusterOperationMetadata.
The cluster must be in a RUNNING
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();
}
Parameter | |
---|---|
Name | Description |
request | UpdateClusterRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Cluster,ClusterOperationMetadata> |
updateClusterAsync(String projectId, String region, String clusterName, Cluster cluster, FieldMask updateMask)
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 will be
ClusterOperationMetadata.
The cluster must be in a RUNNING
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 | |
---|---|
Name | Description |
projectId | String Required. The ID of the Google Cloud Platform project the cluster belongs to. |
region | String Required. The Dataproc region in which to handle the request. |
clusterName | String Required. The cluster name. |
cluster | Cluster Required. The changes to the cluster. |
updateMask | FieldMask Required. Specifies the path, relative to { "config":{ "workerConfig":{ "numInstances":"5" } } } Similarly, to change the number
of preemptible workers in a cluster to 5, the { "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> |
Returns | |
---|---|
Type | Description |
OperationFuture<Cluster,ClusterOperationMetadata> |
updateClusterCallable()
public final UnaryCallable<UpdateClusterRequest,Operation> updateClusterCallable()
Updates a cluster in a project. The returned
Operation.metadata will be
ClusterOperationMetadata.
The cluster must be in a RUNNING
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();
ApiFuture<Operation> future =
clusterControllerClient.updateClusterCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<UpdateClusterRequest,Operation> |
updateClusterOperationCallable()
public final OperationCallable<UpdateClusterRequest,Cluster,ClusterOperationMetadata> updateClusterOperationCallable()
Updates a cluster in a project. The returned
Operation.metadata will be
ClusterOperationMetadata.
The cluster must be in a RUNNING
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();
OperationFuture<Cluster, ClusterOperationMetadata> future =
clusterControllerClient.updateClusterOperationCallable().futureCall(request);
// Do something.
Cluster response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<UpdateClusterRequest,Cluster,ClusterOperationMetadata> |