Class RegionInstanceTemplatesClient (1.49.0)

GitHub Repository

Product Reference

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

Methods

Method	Description	Method Variants
Delete	Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteAsync(DeleteRegionInstanceTemplateRequest 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 instanceTemplate) 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 instance template.	Request object method variants only take one parameter, a request object, which must be constructed before the call. get(GetRegionInstanceTemplateRequest 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 instanceTemplate) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getCallable()
Insert	Creates an instance template in the specified project and region using the global instance template whose URL is included in the request.	Request object method variants only take one parameter, a request object, which must be constructed before the call. insertAsync(InsertRegionInstanceTemplateRequest 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, InstanceTemplate instanceTemplateResource) 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 instance templates that are contained within the specified project and region.	Request object method variants only take one parameter, a request object, which must be constructed before the call. list(ListRegionInstanceTemplatesRequest 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()

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.

public static final RegionInstanceTemplatesClient create()

Constructs an instance of RegionInstanceTemplatesClient with default settings.

public static final RegionInstanceTemplatesClient create(RegionInstanceTemplatesSettings settings)

Constructs an instance of RegionInstanceTemplatesClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

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

protected RegionInstanceTemplatesClient(RegionInstanceTemplatesSettings settings)

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.

protected RegionInstanceTemplatesClient(RegionInstanceTemplatesStub stub)

public boolean awaitTermination(long duration, TimeUnit unit)

public final void close()

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

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

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

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

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

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

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

public final RegionInstanceTemplatesSettings getSettings()

public RegionInstanceTemplatesStub getStub()

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

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

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

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

public boolean isShutdown()

public boolean isTerminated()

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

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

public final 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;
     }
   }
 }
 

public final 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);
   }
 }
 

public void shutdown()

public void shutdownNow()