Package com.google.cloud.compute.v1

Class RegionInstanceTemplatesClient

  • All Implemented Interfaces:
    com.google.api.gax.core.BackgroundResource, AutoCloseable
    @Generated("by gapic-generator-java")
public class RegionInstanceTemplatesClient
extends Object
implements com.google.api.gax.core.BackgroundResource
    Service Description: The RegionInstanceTemplates 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 (RegionInstanceTemplatesClient regionInstanceTemplatesClient =
     RegionInstanceTemplatesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String instanceTemplate = "instanceTemplate1009541167";
   InstanceTemplate response =
       regionInstanceTemplatesClient.get(project, region, instanceTemplate);
 }

    Note: close() needs to be called on the RegionInstanceTemplatesClient 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 RegionInstanceTemplatesSettings 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
 RegionInstanceTemplatesSettings regionInstanceTemplatesSettings =
     RegionInstanceTemplatesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RegionInstanceTemplatesClient regionInstanceTemplatesClient =
     RegionInstanceTemplatesClient.create(regionInstanceTemplatesSettings);

    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
 RegionInstanceTemplatesSettings regionInstanceTemplatesSettings =
     RegionInstanceTemplatesSettings.newBuilder().setEndpoint(myEndpoint).build();
 RegionInstanceTemplatesClient regionInstanceTemplatesClient =
     RegionInstanceTemplatesClient.create(regionInstanceTemplatesSettings);

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

    • Constructor Detail

      • RegionInstanceTemplatesClient

        protected RegionInstanceTemplatesClient​(RegionInstanceTemplatesSettings settings)
                                 throws IOException
        Constructs an instance of RegionInstanceTemplatesClient, 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 RegionInstanceTemplatesClient create​(RegionInstanceTemplatesStub stub)
        Constructs an instance of RegionInstanceTemplatesClient, using the given stub for making calls. This is for advanced usage - prefer using create(RegionInstanceTemplatesSettings).

      • deleteAsync

        public final com.google.api.gax.longrunning.OperationFuture<Operation,​Operation> deleteAsync​(String project,
                                                                                                   String region,
                                                                                                   String instanceTemplate)
        Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone.

        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 (RegionInstanceTemplatesClient regionInstanceTemplatesClient =
     RegionInstanceTemplatesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String instanceTemplate = "instanceTemplate1009541167";
   Operation response =
       regionInstanceTemplatesClient.deleteAsync(project, region, instanceTemplate).get();
 }
        Parameters:
        project - Project ID for this request.
        region - The name of the region for this request.
        instanceTemplate - The name of the instance template 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​(DeleteRegionInstanceTemplateRequest request)
        Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone.

        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 (RegionInstanceTemplatesClient regionInstanceTemplatesClient =
     RegionInstanceTemplatesClient.create()) {
   DeleteRegionInstanceTemplateRequest request =
       DeleteRegionInstanceTemplateRequest.newBuilder()
           .setInstanceTemplate("instanceTemplate1009541167")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   Operation response = regionInstanceTemplatesClient.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<DeleteRegionInstanceTemplateRequest,​Operation,​Operation> deleteOperationCallable()
        Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone.

        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 (RegionInstanceTemplatesClient regionInstanceTemplatesClient =
     RegionInstanceTemplatesClient.create()) {
   DeleteRegionInstanceTemplateRequest request =
       DeleteRegionInstanceTemplateRequest.newBuilder()
           .setInstanceTemplate("instanceTemplate1009541167")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       regionInstanceTemplatesClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

      • deleteCallable

        public final com.google.api.gax.rpc.UnaryCallable<DeleteRegionInstanceTemplateRequest,​Operation> deleteCallable()
        Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone.

        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 (RegionInstanceTemplatesClient regionInstanceTemplatesClient =
     RegionInstanceTemplatesClient.create()) {
   DeleteRegionInstanceTemplateRequest request =
       DeleteRegionInstanceTemplateRequest.newBuilder()
           .setInstanceTemplate("instanceTemplate1009541167")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       regionInstanceTemplatesClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

      • get

        public final InstanceTemplate get​(String project,
                                  String region,
                                  String instanceTemplate)
        Returns the specified instance 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 (RegionInstanceTemplatesClient regionInstanceTemplatesClient =
     RegionInstanceTemplatesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String instanceTemplate = "instanceTemplate1009541167";
   InstanceTemplate response =
       regionInstanceTemplatesClient.get(project, region, instanceTemplate);
 }
        Parameters:
        project - Project ID for this request.
        region - The name of the region for this request.
        instanceTemplate - The name of the instance template.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • get

        public final InstanceTemplate get​(GetRegionInstanceTemplateRequest request)
        Returns the specified instance 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 (RegionInstanceTemplatesClient regionInstanceTemplatesClient =
     RegionInstanceTemplatesClient.create()) {
   GetRegionInstanceTemplateRequest request =
       GetRegionInstanceTemplateRequest.newBuilder()
           .setInstanceTemplate("instanceTemplate1009541167")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .build();
   InstanceTemplate response = regionInstanceTemplatesClient.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<GetRegionInstanceTemplateRequest,​InstanceTemplate> getCallable()
        Returns the specified instance 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 (RegionInstanceTemplatesClient regionInstanceTemplatesClient =
     RegionInstanceTemplatesClient.create()) {
   GetRegionInstanceTemplateRequest request =
       GetRegionInstanceTemplateRequest.newBuilder()
           .setInstanceTemplate("instanceTemplate1009541167")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .build();
   ApiFuture<InstanceTemplate> future =
       regionInstanceTemplatesClient.getCallable().futureCall(request);
   // Do something.
   InstanceTemplate response = future.get();
 }

      • insertAsync

        public final com.google.api.gax.longrunning.OperationFuture<Operation,​Operation> insertAsync​(String project,
                                                                                                   String region,
                                                                                                   InstanceTemplate instanceTemplateResource)
        Creates an instance template in the specified project and region using the global instance template whose URL is 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 (RegionInstanceTemplatesClient regionInstanceTemplatesClient =
     RegionInstanceTemplatesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   InstanceTemplate instanceTemplateResource = InstanceTemplate.newBuilder().build();
   Operation response =
       regionInstanceTemplatesClient
           .insertAsync(project, region, instanceTemplateResource)
           .get();
 }
        Parameters:
        project - Project ID for this request.
        region - The name of the region for this request.
        instanceTemplateResource - 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​(InsertRegionInstanceTemplateRequest request)
        Creates an instance template in the specified project and region using the global instance template whose URL is 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 (RegionInstanceTemplatesClient regionInstanceTemplatesClient =
     RegionInstanceTemplatesClient.create()) {
   InsertRegionInstanceTemplateRequest request =
       InsertRegionInstanceTemplateRequest.newBuilder()
           .setInstanceTemplateResource(InstanceTemplate.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   Operation response = regionInstanceTemplatesClient.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<InsertRegionInstanceTemplateRequest,​Operation,​Operation> insertOperationCallable()
        Creates an instance template in the specified project and region using the global instance template whose URL is 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 (RegionInstanceTemplatesClient regionInstanceTemplatesClient =
     RegionInstanceTemplatesClient.create()) {
   InsertRegionInstanceTemplateRequest request =
       InsertRegionInstanceTemplateRequest.newBuilder()
           .setInstanceTemplateResource(InstanceTemplate.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       regionInstanceTemplatesClient.insertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

      • insertCallable

        public final com.google.api.gax.rpc.UnaryCallable<InsertRegionInstanceTemplateRequest,​Operation> insertCallable()
        Creates an instance template in the specified project and region using the global instance template whose URL is 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 (RegionInstanceTemplatesClient regionInstanceTemplatesClient =
     RegionInstanceTemplatesClient.create()) {
   InsertRegionInstanceTemplateRequest request =
       InsertRegionInstanceTemplateRequest.newBuilder()
           .setInstanceTemplateResource(InstanceTemplate.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       regionInstanceTemplatesClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

      • list

        public final RegionInstanceTemplatesClient.ListPagedResponse list​(String project,
                                                                  String region)
        Retrieves a list of instance templates that are contained within the specified project and region.

        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 (RegionInstanceTemplatesClient regionInstanceTemplatesClient =
     RegionInstanceTemplatesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   for (InstanceTemplate element :
       regionInstanceTemplatesClient.list(project, region).iterateAll()) {
     // doThingsWith(element);
   }
 }
        Parameters:
        project - Project ID for this request.
        region - The name of the regions for this request.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • list

        public final RegionInstanceTemplatesClient.ListPagedResponse list​(ListRegionInstanceTemplatesRequest request)
        Retrieves a list of instance templates that are contained within the specified project and region.

        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 (RegionInstanceTemplatesClient regionInstanceTemplatesClient =
     RegionInstanceTemplatesClient.create()) {
   ListRegionInstanceTemplatesRequest request =
       ListRegionInstanceTemplatesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   for (InstanceTemplate element : regionInstanceTemplatesClient.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<ListRegionInstanceTemplatesRequest,​RegionInstanceTemplatesClient.ListPagedResponse> listPagedCallable()
        Retrieves a list of instance templates that are contained within the specified project and region.

        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 (RegionInstanceTemplatesClient regionInstanceTemplatesClient =
     RegionInstanceTemplatesClient.create()) {
   ListRegionInstanceTemplatesRequest request =
       ListRegionInstanceTemplatesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<InstanceTemplate> future =
       regionInstanceTemplatesClient.listPagedCallable().futureCall(request);
   // Do something.
   for (InstanceTemplate element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

      • listCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListRegionInstanceTemplatesRequest,​InstanceTemplateList> listCallable()
        Retrieves a list of instance templates that are contained within the specified project and region.

        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 (RegionInstanceTemplatesClient regionInstanceTemplatesClient =
     RegionInstanceTemplatesClient.create()) {
   ListRegionInstanceTemplatesRequest request =
       ListRegionInstanceTemplatesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     InstanceTemplateList response = regionInstanceTemplatesClient.listCallable().call(request);
     for (InstanceTemplate element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

      • 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