Class NodeTemplatesClient (1.43.0)

Version 1.43.0

• 1.62.0 (latest)
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

GitHub Repository

Product Reference

Service Description: The NodeTemplates API.

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 (NodeTemplatesClient nodeTemplatesClient = NodeTemplatesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String nodeTemplate = "nodeTemplate2118368412";
   NodeTemplate response = nodeTemplatesClient.get(project, region, nodeTemplate);
 }
 

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

Method	Description	Method Variants
AggregatedList	Retrieves an aggregated list of node templates.	Request object method variants only take one parameter, a request object, which must be constructed before the call. aggregatedList(AggregatedListNodeTemplatesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. aggregatedList(String project) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. aggregatedListPagedCallable() aggregatedListCallable()
Delete	Deletes the specified NodeTemplate resource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteAsync(DeleteNodeTemplateRequest request) Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service. deleteAsync(String project, String region, String nodeTemplate) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteOperationCallable() deleteCallable()
Get	Returns the specified node template.	Request object method variants only take one parameter, a request object, which must be constructed before the call. get(GetNodeTemplateRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. get(String project, String region, String nodeTemplate) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getCallable()
GetIamPolicy	Gets the access control policy for a resource. May be empty if no such policy or resource exists.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getIamPolicy(GetIamPolicyNodeTemplateRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getIamPolicy(String project, String region, String resource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getIamPolicyCallable()
Insert	Creates a NodeTemplate resource in the specified project using the data included in the request.	Request object method variants only take one parameter, a request object, which must be constructed before the call. insertAsync(InsertNodeTemplateRequest request) Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service. insertAsync(String project, String region, NodeTemplate nodeTemplateResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. insertOperationCallable() insertCallable()
List	Retrieves a list of node templates available to the specified project.	Request object method variants only take one parameter, a request object, which must be constructed before the call. list(ListNodeTemplatesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. list(String project, String region) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listPagedCallable() listCallable()
SetIamPolicy	Sets the access control policy on the specified resource. Replaces any existing policy.	Request object method variants only take one parameter, a request object, which must be constructed before the call. setIamPolicy(SetIamPolicyNodeTemplateRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. setIamPolicy(String project, String region, String resource, RegionSetPolicyRequest regionSetPolicyRequestResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. setIamPolicyCallable()
TestIamPermissions	Returns permissions that a caller has on the specified resource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. testIamPermissions(TestIamPermissionsNodeTemplateRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. testIamPermissions(String project, String region, String resource, TestPermissionsRequest testPermissionsRequestResource) 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 NodeTemplatesSettings 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
 NodeTemplatesSettings nodeTemplatesSettings =
     NodeTemplatesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 NodeTemplatesClient nodeTemplatesClient = NodeTemplatesClient.create(nodeTemplatesSettings);
 

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
 NodeTemplatesSettings nodeTemplatesSettings =
     NodeTemplatesSettings.newBuilder().setEndpoint(myEndpoint).build();
 NodeTemplatesClient nodeTemplatesClient = NodeTemplatesClient.create(nodeTemplatesSettings);
 

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

Inheritance

java.lang.Object > NodeTemplatesClient

Static Methods

create()

public static final NodeTemplatesClient create()

Constructs an instance of NodeTemplatesClient with default settings.

Returns
Type	Description
NodeTemplatesClient

Exceptions
Type	Description
IOException

create(NodeTemplatesSettings settings)

public static final NodeTemplatesClient create(NodeTemplatesSettings settings)

Constructs an instance of NodeTemplatesClient, 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	NodeTemplatesSettings

Returns
Type	Description
NodeTemplatesClient

Exceptions
Type	Description
IOException

create(NodeTemplatesStub stub)

public static final NodeTemplatesClient create(NodeTemplatesStub stub)

Constructs an instance of NodeTemplatesClient, using the given stub for making calls. This is for advanced usage - prefer using create(NodeTemplatesSettings).

Parameter
Name	Description
stub	NodeTemplatesStub

Returns
Type	Description
NodeTemplatesClient

Constructors

NodeTemplatesClient(NodeTemplatesSettings settings)

protected NodeTemplatesClient(NodeTemplatesSettings settings)

Constructs an instance of NodeTemplatesClient, 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	NodeTemplatesSettings

NodeTemplatesClient(NodeTemplatesStub stub)

protected NodeTemplatesClient(NodeTemplatesStub stub)

Parameter
Name	Description
stub	NodeTemplatesStub

Methods

aggregatedList(AggregatedListNodeTemplatesRequest request)

public final NodeTemplatesClient.AggregatedListPagedResponse aggregatedList(AggregatedListNodeTemplatesRequest request)

Retrieves an aggregated list of node templates.

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 (NodeTemplatesClient nodeTemplatesClient = NodeTemplatesClient.create()) {
   AggregatedListNodeTemplatesRequest request =
       AggregatedListNodeTemplatesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setServiceProjectNumber(-1293855239)
           .build();
   for (Map.Entry<String, NodeTemplatesScopedList> element :
       nodeTemplatesClient.aggregatedList(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
request	AggregatedListNodeTemplatesRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
NodeTemplatesClient.AggregatedListPagedResponse

aggregatedList(String project)

public final NodeTemplatesClient.AggregatedListPagedResponse aggregatedList(String project)

Retrieves an aggregated list of node templates.

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 (NodeTemplatesClient nodeTemplatesClient = NodeTemplatesClient.create()) {
   String project = "project-309310695";
   for (Map.Entry<String, NodeTemplatesScopedList> element :
       nodeTemplatesClient.aggregatedList(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
project	String Project ID for this request.

Returns
Type	Description
NodeTemplatesClient.AggregatedListPagedResponse

aggregatedListCallable()

public final UnaryCallable<AggregatedListNodeTemplatesRequest,NodeTemplateAggregatedList> aggregatedListCallable()

Retrieves an aggregated list of node templates.

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 (NodeTemplatesClient nodeTemplatesClient = NodeTemplatesClient.create()) {
   AggregatedListNodeTemplatesRequest request =
       AggregatedListNodeTemplatesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setServiceProjectNumber(-1293855239)
           .build();
   while (true) {
     NodeTemplateAggregatedList response =
         nodeTemplatesClient.aggregatedListCallable().call(request);
     for (Map.Entry<String, NodeTemplatesScopedList> element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns
Type	Description
UnaryCallable<AggregatedListNodeTemplatesRequest,NodeTemplateAggregatedList>

aggregatedListPagedCallable()

public final UnaryCallable<AggregatedListNodeTemplatesRequest,NodeTemplatesClient.AggregatedListPagedResponse> aggregatedListPagedCallable()

Retrieves an aggregated list of node templates.

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 (NodeTemplatesClient nodeTemplatesClient = NodeTemplatesClient.create()) {
   AggregatedListNodeTemplatesRequest request =
       AggregatedListNodeTemplatesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setServiceProjectNumber(-1293855239)
           .build();
   ApiFuture<Map.Entry<String, NodeTemplatesScopedList>> future =
       nodeTemplatesClient.aggregatedListPagedCallable().futureCall(request);
   // Do something.
   for (Map.Entry<String, NodeTemplatesScopedList> element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns
Type	Description
UnaryCallable<AggregatedListNodeTemplatesRequest,AggregatedListPagedResponse>

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

deleteAsync(DeleteNodeTemplateRequest request)

public final OperationFuture<Operation,Operation> deleteAsync(DeleteNodeTemplateRequest request)

Beta

The surface for long-running operations is not stable yet and may change in the future.

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Deletes the specified NodeTemplate resource.

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 (NodeTemplatesClient nodeTemplatesClient = NodeTemplatesClient.create()) {
   DeleteNodeTemplateRequest request =
       DeleteNodeTemplateRequest.newBuilder()
           .setNodeTemplate("nodeTemplate2118368412")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   Operation response = nodeTemplatesClient.deleteAsync(request).get();
 }
 

Parameter
Name	Description
request	DeleteNodeTemplateRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
OperationFuture<Operation,Operation>

deleteAsync(String project, String region, String nodeTemplate)

public final OperationFuture<Operation,Operation> deleteAsync(String project, String region, String nodeTemplate)

Deletes the specified NodeTemplate resource.

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 (NodeTemplatesClient nodeTemplatesClient = NodeTemplatesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String nodeTemplate = "nodeTemplate2118368412";
   Operation response = nodeTemplatesClient.deleteAsync(project, region, nodeTemplate).get();
 }
 

Parameters
Name	Description
project	String Project ID for this request.
region	String The name of the region for this request.
nodeTemplate	String Name of the NodeTemplate resource to delete.

Returns
Type	Description
OperationFuture<Operation,Operation>

deleteCallable()

public final UnaryCallable<DeleteNodeTemplateRequest,Operation> deleteCallable()

Deletes the specified NodeTemplate resource.

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 (NodeTemplatesClient nodeTemplatesClient = NodeTemplatesClient.create()) {
   DeleteNodeTemplateRequest request =
       DeleteNodeTemplateRequest.newBuilder()
           .setNodeTemplate("nodeTemplate2118368412")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = nodeTemplatesClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<DeleteNodeTemplateRequest,Operation>

deleteOperationCallable()

public final OperationCallable<DeleteNodeTemplateRequest,Operation,Operation> deleteOperationCallable()

Deletes the specified NodeTemplate resource.

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 (NodeTemplatesClient nodeTemplatesClient = NodeTemplatesClient.create()) {
   DeleteNodeTemplateRequest request =
       DeleteNodeTemplateRequest.newBuilder()
           .setNodeTemplate("nodeTemplate2118368412")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       nodeTemplatesClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
OperationCallable<DeleteNodeTemplateRequest,Operation,Operation>

get(GetNodeTemplateRequest request)

public final NodeTemplate get(GetNodeTemplateRequest request)

Returns the specified node template.

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 (NodeTemplatesClient nodeTemplatesClient = NodeTemplatesClient.create()) {
   GetNodeTemplateRequest request =
       GetNodeTemplateRequest.newBuilder()
           .setNodeTemplate("nodeTemplate2118368412")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .build();
   NodeTemplate response = nodeTemplatesClient.get(request);
 }
 

Parameter
Name	Description
request	GetNodeTemplateRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
NodeTemplate

get(String project, String region, String nodeTemplate)

public final NodeTemplate get(String project, String region, String nodeTemplate)

Returns the specified node template.

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 (NodeTemplatesClient nodeTemplatesClient = NodeTemplatesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String nodeTemplate = "nodeTemplate2118368412";
   NodeTemplate response = nodeTemplatesClient.get(project, region, nodeTemplate);
 }
 

Parameters
Name	Description
project	String Project ID for this request.
region	String The name of the region for this request.
nodeTemplate	String Name of the node template to return.

Returns
Type	Description
NodeTemplate

getCallable()

public final UnaryCallable<GetNodeTemplateRequest,NodeTemplate> getCallable()

Returns the specified node template.

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 (NodeTemplatesClient nodeTemplatesClient = NodeTemplatesClient.create()) {
   GetNodeTemplateRequest request =
       GetNodeTemplateRequest.newBuilder()
           .setNodeTemplate("nodeTemplate2118368412")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .build();
   ApiFuture<NodeTemplate> future = nodeTemplatesClient.getCallable().futureCall(request);
   // Do something.
   NodeTemplate response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<GetNodeTemplateRequest,NodeTemplate>

getIamPolicy(GetIamPolicyNodeTemplateRequest request)

public final Policy getIamPolicy(GetIamPolicyNodeTemplateRequest request)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

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 (NodeTemplatesClient nodeTemplatesClient = NodeTemplatesClient.create()) {
   GetIamPolicyNodeTemplateRequest request =
       GetIamPolicyNodeTemplateRequest.newBuilder()
           .setOptionsRequestedPolicyVersion(-574521795)
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setResource("resource-341064690")
           .build();
   Policy response = nodeTemplatesClient.getIamPolicy(request);
 }
 

Parameter
Name	Description
request	GetIamPolicyNodeTemplateRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
Policy

getIamPolicy(String project, String region, String resource)

public final Policy getIamPolicy(String project, String region, String resource)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

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 (NodeTemplatesClient nodeTemplatesClient = NodeTemplatesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String resource = "resource-341064690";
   Policy response = nodeTemplatesClient.getIamPolicy(project, region, resource);
 }
 

Parameters
Name	Description
project	String Project ID for this request.
region	String The name of the region for this request.
resource	String Name or id of the resource for this request.

Returns
Type	Description
Policy

getIamPolicyCallable()

public final UnaryCallable<GetIamPolicyNodeTemplateRequest,Policy> getIamPolicyCallable()

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

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 (NodeTemplatesClient nodeTemplatesClient = NodeTemplatesClient.create()) {
   GetIamPolicyNodeTemplateRequest request =
       GetIamPolicyNodeTemplateRequest.newBuilder()
           .setOptionsRequestedPolicyVersion(-574521795)
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setResource("resource-341064690")
           .build();
   ApiFuture<Policy> future = nodeTemplatesClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<GetIamPolicyNodeTemplateRequest,Policy>

getSettings()

public final NodeTemplatesSettings getSettings()

Returns
Type	Description
NodeTemplatesSettings

getStub()

public NodeTemplatesStub getStub()

Returns
Type	Description
NodeTemplatesStub

insertAsync(InsertNodeTemplateRequest request)

public final OperationFuture<Operation,Operation> insertAsync(InsertNodeTemplateRequest request)

Beta

The surface for long-running operations is not stable yet and may change in the future.

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Creates a NodeTemplate resource in the specified project using the data included in the 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 (NodeTemplatesClient nodeTemplatesClient = NodeTemplatesClient.create()) {
   InsertNodeTemplateRequest request =
       InsertNodeTemplateRequest.newBuilder()
           .setNodeTemplateResource(NodeTemplate.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   Operation response = nodeTemplatesClient.insertAsync(request).get();
 }
 

Parameter
Name	Description
request	InsertNodeTemplateRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
OperationFuture<Operation,Operation>

insertAsync(String project, String region, NodeTemplate nodeTemplateResource)

public final OperationFuture<Operation,Operation> insertAsync(String project, String region, NodeTemplate nodeTemplateResource)

Creates a NodeTemplate resource in the specified project using the data included in the 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 (NodeTemplatesClient nodeTemplatesClient = NodeTemplatesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   NodeTemplate nodeTemplateResource = NodeTemplate.newBuilder().build();
   Operation response =
       nodeTemplatesClient.insertAsync(project, region, nodeTemplateResource).get();
 }
 

Parameters
Name	Description
project	String Project ID for this request.
region	String The name of the region for this request.
nodeTemplateResource	NodeTemplate The body resource for this request

Returns
Type	Description
OperationFuture<Operation,Operation>

insertCallable()

public final UnaryCallable<InsertNodeTemplateRequest,Operation> insertCallable()

Creates a NodeTemplate resource in the specified project using the data included in the 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 (NodeTemplatesClient nodeTemplatesClient = NodeTemplatesClient.create()) {
   InsertNodeTemplateRequest request =
       InsertNodeTemplateRequest.newBuilder()
           .setNodeTemplateResource(NodeTemplate.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = nodeTemplatesClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<InsertNodeTemplateRequest,Operation>

insertOperationCallable()

public final OperationCallable<InsertNodeTemplateRequest,Operation,Operation> insertOperationCallable()

Creates a NodeTemplate resource in the specified project using the data included in the 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 (NodeTemplatesClient nodeTemplatesClient = NodeTemplatesClient.create()) {
   InsertNodeTemplateRequest request =
       InsertNodeTemplateRequest.newBuilder()
           .setNodeTemplateResource(NodeTemplate.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       nodeTemplatesClient.insertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
OperationCallable<InsertNodeTemplateRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

list(ListNodeTemplatesRequest request)

public final NodeTemplatesClient.ListPagedResponse list(ListNodeTemplatesRequest request)

Retrieves a list of node templates available to the specified 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 (NodeTemplatesClient nodeTemplatesClient = NodeTemplatesClient.create()) {
   ListNodeTemplatesRequest request =
       ListNodeTemplatesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   for (NodeTemplate element : nodeTemplatesClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
request	ListNodeTemplatesRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
NodeTemplatesClient.ListPagedResponse

list(String project, String region)

public final NodeTemplatesClient.ListPagedResponse list(String project, String region)

Retrieves a list of node templates available to the specified 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 (NodeTemplatesClient nodeTemplatesClient = NodeTemplatesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   for (NodeTemplate element : nodeTemplatesClient.list(project, region).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters
Name	Description
project	String Project ID for this request.
region	String The name of the region for this request.

Returns
Type	Description
NodeTemplatesClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListNodeTemplatesRequest,NodeTemplateList> listCallable()

Retrieves a list of node templates available to the specified 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 (NodeTemplatesClient nodeTemplatesClient = NodeTemplatesClient.create()) {
   ListNodeTemplatesRequest request =
       ListNodeTemplatesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     NodeTemplateList response = nodeTemplatesClient.listCallable().call(request);
     for (NodeTemplate element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns
Type	Description
UnaryCallable<ListNodeTemplatesRequest,NodeTemplateList>

listPagedCallable()

public final UnaryCallable<ListNodeTemplatesRequest,NodeTemplatesClient.ListPagedResponse> listPagedCallable()

Retrieves a list of node templates available to the specified 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 (NodeTemplatesClient nodeTemplatesClient = NodeTemplatesClient.create()) {
   ListNodeTemplatesRequest request =
       ListNodeTemplatesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<NodeTemplate> future = nodeTemplatesClient.listPagedCallable().futureCall(request);
   // Do something.
   for (NodeTemplate element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns
Type	Description
UnaryCallable<ListNodeTemplatesRequest,ListPagedResponse>

setIamPolicy(SetIamPolicyNodeTemplateRequest request)

public final Policy setIamPolicy(SetIamPolicyNodeTemplateRequest request)

Sets the access control policy on the specified resource. Replaces any existing policy.

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 (NodeTemplatesClient nodeTemplatesClient = NodeTemplatesClient.create()) {
   SetIamPolicyNodeTemplateRequest request =
       SetIamPolicyNodeTemplateRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionSetPolicyRequestResource(RegionSetPolicyRequest.newBuilder().build())
           .setResource("resource-341064690")
           .build();
   Policy response = nodeTemplatesClient.setIamPolicy(request);
 }
 

Parameter
Name	Description
request	SetIamPolicyNodeTemplateRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
Policy

setIamPolicy(String project, String region, String resource, RegionSetPolicyRequest regionSetPolicyRequestResource)

public final Policy setIamPolicy(String project, String region, String resource, RegionSetPolicyRequest regionSetPolicyRequestResource)

Sets the access control policy on the specified resource. Replaces any existing policy.

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 (NodeTemplatesClient nodeTemplatesClient = NodeTemplatesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String resource = "resource-341064690";
   RegionSetPolicyRequest regionSetPolicyRequestResource =
       RegionSetPolicyRequest.newBuilder().build();
   Policy response =
       nodeTemplatesClient.setIamPolicy(
           project, region, resource, regionSetPolicyRequestResource);
 }
 

Parameters
Name	Description
project	String Project ID for this request.
region	String The name of the region for this request.
resource	String Name or id of the resource for this request.
regionSetPolicyRequestResource	RegionSetPolicyRequest The body resource for this request

Returns
Type	Description
Policy

setIamPolicyCallable()

public final UnaryCallable<SetIamPolicyNodeTemplateRequest,Policy> setIamPolicyCallable()

Sets the access control policy on the specified resource. Replaces any existing policy.

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 (NodeTemplatesClient nodeTemplatesClient = NodeTemplatesClient.create()) {
   SetIamPolicyNodeTemplateRequest request =
       SetIamPolicyNodeTemplateRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionSetPolicyRequestResource(RegionSetPolicyRequest.newBuilder().build())
           .setResource("resource-341064690")
           .build();
   ApiFuture<Policy> future = nodeTemplatesClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<SetIamPolicyNodeTemplateRequest,Policy>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

testIamPermissions(TestIamPermissionsNodeTemplateRequest request)

public final TestPermissionsResponse testIamPermissions(TestIamPermissionsNodeTemplateRequest request)

Returns permissions that a caller has on the specified resource.

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 (NodeTemplatesClient nodeTemplatesClient = NodeTemplatesClient.create()) {
   TestIamPermissionsNodeTemplateRequest request =
       TestIamPermissionsNodeTemplateRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setResource("resource-341064690")
           .setTestPermissionsRequestResource(TestPermissionsRequest.newBuilder().build())
           .build();
   TestPermissionsResponse response = nodeTemplatesClient.testIamPermissions(request);
 }
 

Parameter
Name	Description
request	TestIamPermissionsNodeTemplateRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
TestPermissionsResponse

testIamPermissions(String project, String region, String resource, TestPermissionsRequest testPermissionsRequestResource)

public final TestPermissionsResponse testIamPermissions(String project, String region, String resource, TestPermissionsRequest testPermissionsRequestResource)

Returns permissions that a caller has on the specified resource.

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 (NodeTemplatesClient nodeTemplatesClient = NodeTemplatesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String resource = "resource-341064690";
   TestPermissionsRequest testPermissionsRequestResource =
       TestPermissionsRequest.newBuilder().build();
   TestPermissionsResponse response =
       nodeTemplatesClient.testIamPermissions(
           project, region, resource, testPermissionsRequestResource);
 }
 

Parameters
Name	Description
project	String Project ID for this request.
region	String The name of the region for this request.
resource	String Name or id of the resource for this request.
testPermissionsRequestResource	TestPermissionsRequest The body resource for this request

Returns
Type	Description
TestPermissionsResponse

testIamPermissionsCallable()

public final UnaryCallable<TestIamPermissionsNodeTemplateRequest,TestPermissionsResponse> testIamPermissionsCallable()

Returns permissions that a caller has on the specified resource.

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 (NodeTemplatesClient nodeTemplatesClient = NodeTemplatesClient.create()) {
   TestIamPermissionsNodeTemplateRequest request =
       TestIamPermissionsNodeTemplateRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setResource("resource-341064690")
           .setTestPermissionsRequestResource(TestPermissionsRequest.newBuilder().build())
           .build();
   ApiFuture<TestPermissionsResponse> future =
       nodeTemplatesClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestPermissionsResponse response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<TestIamPermissionsNodeTemplateRequest,TestPermissionsResponse>