Class NodeGroupControllerClient (4.50.0)

GitHub RepositoryProduct ReferenceREST DocumentationRPC Documentation

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 is 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 is 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_DENIEDerrors.

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.

Inheritance

java.lang.Object > NodeGroupControllerClient

Static Methods

create()

public static final NodeGroupControllerClient create()

Constructs an instance of NodeGroupControllerClient with default settings.

Returns
Type Description
NodeGroupControllerClient
Exceptions
Type Description
IOException

create(NodeGroupControllerSettings settings)

public static final NodeGroupControllerClient create(NodeGroupControllerSettings settings)

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.

Parameter
Name Description
settings NodeGroupControllerSettings
Returns
Type Description
NodeGroupControllerClient
Exceptions
Type Description
IOException

create(NodeGroupControllerStub stub)

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

Parameter
Name Description
stub NodeGroupControllerStub
Returns
Type Description
NodeGroupControllerClient

Constructors

NodeGroupControllerClient(NodeGroupControllerSettings settings)

protected NodeGroupControllerClient(NodeGroupControllerSettings settings)

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.

Parameter
Name Description
settings NodeGroupControllerSettings

NodeGroupControllerClient(NodeGroupControllerStub stub)

protected NodeGroupControllerClient(NodeGroupControllerStub stub)
Parameter
Name Description
stub NodeGroupControllerStub

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()

createNodeGroupAsync(ClusterRegionName parent, NodeGroup nodeGroup, String nodeGroupId)

public final OperationFuture<NodeGroup,NodeGroupOperationMetadata> createNodeGroupAsync(ClusterRegionName parent, NodeGroup nodeGroup, String nodeGroupId)

Creates a node group in a cluster. The returned Operation.metadata is 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
Name Description
parent ClusterRegionName

Required. The parent resource where this node group will be created. Format: projects/{project}/regions/{region}/clusters/{cluster}

nodeGroup NodeGroup

Required. The node group to create.

nodeGroupId String

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.

Returns
Type Description
OperationFuture<NodeGroup,NodeGroupOperationMetadata>

createNodeGroupAsync(CreateNodeGroupRequest request)

public final OperationFuture<NodeGroup,NodeGroupOperationMetadata> createNodeGroupAsync(CreateNodeGroupRequest request)

Creates a node group in a cluster. The returned Operation.metadata is 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()) {
   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();
 }
 
Parameter
Name Description
request CreateNodeGroupRequest

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

Returns
Type Description
OperationFuture<NodeGroup,NodeGroupOperationMetadata>

createNodeGroupAsync(String parent, NodeGroup nodeGroup, String nodeGroupId)

public final OperationFuture<NodeGroup,NodeGroupOperationMetadata> createNodeGroupAsync(String parent, NodeGroup nodeGroup, String nodeGroupId)

Creates a node group in a cluster. The returned Operation.metadata is 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 parent = ClusterRegionName.of("[PROJECT]", "[REGION]", "[CLUSTER]").toString();
   NodeGroup nodeGroup = NodeGroup.newBuilder().build();
   String nodeGroupId = "nodeGroupId1097129880";
   NodeGroup response =
       nodeGroupControllerClient.createNodeGroupAsync(parent, nodeGroup, nodeGroupId).get();
 }
 
Parameters
Name Description
parent String

Required. The parent resource where this node group will be created. Format: projects/{project}/regions/{region}/clusters/{cluster}

nodeGroup NodeGroup

Required. The node group to create.

nodeGroupId String

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.

Returns
Type Description
OperationFuture<NodeGroup,NodeGroupOperationMetadata>

createNodeGroupCallable()

public final UnaryCallable<CreateNodeGroupRequest,Operation> createNodeGroupCallable()

Creates a node group in a cluster. The returned Operation.metadata is 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()) {
   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();
 }
 
Returns
Type Description
UnaryCallable<CreateNodeGroupRequest,Operation>

createNodeGroupOperationCallable()

public final OperationCallable<CreateNodeGroupRequest,NodeGroup,NodeGroupOperationMetadata> createNodeGroupOperationCallable()

Creates a node group in a cluster. The returned Operation.metadata is 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()) {
   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();
 }
 
Returns
Type Description
OperationCallable<CreateNodeGroupRequest,NodeGroup,NodeGroupOperationMetadata>

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

getIamPolicy(GetIamPolicyRequest request)

