NodeGroupControllerClient (Google Cloud Dataproc 4.34.0 API)

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

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class NodeGroupControllerClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: The `NodeGroupControllerService` provides methods to manage node groups of Compute Engine managed 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 (NodeGroupControllerClient nodeGroupControllerClient = NodeGroupControllerClient.create()) {
   NodeGroupName name = NodeGroupName.of("[PROJECT]", "[REGION]", "[CLUSTER]", "[NODE_GROUP]");
   NodeGroup response = nodeGroupControllerClient.getNodeGroup(name);
 }

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

Methods
Method	Description	Method Variants
CreateNodeGroup	Creates a node group in a cluster. The returned [Operation.metadata][google.longrunning.Operation.metadata] is [NodeGroupOperationMetadata](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#nodegroupoperationmetadata).	Request object method variants only take one parameter, a request object, which must be constructed before the call. createNodeGroupAsync(CreateNodeGroupRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createNodeGroupAsync(ClusterRegionName parent, NodeGroup nodeGroup, String nodeGroupId) createNodeGroupAsync(String parent, NodeGroup nodeGroup, String nodeGroupId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createNodeGroupOperationCallable() createNodeGroupCallable()
ResizeNodeGroup	Resizes a node group in a cluster. The returned [Operation.metadata][google.longrunning.Operation.metadata] is [NodeGroupOperationMetadata](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#nodegroupoperationmetadata).	Request object method variants only take one parameter, a request object, which must be constructed before the call. resizeNodeGroupAsync(ResizeNodeGroupRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. resizeNodeGroupAsync(String name, int size) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. resizeNodeGroupOperationCallable() resizeNodeGroupCallable()
GetNodeGroup	Gets the resource representation for a node group in a cluster.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getNodeGroup(GetNodeGroupRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getNodeGroup(NodeGroupName name) getNodeGroup(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getNodeGroupCallable()
SetIamPolicy	Sets the access control policy on the specified resource. Replacesany existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.	Request object method variants only take one parameter, a request object, which must be constructed before the call. setIamPolicy(SetIamPolicyRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. setIamPolicyCallable()
GetIamPolicy	Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getIamPolicy(GetIamPolicyRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getIamPolicyCallable()
TestIamPermissions	Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.	Request object method variants only take one parameter, a request object, which must be constructed before the call. testIamPermissions(TestIamPermissionsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. testIamPermissionsCallable()

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 NodeGroupControllerSettings 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
 NodeGroupControllerSettings nodeGroupControllerSettings =
     NodeGroupControllerSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 NodeGroupControllerClient nodeGroupControllerClient =
     NodeGroupControllerClient.create(nodeGroupControllerSettings);

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
 NodeGroupControllerSettings nodeGroupControllerSettings =
     NodeGroupControllerSettings.newBuilder().setEndpoint(myEndpoint).build();
 NodeGroupControllerClient nodeGroupControllerClient =
     NodeGroupControllerClient.create(nodeGroupControllerSettings);

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
 NodeGroupControllerSettings nodeGroupControllerSettings =
     NodeGroupControllerSettings.newHttpJsonBuilder().build();
 NodeGroupControllerClient nodeGroupControllerClient =
     NodeGroupControllerClient.create(nodeGroupControllerSettings);

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

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`NodeGroupControllerClient(NodeGroupControllerSettings settings)` Constructs an instance of NodeGroupControllerClient, using the given settings.
`protected`	`NodeGroupControllerClient(NodeGroupControllerStub 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 NodeGroupControllerClient`	`create()` Constructs an instance of NodeGroupControllerClient with default settings.
`static NodeGroupControllerClient`	`create(NodeGroupControllerSettings settings)` Constructs an instance of NodeGroupControllerClient, using the given settings.
`static NodeGroupControllerClient`	`create(NodeGroupControllerStub stub)` Constructs an instance of NodeGroupControllerClient, using the given stub for making calls.
`com.google.api.gax.longrunning.OperationFuture<NodeGroup,NodeGroupOperationMetadata>`	`createNodeGroupAsync(ClusterRegionName parent, NodeGroup nodeGroup, String nodeGroupId)` Creates a node group in a cluster.
`com.google.api.gax.longrunning.OperationFuture<NodeGroup,NodeGroupOperationMetadata>`	`createNodeGroupAsync(CreateNodeGroupRequest request)` Creates a node group in a cluster.
`com.google.api.gax.longrunning.OperationFuture<NodeGroup,NodeGroupOperationMetadata>`	`createNodeGroupAsync(String parent, NodeGroup nodeGroup, String nodeGroupId)` Creates a node group in a cluster.
`com.google.api.gax.rpc.UnaryCallable<CreateNodeGroupRequest,com.google.longrunning.Operation>`	`createNodeGroupCallable()` Creates a node group in a cluster.
`com.google.api.gax.rpc.OperationCallable<CreateNodeGroupRequest,NodeGroup,NodeGroupOperationMetadata>`	`createNodeGroupOperationCallable()` Creates a node group in a cluster.
`com.google.api.gax.httpjson.longrunning.OperationsClient`	`getHttpJsonOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`com.google.iam.v1.Policy`	`getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)` Gets the access control policy for a resource.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>`	`getIamPolicyCallable()` Gets the access control policy for a resource.
`NodeGroup`	`getNodeGroup(GetNodeGroupRequest request)` Gets the resource representation for a node group in a cluster.
`NodeGroup`	`getNodeGroup(NodeGroupName name)` Gets the resource representation for a node group in a cluster.
`NodeGroup`	`getNodeGroup(String name)` Gets the resource representation for a node group in a cluster.
`com.google.api.gax.rpc.UnaryCallable<GetNodeGroupRequest,NodeGroup>`	`getNodeGroupCallable()` Gets the resource representation for a node group in a cluster.
`com.google.longrunning.OperationsClient`	`getOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`NodeGroupControllerSettings`	`getSettings()`
`NodeGroupControllerStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`com.google.api.gax.longrunning.OperationFuture<NodeGroup,NodeGroupOperationMetadata>`	`resizeNodeGroupAsync(ResizeNodeGroupRequest request)` Resizes a node group in a cluster.
`com.google.api.gax.longrunning.OperationFuture<NodeGroup,NodeGroupOperationMetadata>`	`resizeNodeGroupAsync(String name, int size)` Resizes a node group in a cluster.
`com.google.api.gax.rpc.UnaryCallable<ResizeNodeGroupRequest,com.google.longrunning.Operation>`	`resizeNodeGroupCallable()` Resizes a node group in a cluster.
`com.google.api.gax.rpc.OperationCallable<ResizeNodeGroupRequest,NodeGroup,NodeGroupOperationMetadata>`	`resizeNodeGroupOperationCallable()` Resizes a node group in a cluster.
`com.google.iam.v1.Policy`	`setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)` Sets the access control policy on the specified resource.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>`	`setIamPolicyCallable()` Sets the access control policy on the specified resource.
`void`	`shutdown()`
`void`	`shutdownNow()`
`com.google.iam.v1.TestIamPermissionsResponse`	`testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)` Returns permissions that a caller has on the specified resource.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>`	`testIamPermissionsCallable()` Returns permissions that a caller has on the specified resource.

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

Constructor Detail
- NodeGroupControllerClient
```
protected NodeGroupControllerClient(NodeGroupControllerSettings settings)
                             throws IOException
```
  Constructs an instance of NodeGroupControllerClient, 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
- NodeGroupControllerClient
```
protected NodeGroupControllerClient(NodeGroupControllerStub stub)
```

Method Detail

create

public static final NodeGroupControllerClient create()
                                              throws IOException

Constructs an instance of NodeGroupControllerClient with default settings.

Throws:: IOException

create
```
public static final NodeGroupControllerClient create(NodeGroupControllerSettings settings)
                                              throws IOException
```
Constructs an instance of NodeGroupControllerClient, 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 NodeGroupControllerClient create(NodeGroupControllerStub stub)
```
Constructs an instance of NodeGroupControllerClient, using the given stub for making calls. This is for advanced usage - prefer using create(NodeGroupControllerSettings).

getSettings

public final NodeGroupControllerSettings getSettings()

getStub

public NodeGroupControllerStub getStub()

getOperationsClient
```
public final com.google.longrunning.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 com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()
```
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

createNodeGroupAsync

public final com.google.api.gax.longrunning.OperationFuture<NodeGroup,NodeGroupOperationMetadata> createNodeGroupAsync(ClusterRegionName parent,
                                                                                                                       NodeGroup nodeGroup,
                                                                                                                       String nodeGroupId)

Creates a node group in a cluster. The returned [Operation.metadata][google.longrunning.Operation.metadata] is [NodeGroupOperationMetadata](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#nodegroupoperationmetadata).

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 (NodeGroupControllerClient nodeGroupControllerClient = NodeGroupControllerClient.create()) {
   ClusterRegionName parent = ClusterRegionName.of("[PROJECT]", "[REGION]", "[CLUSTER]");
   NodeGroup nodeGroup = NodeGroup.newBuilder().build();
   String nodeGroupId = "nodeGroupId1097129880";
   NodeGroup response =
       nodeGroupControllerClient.createNodeGroupAsync(parent, nodeGroup, nodeGroupId).get();
 }

Parameters:: parent - Required. The parent resource where this node group will be created. Format: `projects/{project}/regions/{region}/clusters/{cluster}`; nodeGroup - Required. The node group to create.; nodeGroupId - Optional. An optional node group ID. Generated if not specified.
The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of from 3 to 33 characters.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createNodeGroupAsync

public final com.google.api.gax.longrunning.OperationFuture<NodeGroup,NodeGroupOperationMetadata> createNodeGroupAsync(String parent,
                                                                                                                       NodeGroup nodeGroup,
                                                                                                                       String nodeGroupId)

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 (NodeGroupControllerClient nodeGroupControllerClient = NodeGroupControllerClient.create()) {
   String parent = ClusterRegionName.of("[PROJECT]", "[REGION]", "[CLUSTER]").toString();
   NodeGroup nodeGroup = NodeGroup.newBuilder().build();
   String nodeGroupId = "nodeGroupId1097129880";
   NodeGroup response =
       nodeGroupControllerClient.createNodeGroupAsync(parent, nodeGroup, nodeGroupId).get();
 }

Parameters:: parent - Required. The parent resource where this node group will be created. Format: `projects/{project}/regions/{region}/clusters/{cluster}`; nodeGroup - Required. The node group to create.; nodeGroupId - Optional. An optional node group ID. Generated if not specified.
The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of from 3 to 33 characters.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createNodeGroupAsync

public final com.google.api.gax.longrunning.OperationFuture<NodeGroup,NodeGroupOperationMetadata> createNodeGroupAsync(CreateNodeGroupRequest 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 (NodeGroupControllerClient nodeGroupControllerClient = NodeGroupControllerClient.create()) {
   CreateNodeGroupRequest request =
       CreateNodeGroupRequest.newBuilder()
           .setParent(ClusterRegionName.of("[PROJECT]", "[REGION]", "[CLUSTER]").toString())
           .setNodeGroup(NodeGroup.newBuilder().build())
           .setNodeGroupId("nodeGroupId1097129880")
           .setRequestId("requestId693933066")
           .build();
   NodeGroup response = nodeGroupControllerClient.createNodeGroupAsync(request).get();
 }

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

createNodeGroupOperationCallable

public final com.google.api.gax.rpc.OperationCallable<CreateNodeGroupRequest,NodeGroup,NodeGroupOperationMetadata> createNodeGroupOperationCallable()

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 (NodeGroupControllerClient nodeGroupControllerClient = NodeGroupControllerClient.create()) {
   CreateNodeGroupRequest request =
       CreateNodeGroupRequest.newBuilder()
           .setParent(ClusterRegionName.of("[PROJECT]", "[REGION]", "[CLUSTER]").toString())
           .setNodeGroup(NodeGroup.newBuilder().build())
           .setNodeGroupId("nodeGroupId1097129880")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<NodeGroup, NodeGroupOperationMetadata> future =
       nodeGroupControllerClient.createNodeGroupOperationCallable().futureCall(request);
   // Do something.
   NodeGroup response = future.get();
 }

createNodeGroupCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateNodeGroupRequest,com.google.longrunning.Operation> createNodeGroupCallable()

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 (NodeGroupControllerClient nodeGroupControllerClient = NodeGroupControllerClient.create()) {
   CreateNodeGroupRequest request =
       CreateNodeGroupRequest.newBuilder()
           .setParent(ClusterRegionName.of("[PROJECT]", "[REGION]", "[CLUSTER]").toString())
           .setNodeGroup(NodeGroup.newBuilder().build())
           .setNodeGroupId("nodeGroupId1097129880")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       nodeGroupControllerClient.createNodeGroupCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

resizeNodeGroupAsync

public final com.google.api.gax.longrunning.OperationFuture<NodeGroup,NodeGroupOperationMetadata> resizeNodeGroupAsync(String name,
                                                                                                                       int size)

Resizes a node group in a cluster. The returned [Operation.metadata][google.longrunning.Operation.metadata] is [NodeGroupOperationMetadata](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#nodegroupoperationmetadata).

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 (NodeGroupControllerClient nodeGroupControllerClient = NodeGroupControllerClient.create()) {
   String name = "name3373707";
   int size = 3530753;
   NodeGroup response = nodeGroupControllerClient.resizeNodeGroupAsync(name, size).get();
 }

Parameters:: name - Required. The name of the node group to resize. Format: `projects/{project}/regions/{region}/clusters/{cluster}/nodeGroups/{nodeGroup}`; size - Required. The number of running instances for the node group to maintain. The group adds or removes instances to maintain the number of instances specified by this parameter.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

resizeNodeGroupAsync

public final com.google.api.gax.longrunning.OperationFuture<NodeGroup,NodeGroupOperationMetadata> resizeNodeGroupAsync(ResizeNodeGroupRequest 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 (NodeGroupControllerClient nodeGroupControllerClient = NodeGroupControllerClient.create()) {
   ResizeNodeGroupRequest request =
       ResizeNodeGroupRequest.newBuilder()
           .setName("name3373707")
           .setSize(3530753)
           .setRequestId("requestId693933066")
           .setGracefulDecommissionTimeout(Duration.newBuilder().build())
           .build();
   NodeGroup response = nodeGroupControllerClient.resizeNodeGroupAsync(request).get();
 }

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

resizeNodeGroupOperationCallable

public final com.google.api.gax.rpc.OperationCallable<ResizeNodeGroupRequest,NodeGroup,NodeGroupOperationMetadata> resizeNodeGroupOperationCallable()

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 (NodeGroupControllerClient nodeGroupControllerClient = NodeGroupControllerClient.create()) {
   ResizeNodeGroupRequest request =
       ResizeNodeGroupRequest.newBuilder()
           .setName("name3373707")
           .setSize(3530753)
           .setRequestId("requestId693933066")
           .setGracefulDecommissionTimeout(Duration.newBuilder().build())
           .build();
   OperationFuture<NodeGroup, NodeGroupOperationMetadata> future =
       nodeGroupControllerClient.resizeNodeGroupOperationCallable().futureCall(request);
   // Do something.
   NodeGroup response = future.get();
 }

resizeNodeGroupCallable

public final com.google.api.gax.rpc.UnaryCallable<ResizeNodeGroupRequest,com.google.longrunning.Operation> resizeNodeGroupCallable()

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 (NodeGroupControllerClient nodeGroupControllerClient = NodeGroupControllerClient.create()) {
   ResizeNodeGroupRequest request =
       ResizeNodeGroupRequest.newBuilder()
           .setName("name3373707")
           .setSize(3530753)
           .setRequestId("requestId693933066")
           .setGracefulDecommissionTimeout(Duration.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       nodeGroupControllerClient.resizeNodeGroupCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

getNodeGroup

public final NodeGroup getNodeGroup(NodeGroupName name)

Gets the resource representation for a node group in a cluster.

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 (NodeGroupControllerClient nodeGroupControllerClient = NodeGroupControllerClient.create()) {
   NodeGroupName name = NodeGroupName.of("[PROJECT]", "[REGION]", "[CLUSTER]", "[NODE_GROUP]");
   NodeGroup response = nodeGroupControllerClient.getNodeGroup(name);
 }

Parameters:: name - Required. The name of the node group to retrieve. Format: `projects/{project}/regions/{region}/clusters/{cluster}/nodeGroups/{nodeGroup}`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getNodeGroup

public final NodeGroup getNodeGroup(String name)

Gets the resource representation for a node group in a cluster.

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 (NodeGroupControllerClient nodeGroupControllerClient = NodeGroupControllerClient.create()) {
   String name =
       NodeGroupName.of("[PROJECT]", "[REGION]", "[CLUSTER]", "[NODE_GROUP]").toString();
   NodeGroup response = nodeGroupControllerClient.getNodeGroup(name);
 }

Parameters:: name - Required. The name of the node group to retrieve. Format: `projects/{project}/regions/{region}/clusters/{cluster}/nodeGroups/{nodeGroup}`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getNodeGroup

public final NodeGroup getNodeGroup(GetNodeGroupRequest request)

Gets the resource representation for a node group in a cluster.

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 (NodeGroupControllerClient nodeGroupControllerClient = NodeGroupControllerClient.create()) {
   GetNodeGroupRequest request =
       GetNodeGroupRequest.newBuilder()
           .setName(
               NodeGroupName.of("[PROJECT]", "[REGION]", "[CLUSTER]", "[NODE_GROUP]").toString())
           .build();
   NodeGroup response = nodeGroupControllerClient.getNodeGroup(request);
 }

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

getNodeGroupCallable

public final com.google.api.gax.rpc.UnaryCallable<GetNodeGroupRequest,NodeGroup> getNodeGroupCallable()

Gets the resource representation for a node group in a cluster.

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 (NodeGroupControllerClient nodeGroupControllerClient = NodeGroupControllerClient.create()) {
   GetNodeGroupRequest request =
       GetNodeGroupRequest.newBuilder()
           .setName(
               NodeGroupName.of("[PROJECT]", "[REGION]", "[CLUSTER]", "[NODE_GROUP]").toString())
           .build();
   ApiFuture<NodeGroup> future =
       nodeGroupControllerClient.getNodeGroupCallable().futureCall(request);
   // Do something.
   NodeGroup response = future.get();
 }

setIamPolicy

public final com.google.iam.v1.Policy setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

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 (NodeGroupControllerClient nodeGroupControllerClient = NodeGroupControllerClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               AutoscalingPolicyName.ofProjectRegionAutoscalingPolicyName(
                       "[PROJECT]", "[REGION]", "[AUTOSCALING_POLICY]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = nodeGroupControllerClient.setIamPolicy(request);
 }

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

setIamPolicyCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicyCallable()

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

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 (NodeGroupControllerClient nodeGroupControllerClient = NodeGroupControllerClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               AutoscalingPolicyName.ofProjectRegionAutoscalingPolicyName(
                       "[PROJECT]", "[REGION]", "[AUTOSCALING_POLICY]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       nodeGroupControllerClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }

getIamPolicy

public final com.google.iam.v1.Policy getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

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 (NodeGroupControllerClient nodeGroupControllerClient = NodeGroupControllerClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               AutoscalingPolicyName.ofProjectRegionAutoscalingPolicyName(
                       "[PROJECT]", "[REGION]", "[AUTOSCALING_POLICY]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = nodeGroupControllerClient.getIamPolicy(request);
 }

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

getIamPolicyCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> getIamPolicyCallable()

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

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 (NodeGroupControllerClient nodeGroupControllerClient = NodeGroupControllerClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               AutoscalingPolicyName.ofProjectRegionAutoscalingPolicyName(
                       "[PROJECT]", "[REGION]", "[AUTOSCALING_POLICY]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       nodeGroupControllerClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }

testIamPermissions

public final com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error.

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

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 (NodeGroupControllerClient nodeGroupControllerClient = NodeGroupControllerClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               AutoscalingPolicyName.ofProjectRegionAutoscalingPolicyName(
                       "[PROJECT]", "[REGION]", "[AUTOSCALING_POLICY]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response = nodeGroupControllerClient.testIamPermissions(request);
 }

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

testIamPermissionsCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsCallable()

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error.

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

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 (NodeGroupControllerClient nodeGroupControllerClient = NodeGroupControllerClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               AutoscalingPolicyName.ofProjectRegionAutoscalingPolicyName(
                       "[PROJECT]", "[REGION]", "[AUTOSCALING_POLICY]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       nodeGroupControllerClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse response = future.get();
 }

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

close in interface AutoCloseable

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

shutdown in interface com.google.api.gax.core.BackgroundResource

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

isShutdown in interface com.google.api.gax.core.BackgroundResource

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

isTerminated in interface com.google.api.gax.core.BackgroundResource

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

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

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

Specified by:: awaitTermination in interface com.google.api.gax.core.BackgroundResource
Throws:: InterruptedException

Class NodeGroupControllerClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NodeGroupControllerClient

NodeGroupControllerClient

Method Detail

create

create

create

getSettings

getStub

getOperationsClient

getHttpJsonOperationsClient

createNodeGroupAsync

createNodeGroupAsync

createNodeGroupAsync

createNodeGroupOperationCallable

createNodeGroupCallable

resizeNodeGroupAsync

resizeNodeGroupAsync

resizeNodeGroupOperationCallable

resizeNodeGroupCallable

getNodeGroup

getNodeGroup

getNodeGroup

getNodeGroupCallable

setIamPolicy

setIamPolicyCallable

getIamPolicy

getIamPolicyCallable

testIamPermissions

testIamPermissionsCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination