Class RegionInstanceTemplatesClient (1.39.0)

public class RegionInstanceTemplatesClient implements 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:

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

Inheritance

java.lang.Object > RegionInstanceTemplatesClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final RegionInstanceTemplatesClient create()

Constructs an instance of RegionInstanceTemplatesClient with default settings.

Returns
Type	Description
`RegionInstanceTemplatesClient`

Exceptions
Type	Description
`IOException`

create(RegionInstanceTemplatesSettings 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.

Parameter
Name	Description
`settings`	`RegionInstanceTemplatesSettings`

Returns
Type	Description
`RegionInstanceTemplatesClient`

Exceptions
Type	Description
`IOException`

create(RegionInstanceTemplatesStub stub)

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

Parameter
Name	Description
`stub`	`RegionInstanceTemplatesStub`

Returns
Type	Description
`RegionInstanceTemplatesClient`

Constructors

RegionInstanceTemplatesClient(RegionInstanceTemplatesSettings settings)

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.

Parameter
Name	Description
`settings`	`RegionInstanceTemplatesSettings`

RegionInstanceTemplatesClient(RegionInstanceTemplatesStub stub)

protected RegionInstanceTemplatesClient(RegionInstanceTemplatesStub stub)

Parameter
Name	Description
`stub`	`RegionInstanceTemplatesStub`

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
`duration`	`long`
`unit`	`TimeUnit`

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`InterruptedException`

close()

public final void close()

deleteAsync(DeleteRegionInstanceTemplateRequest request)

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

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

Returns
Type	Description
`OperationFuture<Operation,Operation>`

deleteAsync(String project, String region, String instanceTemplate)

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

Parameters
Name	Description
`project`	`String` Project ID for this request.
`region`	`String` The name of the region for this request.
`instanceTemplate`	`String` The name of the instance template to delete.

Returns
Type	Description
`OperationFuture<Operation,Operation>`

deleteCallable()

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

Returns
Type	Description
`UnaryCallable<DeleteRegionInstanceTemplateRequest,Operation>`

deleteOperationCallable()

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

Returns
Type	Description
`OperationCallable<DeleteRegionInstanceTemplateRequest,Operation,Operation>`

get(GetRegionInstanceTemplateRequest request)

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

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

Returns
Type	Description
`InstanceTemplate`

get(String project, String region, String instanceTemplate)

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
Name	Description
`project`	`String` Project ID for this request.
`region`	`String` The name of the region for this request.
`instanceTemplate`	`String` The name of the instance template.

Returns
Type	Description
`InstanceTemplate`

getCallable()

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

Returns
Type	Description
`UnaryCallable<GetRegionInstanceTemplateRequest,InstanceTemplate>`

getSettings()

public final RegionInstanceTemplatesSettings getSettings()

Returns
Type	Description
`RegionInstanceTemplatesSettings`

getStub()

public RegionInstanceTemplatesStub getStub()

Returns
Type	Description
`RegionInstanceTemplatesStub`

insertAsync(InsertRegionInstanceTemplateRequest request)

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

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

Returns
Type	Description
`OperationFuture<Operation,Operation>`

insertAsync(String project, String region, InstanceTemplate instanceTemplateResource)

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

Parameters
Name	Description
`project`	`String` Project ID for this request.
`region`	`String` The name of the region for this request.
`instanceTemplateResource`	`InstanceTemplate` The body resource for this request

Returns
Type	Description
`OperationFuture<Operation,Operation>`

insertCallable()

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

Returns
Type	Description
`UnaryCallable<InsertRegionInstanceTemplateRequest,Operation>`

insertOperationCallable()

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

Returns
Type	Description
`OperationCallable<InsertRegionInstanceTemplateRequest,Operation,Operation>`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

list(ListRegionInstanceTemplatesRequest request)

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

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

Returns
Type	Description
`RegionInstanceTemplatesClient.ListPagedResponse`

list(String project, String region)

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
Name	Description
`project`	`String` Project ID for this request.
`region`	`String` The name of the regions for this request.

Returns
Type	Description
`RegionInstanceTemplatesClient.ListPagedResponse`

listCallable()

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

Returns
Type	Description
`UnaryCallable<ListRegionInstanceTemplatesRequest,InstanceTemplateList>`

listPagedCallable()

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

Returns
Type	Description
`UnaryCallable<ListRegionInstanceTemplatesRequest,ListPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()