public final Policy getIamPolicy(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);
 }
 
Parameter
Name Description
request com.google.iam.v1.GetIamPolicyRequest

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

Returns
Type Description
com.google.iam.v1.Policy

getIamPolicyCallable()

public final UnaryCallable<GetIamPolicyRequest,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();
 }
 
Returns
Type Description
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getNodeGroup(GetNodeGroupRequest request)

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);
 }
 
Parameter
Name Description
request GetNodeGroupRequest

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

Returns
Type Description
NodeGroup

getNodeGroup(NodeGroupName name)

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);
 }
 
Parameter
Name Description
name NodeGroupName

Required. The name of the node group to retrieve. Format: projects/{project}/regions/{region}/clusters/{cluster}/nodeGroups/{nodeGroup}

Returns
Type Description
NodeGroup

getNodeGroup(String name)

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);
 }
 
Parameter
Name Description
name String

Required. The name of the node group to retrieve. Format: projects/{project}/regions/{region}/clusters/{cluster}/nodeGroups/{nodeGroup}

Returns
Type Description
NodeGroup

getNodeGroupCallable()

public final 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();
 }
 
Returns
Type Description
UnaryCallable<GetNodeGroupRequest,NodeGroup>

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 NodeGroupControllerSettings getSettings()
Returns
Type Description
NodeGroupControllerSettings

getStub()

public NodeGroupControllerStub getStub()
Returns
Type Description
NodeGroupControllerStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

resizeNodeGroupAsync(ResizeNodeGroupRequest request)

public final OperationFuture<NodeGroup,NodeGroupOperationMetadata> resizeNodeGroupAsync(ResizeNodeGroupRequest request)

Resizes a node group in a cluster. The returned Operation.metadata is 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()) {
   ResizeNodeGroupRequest request =
       ResizeNodeGroupRequest.newBuilder()
           .setName("name3373707")
           .setSize(3530753)
           .setRequestId("requestId693933066")
           .setGracefulDecommissionTimeout(Duration.newBuilder().build())
           .build();
   NodeGroup response = nodeGroupControllerClient.resizeNodeGroupAsync(request).get();
 }
 
Parameter
Name Description
request ResizeNodeGroupRequest

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

Returns
Type Description
OperationFuture<NodeGroup,NodeGroupOperationMetadata>

resizeNodeGroupAsync(String name, int size)

public final OperationFuture<NodeGroup,NodeGroupOperationMetadata> resizeNodeGroupAsync(String name, int size)

Resizes a node group in a cluster. The returned Operation.metadata is 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 Description
name String

Required. The name of the node group to resize. Format: projects/{project}/regions/{region}/clusters/{cluster}/nodeGroups/{nodeGroup}

size int

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.

Returns
Type Description
OperationFuture<NodeGroup,NodeGroupOperationMetadata>

resizeNodeGroupCallable()

public final UnaryCallable<ResizeNodeGroupRequest,Operation> resizeNodeGroupCallable()

Resizes a node group in a cluster. The returned Operation.metadata is 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()) {
   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();
 }
 
Returns
Type Description
UnaryCallable<ResizeNodeGroupRequest,Operation>

resizeNodeGroupOperationCallable()

public final OperationCallable<ResizeNodeGroupRequest,NodeGroup,NodeGroupOperationMetadata> resizeNodeGroupOperationCallable()

Resizes a node group in a cluster. The returned Operation.metadata is 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()) {
   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();
 }
 
Returns
Type Description
OperationCallable<ResizeNodeGroupRequest,NodeGroup,NodeGroupOperationMetadata>

setIamPolicy(SetIamPolicyRequest request)

public final Policy setIamPolicy(SetIamPolicyRequest request)

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

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

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);
 }
 
Parameter
Name Description
request com.google.iam.v1.SetIamPolicyRequest

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

Returns
Type Description
com.google.iam.v1.Policy

setIamPolicyCallable()

public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()

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

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

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();
 }
 
Returns
Type Description
UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

testIamPermissions(TestIamPermissionsRequest request)

public final TestIamPermissionsResponse testIamPermissions(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);
 }
 
Parameter
Name Description
request com.google.iam.v1.TestIamPermissionsRequest

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

Returns
Type Description
com.google.iam.v1.TestIamPermissionsResponse

testIamPermissionsCallable()

public final UnaryCallable<TestIamPermissionsRequest,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();
 }
 
Returns
Type Description
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>