Class NodeTemplatesClient

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

    @Generated("by gapic-generator-java")
    public class NodeTemplatesClient
    extends Object
    implements com.google.api.gax.core.BackgroundResource
    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().

    The surface of this class includes several types of Java methods for each of the API's methods:

    1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
    2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
    3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

    See the individual methods for example code.

    Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

    This class can be customized by passing in a custom instance of 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.

    • Constructor Detail

      • NodeTemplatesClient

        protected NodeTemplatesClient​(NodeTemplatesSettings settings)
                               throws IOException
        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.
        Throws:
        IOException
    • Method Detail

      • create

        public static final NodeTemplatesClient create​(NodeTemplatesSettings settings)
                                                throws IOException
        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.
        Throws:
        IOException
      • create

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

        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);
           }
         }
         
        Parameters:
        project - Project ID for this request.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • aggregatedList

        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)
                   .build();
           for (Map.Entry<String, NodeTemplatesScopedList> element :
               nodeTemplatesClient.aggregatedList(request).iterateAll()) {
             // doThingsWith(element);
           }
         }
         
        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
      • aggregatedListPagedCallable

        public final com.google.api.gax.rpc.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)
                   .build();
           ApiFuture<Map.Entry<String, NodeTemplatesScopedList>> future =
               nodeTemplatesClient.aggregatedListPagedCallable().futureCall(request);
           // Do something.
           for (Map.Entry<String, NodeTemplatesScopedList> element : future.get().iterateAll()) {
             // doThingsWith(element);
           }
         }
         
      • aggregatedListCallable

        public final com.google.api.gax.rpc.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)
                   .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;
             }
           }
         }
         
      • deleteAsync

        public final com.google.api.gax.longrunning.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:
        project - Project ID for this request.
        region - The name of the region for this request.
        nodeTemplate - Name of the NodeTemplate resource to delete.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • deleteAsync

        @BetaApi("The surface for long-running operations is not stable yet and may change in the future.")
        public final com.google.api.gax.longrunning.OperationFuture<Operation,​Operation> deleteAsync​(DeleteNodeTemplateRequest request)
        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();
         }
         
        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
      • deleteOperationCallable

        public final com.google.api.gax.rpc.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();
         }
         
      • deleteCallable

        public final com.google.api.gax.rpc.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();
         }
         
      • get

        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:
        project - Project ID for this request.
        region - The name of the region for this request.
        nodeTemplate - Name of the node template to return.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • get

        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);
         }
         
        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
      • getCallable

        public final com.google.api.gax.rpc.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();
         }
         
      • getIamPolicy

        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:
        project - Project ID for this request.
        region - The name of the region for this request.
        resource - Name or id of the resource for this request.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • getIamPolicy

        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);
         }
         
        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<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();
         }
         
      • insertAsync

        public final com.google.api.gax.longrunning.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:
        project - Project ID for this request.
        region - The name of the region for this request.
        nodeTemplateResource - The body resource for this request
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • insertAsync

        @BetaApi("The surface for long-running operations is not stable yet and may change in the future.")
        public final com.google.api.gax.longrunning.OperationFuture<Operation,​Operation> insertAsync​(InsertNodeTemplateRequest request)
        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();
         }
         
        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
      • insertOperationCallable

        public final com.google.api.gax.rpc.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();
         }
         
      • insertCallable

        public final com.google.api.gax.rpc.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();
         }
         
      • list

        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:
        project - Project ID for this request.
        region - The name of the region for this request.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • list

        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);
           }
         }
         
        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
      • listPagedCallable

        public final com.google.api.gax.rpc.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);
           }
         }
         
      • listCallable

        public final com.google.api.gax.rpc.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;
             }
           }
         }
         
      • setIamPolicy

        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:
        project - Project ID for this request.
        region - The name of the region for this request.
        resource - Name or id of the resource for this request.
        regionSetPolicyRequestResource - The body resource for this request
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • setIamPolicy

        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);
         }
         
        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<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();
         }
         
      • testIamPermissions

        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:
        project - Project ID for this request.
        region - The name of the region for this request.
        resource - Name or id of the resource for this request.
        testPermissionsRequestResource - The body resource for this request
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails
      • testIamPermissions

        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);
         }
         
        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<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();
         }
         
      • 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