com.google.cloud.compute.v1

Class InstanceTemplateClient

java.lang.Object

com.google.cloud.compute.v1.InstanceTemplateClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator")
 @BetaApi
public class InstanceTemplateClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: Creates and runs virtual machines on Google Cloud Platform.

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:

 
 try (InstanceTemplateClient instanceTemplateClient = InstanceTemplateClient.create()) {
   ProjectGlobalInstanceTemplateName instanceTemplate = ProjectGlobalInstanceTemplateName.of("[PROJECT]", "[INSTANCE_TEMPLATE]");
   Operation response = instanceTemplateClient.deleteInstanceTemplate(instanceTemplate);
 }
 
 

Note: close() needs to be called on the instanceTemplateClient 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 InstanceTemplateSettings to create(). For example:

To customize credentials:

 
 InstanceTemplateSettings instanceTemplateSettings =
     InstanceTemplateSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 InstanceTemplateClient instanceTemplateClient =
     InstanceTemplateClient.create(instanceTemplateSettings);
 
 

To customize the endpoint:

 
 InstanceTemplateSettings instanceTemplateSettings =
     InstanceTemplateSettings.newBuilder().setEndpoint(myEndpoint).build();
 InstanceTemplateClient instanceTemplateClient =
     InstanceTemplateClient.create(instanceTemplateSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InstanceTemplateClient.ListInstanceTemplatesFixedSizeCollection
static class	InstanceTemplateClient.ListInstanceTemplatesPage
static class	InstanceTemplateClient.ListInstanceTemplatesPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InstanceTemplateClient(InstanceTemplateSettings settings) Constructs an instance of InstanceTemplateClient, using the given settings.
protected	InstanceTemplateClient(InstanceTemplateStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static InstanceTemplateClient	create() Constructs an instance of InstanceTemplateClient with default settings.
static InstanceTemplateClient	create(InstanceTemplateSettings settings) Constructs an instance of InstanceTemplateClient, using the given settings.
static InstanceTemplateClient	create(InstanceTemplateStub stub) Constructs an instance of InstanceTemplateClient, using the given stub for making calls.
Operation	deleteInstanceTemplate(DeleteInstanceTemplateHttpRequest request) Deletes the specified instance template.
Operation	deleteInstanceTemplate(ProjectGlobalInstanceTemplateName instanceTemplate) Deletes the specified instance template.
Operation	deleteInstanceTemplate(String instanceTemplate) Deletes the specified instance template.
com.google.api.gax.rpc.UnaryCallable<DeleteInstanceTemplateHttpRequest,Operation>	deleteInstanceTemplateCallable() Deletes the specified instance template.
Policy	getIamPolicyInstanceTemplate(GetIamPolicyInstanceTemplateHttpRequest request) Gets the access control policy for a resource.
Policy	getIamPolicyInstanceTemplate(ProjectGlobalInstanceTemplateResourceName resource) Gets the access control policy for a resource.
Policy	getIamPolicyInstanceTemplate(String resource) Gets the access control policy for a resource.
com.google.api.gax.rpc.UnaryCallable<GetIamPolicyInstanceTemplateHttpRequest,Policy>	getIamPolicyInstanceTemplateCallable() Gets the access control policy for a resource.
InstanceTemplate	getInstanceTemplate(GetInstanceTemplateHttpRequest request) Returns the specified instance template.
InstanceTemplate	getInstanceTemplate(ProjectGlobalInstanceTemplateName instanceTemplate) Returns the specified instance template.
InstanceTemplate	getInstanceTemplate(String instanceTemplate) Returns the specified instance template.
com.google.api.gax.rpc.UnaryCallable<GetInstanceTemplateHttpRequest,InstanceTemplate>	getInstanceTemplateCallable() Returns the specified instance template.
InstanceTemplateSettings	getSettings()
InstanceTemplateStub	getStub()
Operation	insertInstanceTemplate(InsertInstanceTemplateHttpRequest request) Creates an instance template in the specified project using the data that is included in the request.
Operation	insertInstanceTemplate(ProjectName project, InstanceTemplate instanceTemplateResource) Creates an instance template in the specified project using the data that is included in the request.
Operation	insertInstanceTemplate(String project, InstanceTemplate instanceTemplateResource) Creates an instance template in the specified project using the data that is included in the request.
com.google.api.gax.rpc.UnaryCallable<InsertInstanceTemplateHttpRequest,Operation>	insertInstanceTemplateCallable() Creates an instance template in the specified project using the data that is included in the request.
boolean	isShutdown()
boolean	isTerminated()
InstanceTemplateClient.ListInstanceTemplatesPagedResponse	listInstanceTemplates(ListInstanceTemplatesHttpRequest request) Retrieves a list of instance templates that are contained within the specified project.
InstanceTemplateClient.ListInstanceTemplatesPagedResponse	listInstanceTemplates(ProjectName project) Retrieves a list of instance templates that are contained within the specified project.
InstanceTemplateClient.ListInstanceTemplatesPagedResponse	listInstanceTemplates(String project) Retrieves a list of instance templates that are contained within the specified project.
com.google.api.gax.rpc.UnaryCallable<ListInstanceTemplatesHttpRequest,InstanceTemplateList>	listInstanceTemplatesCallable() Retrieves a list of instance templates that are contained within the specified project.
com.google.api.gax.rpc.UnaryCallable<ListInstanceTemplatesHttpRequest,InstanceTemplateClient.ListInstanceTemplatesPagedResponse>	listInstanceTemplatesPagedCallable() Retrieves a list of instance templates that are contained within the specified project.
Policy	setIamPolicyInstanceTemplate(ProjectGlobalInstanceTemplateResourceName resource, GlobalSetPolicyRequest globalSetPolicyRequestResource) Sets the access control policy on the specified resource.
Policy	setIamPolicyInstanceTemplate(SetIamPolicyInstanceTemplateHttpRequest request) Sets the access control policy on the specified resource.
Policy	setIamPolicyInstanceTemplate(String resource, GlobalSetPolicyRequest globalSetPolicyRequestResource) Sets the access control policy on the specified resource.
com.google.api.gax.rpc.UnaryCallable<SetIamPolicyInstanceTemplateHttpRequest,Policy>	setIamPolicyInstanceTemplateCallable() Sets the access control policy on the specified resource.
void	shutdown()
void	shutdownNow()
TestPermissionsResponse	testIamPermissionsInstanceTemplate(ProjectGlobalInstanceTemplateResourceName resource, TestPermissionsRequest testPermissionsRequestResource) Returns permissions that a caller has on the specified resource.
TestPermissionsResponse	testIamPermissionsInstanceTemplate(String resource, TestPermissionsRequest testPermissionsRequestResource) Returns permissions that a caller has on the specified resource.
TestPermissionsResponse	testIamPermissionsInstanceTemplate(TestIamPermissionsInstanceTemplateHttpRequest request) Returns permissions that a caller has on the specified resource.
com.google.api.gax.rpc.UnaryCallable<TestIamPermissionsInstanceTemplateHttpRequest,TestPermissionsResponse>	testIamPermissionsInstanceTemplateCallable() Returns permissions that a caller has on the specified resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InstanceTemplateClient

protected InstanceTemplateClient(InstanceTemplateSettings settings)
                          throws IOException

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

InstanceTemplateClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected InstanceTemplateClient(InstanceTemplateStub stub)

Method Detail

create

public static final InstanceTemplateClient create()
                                           throws IOException

Constructs an instance of InstanceTemplateClient with default settings.

Throws:

IOException

create

public static final InstanceTemplateClient create(InstanceTemplateSettings settings)
                                           throws IOException

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

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final InstanceTemplateClient create(InstanceTemplateStub stub)

Constructs an instance of InstanceTemplateClient, using the given stub for making calls. This is for advanced usage - prefer to use InstanceTemplateSettings}.

getSettings

public final InstanceTemplateSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public InstanceTemplateStub getStub()

deleteInstanceTemplate

@BetaApi
public final Operation deleteInstanceTemplate(ProjectGlobalInstanceTemplateName instanceTemplate)

Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone. It is not possible to delete templates that are already in use by a managed instance group.

Sample code:

 try (InstanceTemplateClient instanceTemplateClient = InstanceTemplateClient.create()) {
   ProjectGlobalInstanceTemplateName instanceTemplate = ProjectGlobalInstanceTemplateName.of("[PROJECT]", "[INSTANCE_TEMPLATE]");
   Operation response = instanceTemplateClient.deleteInstanceTemplate(instanceTemplate);
 }
 

Parameters:

instanceTemplate - The name of the instance template to delete.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteInstanceTemplate

@BetaApi
public final Operation deleteInstanceTemplate(String instanceTemplate)

Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone. It is not possible to delete templates that are already in use by a managed instance group.

Sample code:

 try (InstanceTemplateClient instanceTemplateClient = InstanceTemplateClient.create()) {
   ProjectGlobalInstanceTemplateName instanceTemplate = ProjectGlobalInstanceTemplateName.of("[PROJECT]", "[INSTANCE_TEMPLATE]");
   Operation response = instanceTemplateClient.deleteInstanceTemplate(instanceTemplate.toString());
 }
 

Parameters:

instanceTemplate - The name of the instance template to delete.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteInstanceTemplate

@BetaApi
public final Operation deleteInstanceTemplate(DeleteInstanceTemplateHttpRequest request)

Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone. It is not possible to delete templates that are already in use by a managed instance group.

Sample code:

 try (InstanceTemplateClient instanceTemplateClient = InstanceTemplateClient.create()) {
   String formattedInstanceTemplate = ProjectGlobalInstanceTemplateName.format("[PROJECT]", "[INSTANCE_TEMPLATE]");
   DeleteInstanceTemplateHttpRequest request = DeleteInstanceTemplateHttpRequest.newBuilder()
     .setInstanceTemplate(formattedInstanceTemplate)
     .build();
   Operation response = instanceTemplateClient.deleteInstanceTemplate(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

deleteInstanceTemplateCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<DeleteInstanceTemplateHttpRequest,Operation> deleteInstanceTemplateCallable()

Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone. It is not possible to delete templates that are already in use by a managed instance group.

Sample code:

 try (InstanceTemplateClient instanceTemplateClient = InstanceTemplateClient.create()) {
   String formattedInstanceTemplate = ProjectGlobalInstanceTemplateName.format("[PROJECT]", "[INSTANCE_TEMPLATE]");
   DeleteInstanceTemplateHttpRequest request = DeleteInstanceTemplateHttpRequest.newBuilder()
     .setInstanceTemplate(formattedInstanceTemplate)
     .build();
   ApiFuture<Operation> future = instanceTemplateClient.deleteInstanceTemplateCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

getInstanceTemplate

@BetaApi
public final InstanceTemplate getInstanceTemplate(ProjectGlobalInstanceTemplateName instanceTemplate)

Returns the specified instance template. Gets a list of available instance templates by making a list() request.

Sample code:

 try (InstanceTemplateClient instanceTemplateClient = InstanceTemplateClient.create()) {
   ProjectGlobalInstanceTemplateName instanceTemplate = ProjectGlobalInstanceTemplateName.of("[PROJECT]", "[INSTANCE_TEMPLATE]");
   InstanceTemplate response = instanceTemplateClient.getInstanceTemplate(instanceTemplate);
 }
 

Parameters:

instanceTemplate - The name of the instance template.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getInstanceTemplate

@BetaApi
public final InstanceTemplate getInstanceTemplate(String instanceTemplate)

Returns the specified instance template. Gets a list of available instance templates by making a list() request.

Sample code:

 try (InstanceTemplateClient instanceTemplateClient = InstanceTemplateClient.create()) {
   ProjectGlobalInstanceTemplateName instanceTemplate = ProjectGlobalInstanceTemplateName.of("[PROJECT]", "[INSTANCE_TEMPLATE]");
   InstanceTemplate response = instanceTemplateClient.getInstanceTemplate(instanceTemplate.toString());
 }
 

Parameters:

instanceTemplate - The name of the instance template.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getInstanceTemplate

@BetaApi
public final InstanceTemplate getInstanceTemplate(GetInstanceTemplateHttpRequest request)

Returns the specified instance template. Gets a list of available instance templates by making a list() request.

Sample code:

 try (InstanceTemplateClient instanceTemplateClient = InstanceTemplateClient.create()) {
   String formattedInstanceTemplate = ProjectGlobalInstanceTemplateName.format("[PROJECT]", "[INSTANCE_TEMPLATE]");
   GetInstanceTemplateHttpRequest request = GetInstanceTemplateHttpRequest.newBuilder()
     .setInstanceTemplate(formattedInstanceTemplate)
     .build();
   InstanceTemplate response = instanceTemplateClient.getInstanceTemplate(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

getInstanceTemplateCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<GetInstanceTemplateHttpRequest,InstanceTemplate> getInstanceTemplateCallable()

Returns the specified instance template. Gets a list of available instance templates by making a list() request.

Sample code:

 try (InstanceTemplateClient instanceTemplateClient = InstanceTemplateClient.create()) {
   String formattedInstanceTemplate = ProjectGlobalInstanceTemplateName.format("[PROJECT]", "[INSTANCE_TEMPLATE]");
   GetInstanceTemplateHttpRequest request = GetInstanceTemplateHttpRequest.newBuilder()
     .setInstanceTemplate(formattedInstanceTemplate)
     .build();
   ApiFuture<InstanceTemplate> future = instanceTemplateClient.getInstanceTemplateCallable().futureCall(request);
   // Do something
   InstanceTemplate response = future.get();
 }
 

getIamPolicyInstanceTemplate

@BetaApi
public final Policy getIamPolicyInstanceTemplate(ProjectGlobalInstanceTemplateResourceName resource)

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

Sample code:

 try (InstanceTemplateClient instanceTemplateClient = InstanceTemplateClient.create()) {
   ProjectGlobalInstanceTemplateResourceName resource = ProjectGlobalInstanceTemplateResourceName.of("[PROJECT]", "[RESOURCE]");
   Policy response = instanceTemplateClient.getIamPolicyInstanceTemplate(resource);
 }
 

Parameters:

resource - Name or id of the resource for this request.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getIamPolicyInstanceTemplate

@BetaApi
public final Policy getIamPolicyInstanceTemplate(String resource)

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

Sample code:

 try (InstanceTemplateClient instanceTemplateClient = InstanceTemplateClient.create()) {
   ProjectGlobalInstanceTemplateResourceName resource = ProjectGlobalInstanceTemplateResourceName.of("[PROJECT]", "[RESOURCE]");
   Policy response = instanceTemplateClient.getIamPolicyInstanceTemplate(resource.toString());
 }
 

Parameters:

resource - Name or id of the resource for this request.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getIamPolicyInstanceTemplate

@BetaApi
public final Policy getIamPolicyInstanceTemplate(GetIamPolicyInstanceTemplateHttpRequest request)

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

Sample code:

 try (InstanceTemplateClient instanceTemplateClient = InstanceTemplateClient.create()) {
   String formattedResource = ProjectGlobalInstanceTemplateResourceName.format("[PROJECT]", "[RESOURCE]");
   GetIamPolicyInstanceTemplateHttpRequest request = GetIamPolicyInstanceTemplateHttpRequest.newBuilder()
     .setResource(formattedResource)
     .build();
   Policy response = instanceTemplateClient.getIamPolicyInstanceTemplate(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

getIamPolicyInstanceTemplateCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<GetIamPolicyInstanceTemplateHttpRequest,Policy> getIamPolicyInstanceTemplateCallable()

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

Sample code:

 try (InstanceTemplateClient instanceTemplateClient = InstanceTemplateClient.create()) {
   String formattedResource = ProjectGlobalInstanceTemplateResourceName.format("[PROJECT]", "[RESOURCE]");
   GetIamPolicyInstanceTemplateHttpRequest request = GetIamPolicyInstanceTemplateHttpRequest.newBuilder()
     .setResource(formattedResource)
     .build();
   ApiFuture<Policy> future = instanceTemplateClient.getIamPolicyInstanceTemplateCallable().futureCall(request);
   // Do something
   Policy response = future.get();
 }
 

insertInstanceTemplate

@BetaApi
public final Operation insertInstanceTemplate(ProjectName project,
                                                       InstanceTemplate instanceTemplateResource)

Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template.

Sample code:

 try (InstanceTemplateClient instanceTemplateClient = InstanceTemplateClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   InstanceTemplate instanceTemplateResource = InstanceTemplate.newBuilder().build();
   Operation response = instanceTemplateClient.insertInstanceTemplate(project, instanceTemplateResource);
 }
 

Parameters:

project - Project ID for this request.

instanceTemplateResource - Represents an Instance Template resource.

You can use instance templates to create VM instances and managed instance groups. For more information, read Instance Templates. (== resource_for beta.instanceTemplates ==) (== resource_for v1.instanceTemplates ==)

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

insertInstanceTemplate

@BetaApi
public final Operation insertInstanceTemplate(String project,
                                                       InstanceTemplate instanceTemplateResource)

Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template.

Sample code:

 try (InstanceTemplateClient instanceTemplateClient = InstanceTemplateClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   InstanceTemplate instanceTemplateResource = InstanceTemplate.newBuilder().build();
   Operation response = instanceTemplateClient.insertInstanceTemplate(project.toString(), instanceTemplateResource);
 }
 

Parameters:

project - Project ID for this request.

instanceTemplateResource - Represents an Instance Template resource.

You can use instance templates to create VM instances and managed instance groups. For more information, read Instance Templates. (== resource_for beta.instanceTemplates ==) (== resource_for v1.instanceTemplates ==)

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

insertInstanceTemplate

@BetaApi
public final Operation insertInstanceTemplate(InsertInstanceTemplateHttpRequest request)

Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template.

Sample code:

 try (InstanceTemplateClient instanceTemplateClient = InstanceTemplateClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   InstanceTemplate instanceTemplateResource = InstanceTemplate.newBuilder().build();
   InsertInstanceTemplateHttpRequest request = InsertInstanceTemplateHttpRequest.newBuilder()
     .setProject(formattedProject)
     .setInstanceTemplateResource(instanceTemplateResource)
     .build();
   Operation response = instanceTemplateClient.insertInstanceTemplate(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

insertInstanceTemplateCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<InsertInstanceTemplateHttpRequest,Operation> insertInstanceTemplateCallable()

Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template.

Sample code:

 try (InstanceTemplateClient instanceTemplateClient = InstanceTemplateClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   InstanceTemplate instanceTemplateResource = InstanceTemplate.newBuilder().build();
   InsertInstanceTemplateHttpRequest request = InsertInstanceTemplateHttpRequest.newBuilder()
     .setProject(formattedProject)
     .setInstanceTemplateResource(instanceTemplateResource)
     .build();
   ApiFuture<Operation> future = instanceTemplateClient.insertInstanceTemplateCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

listInstanceTemplates

@BetaApi
public final InstanceTemplateClient.ListInstanceTemplatesPagedResponse listInstanceTemplates(ProjectName project)

Retrieves a list of instance templates that are contained within the specified project.

Sample code:

 try (InstanceTemplateClient instanceTemplateClient = InstanceTemplateClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (InstanceTemplate element : instanceTemplateClient.listInstanceTemplates(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listInstanceTemplates

@BetaApi
public final InstanceTemplateClient.ListInstanceTemplatesPagedResponse listInstanceTemplates(String project)

Retrieves a list of instance templates that are contained within the specified project.

Sample code:

 try (InstanceTemplateClient instanceTemplateClient = InstanceTemplateClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (InstanceTemplate element : instanceTemplateClient.listInstanceTemplates(project.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listInstanceTemplates

@BetaApi
public final InstanceTemplateClient.ListInstanceTemplatesPagedResponse listInstanceTemplates(ListInstanceTemplatesHttpRequest request)

Retrieves a list of instance templates that are contained within the specified project.

Sample code:

 try (InstanceTemplateClient instanceTemplateClient = InstanceTemplateClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListInstanceTemplatesHttpRequest request = ListInstanceTemplatesHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   for (InstanceTemplate element : instanceTemplateClient.listInstanceTemplates(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

listInstanceTemplatesPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListInstanceTemplatesHttpRequest,InstanceTemplateClient.ListInstanceTemplatesPagedResponse> listInstanceTemplatesPagedCallable()

Retrieves a list of instance templates that are contained within the specified project.

Sample code:

 try (InstanceTemplateClient instanceTemplateClient = InstanceTemplateClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListInstanceTemplatesHttpRequest request = ListInstanceTemplatesHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   ApiFuture<ListInstanceTemplatesPagedResponse> future = instanceTemplateClient.listInstanceTemplatesPagedCallable().futureCall(request);
   // Do something
   for (InstanceTemplate element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listInstanceTemplatesCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListInstanceTemplatesHttpRequest,InstanceTemplateList> listInstanceTemplatesCallable()

Retrieves a list of instance templates that are contained within the specified project.

Sample code:

 try (InstanceTemplateClient instanceTemplateClient = InstanceTemplateClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListInstanceTemplatesHttpRequest request = ListInstanceTemplatesHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   while (true) {
     InstanceTemplateList response = instanceTemplateClient.listInstanceTemplatesCallable().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;
     }
   }
 }
 

setIamPolicyInstanceTemplate

@BetaApi
public final Policy setIamPolicyInstanceTemplate(ProjectGlobalInstanceTemplateResourceName resource,
                                                          GlobalSetPolicyRequest globalSetPolicyRequestResource)

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

Sample code:

 try (InstanceTemplateClient instanceTemplateClient = InstanceTemplateClient.create()) {
   ProjectGlobalInstanceTemplateResourceName resource = ProjectGlobalInstanceTemplateResourceName.of("[PROJECT]", "[RESOURCE]");
   GlobalSetPolicyRequest globalSetPolicyRequestResource = GlobalSetPolicyRequest.newBuilder().build();
   Policy response = instanceTemplateClient.setIamPolicyInstanceTemplate(resource, globalSetPolicyRequestResource);
 }
 

Parameters:

resource - Name or id of the resource for this request.

globalSetPolicyRequestResource -

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

setIamPolicyInstanceTemplate

@BetaApi
public final Policy setIamPolicyInstanceTemplate(String resource,
                                                          GlobalSetPolicyRequest globalSetPolicyRequestResource)

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

Sample code:

 try (InstanceTemplateClient instanceTemplateClient = InstanceTemplateClient.create()) {
   ProjectGlobalInstanceTemplateResourceName resource = ProjectGlobalInstanceTemplateResourceName.of("[PROJECT]", "[RESOURCE]");
   GlobalSetPolicyRequest globalSetPolicyRequestResource = GlobalSetPolicyRequest.newBuilder().build();
   Policy response = instanceTemplateClient.setIamPolicyInstanceTemplate(resource.toString(), globalSetPolicyRequestResource);
 }
 

Parameters:

resource - Name or id of the resource for this request.

globalSetPolicyRequestResource -

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

setIamPolicyInstanceTemplate

@BetaApi
public final Policy setIamPolicyInstanceTemplate(SetIamPolicyInstanceTemplateHttpRequest request)

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

Sample code:

 try (InstanceTemplateClient instanceTemplateClient = InstanceTemplateClient.create()) {
   String formattedResource = ProjectGlobalInstanceTemplateResourceName.format("[PROJECT]", "[RESOURCE]");
   GlobalSetPolicyRequest globalSetPolicyRequestResource = GlobalSetPolicyRequest.newBuilder().build();
   SetIamPolicyInstanceTemplateHttpRequest request = SetIamPolicyInstanceTemplateHttpRequest.newBuilder()
     .setResource(formattedResource)
     .setGlobalSetPolicyRequestResource(globalSetPolicyRequestResource)
     .build();
   Policy response = instanceTemplateClient.setIamPolicyInstanceTemplate(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

setIamPolicyInstanceTemplateCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<SetIamPolicyInstanceTemplateHttpRequest,Policy> setIamPolicyInstanceTemplateCallable()

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

Sample code:

 try (InstanceTemplateClient instanceTemplateClient = InstanceTemplateClient.create()) {
   String formattedResource = ProjectGlobalInstanceTemplateResourceName.format("[PROJECT]", "[RESOURCE]");
   GlobalSetPolicyRequest globalSetPolicyRequestResource = GlobalSetPolicyRequest.newBuilder().build();
   SetIamPolicyInstanceTemplateHttpRequest request = SetIamPolicyInstanceTemplateHttpRequest.newBuilder()
     .setResource(formattedResource)
     .setGlobalSetPolicyRequestResource(globalSetPolicyRequestResource)
     .build();
   ApiFuture<Policy> future = instanceTemplateClient.setIamPolicyInstanceTemplateCallable().futureCall(request);
   // Do something
   Policy response = future.get();
 }
 

testIamPermissionsInstanceTemplate

@BetaApi
public final TestPermissionsResponse testIamPermissionsInstanceTemplate(ProjectGlobalInstanceTemplateResourceName resource,
                                                                                 TestPermissionsRequest testPermissionsRequestResource)

Returns permissions that a caller has on the specified resource.

Sample code:

 try (InstanceTemplateClient instanceTemplateClient = InstanceTemplateClient.create()) {
   ProjectGlobalInstanceTemplateResourceName resource = ProjectGlobalInstanceTemplateResourceName.of("[PROJECT]", "[RESOURCE]");
   TestPermissionsRequest testPermissionsRequestResource = TestPermissionsRequest.newBuilder().build();
   TestPermissionsResponse response = instanceTemplateClient.testIamPermissionsInstanceTemplate(resource, testPermissionsRequestResource);
 }
 

Parameters:

resource - Name or id of the resource for this request.

testPermissionsRequestResource -

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

testIamPermissionsInstanceTemplate

@BetaApi
public final TestPermissionsResponse testIamPermissionsInstanceTemplate(String resource,
                                                                                 TestPermissionsRequest testPermissionsRequestResource)

Returns permissions that a caller has on the specified resource.

Sample code:

 try (InstanceTemplateClient instanceTemplateClient = InstanceTemplateClient.create()) {
   ProjectGlobalInstanceTemplateResourceName resource = ProjectGlobalInstanceTemplateResourceName.of("[PROJECT]", "[RESOURCE]");
   TestPermissionsRequest testPermissionsRequestResource = TestPermissionsRequest.newBuilder().build();
   TestPermissionsResponse response = instanceTemplateClient.testIamPermissionsInstanceTemplate(resource.toString(), testPermissionsRequestResource);
 }
 

Parameters:

resource - Name or id of the resource for this request.

testPermissionsRequestResource -

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

testIamPermissionsInstanceTemplate

@BetaApi
public final TestPermissionsResponse testIamPermissionsInstanceTemplate(TestIamPermissionsInstanceTemplateHttpRequest request)

Returns permissions that a caller has on the specified resource.

Sample code:

 try (InstanceTemplateClient instanceTemplateClient = InstanceTemplateClient.create()) {
   String formattedResource = ProjectGlobalInstanceTemplateResourceName.format("[PROJECT]", "[RESOURCE]");
   TestPermissionsRequest testPermissionsRequestResource = TestPermissionsRequest.newBuilder().build();
   TestIamPermissionsInstanceTemplateHttpRequest request = TestIamPermissionsInstanceTemplateHttpRequest.newBuilder()
     .setResource(formattedResource)
     .setTestPermissionsRequestResource(testPermissionsRequestResource)
     .build();
   TestPermissionsResponse response = instanceTemplateClient.testIamPermissionsInstanceTemplate(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

testIamPermissionsInstanceTemplateCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<TestIamPermissionsInstanceTemplateHttpRequest,TestPermissionsResponse> testIamPermissionsInstanceTemplateCallable()

Returns permissions that a caller has on the specified resource.

Sample code:

 try (InstanceTemplateClient instanceTemplateClient = InstanceTemplateClient.create()) {
   String formattedResource = ProjectGlobalInstanceTemplateResourceName.format("[PROJECT]", "[RESOURCE]");
   TestPermissionsRequest testPermissionsRequestResource = TestPermissionsRequest.newBuilder().build();
   TestIamPermissionsInstanceTemplateHttpRequest request = TestIamPermissionsInstanceTemplateHttpRequest.newBuilder()
     .setResource(formattedResource)
     .setTestPermissionsRequestResource(testPermissionsRequestResource)
     .build();
   ApiFuture<TestPermissionsResponse> future = instanceTemplateClient.testIamPermissionsInstanceTemplateCallable().futureCall(request);
   // Do something
   TestPermissionsResponse response = future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

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

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException