NodeTemplateClient (Google Cloud 0.119.0-alpha API)

java.lang.Object
- com.google.cloud.compute.v1.NodeTemplateClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
 @BetaApi
public class NodeTemplateClient
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 (NodeTemplateClient nodeTemplateClient = NodeTemplateClient.create()) {
   ProjectRegionNodeTemplateName nodeTemplate = ProjectRegionNodeTemplateName.of("[PROJECT]", "[REGION]", "[NODE_TEMPLATE]");
   Operation response = nodeTemplateClient.deleteNodeTemplate(nodeTemplate);
 }
 
 
```
Note: close() needs to be called on the nodeTemplateClient 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 NodeTemplateSettings to create(). For example:
To customize credentials:
```
 
 NodeTemplateSettings nodeTemplateSettings =
     NodeTemplateSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 NodeTemplateClient nodeTemplateClient =
     NodeTemplateClient.create(nodeTemplateSettings);
 
 
```
To customize the endpoint:
```
 
 NodeTemplateSettings nodeTemplateSettings =
     NodeTemplateSettings.newBuilder().setEndpoint(myEndpoint).build();
 NodeTemplateClient nodeTemplateClient =
     NodeTemplateClient.create(nodeTemplateSettings);
 
 
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`NodeTemplateClient.AggregatedListNodeTemplatesFixedSizeCollection`
`static class`	`NodeTemplateClient.AggregatedListNodeTemplatesPage`
`static class`	`NodeTemplateClient.AggregatedListNodeTemplatesPagedResponse`
`static class`	`NodeTemplateClient.ListNodeTemplatesFixedSizeCollection`
`static class`	`NodeTemplateClient.ListNodeTemplatesPage`
`static class`	`NodeTemplateClient.ListNodeTemplatesPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`NodeTemplateClient(NodeTemplateSettings settings)` Constructs an instance of NodeTemplateClient, using the given settings.
`protected`	`NodeTemplateClient(NodeTemplateStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NodeTemplateClient.AggregatedListNodeTemplatesPagedResponse`	`aggregatedListNodeTemplates(AggregatedListNodeTemplatesHttpRequest request)` Retrieves an aggregated list of node templates.
`NodeTemplateClient.AggregatedListNodeTemplatesPagedResponse`	`aggregatedListNodeTemplates(ProjectName project)` Retrieves an aggregated list of node templates.
`NodeTemplateClient.AggregatedListNodeTemplatesPagedResponse`	`aggregatedListNodeTemplates(String project)` Retrieves an aggregated list of node templates.
`com.google.api.gax.rpc.UnaryCallable<AggregatedListNodeTemplatesHttpRequest,NodeTemplateAggregatedList>`	`aggregatedListNodeTemplatesCallable()` Retrieves an aggregated list of node templates.
`com.google.api.gax.rpc.UnaryCallable<AggregatedListNodeTemplatesHttpRequest,NodeTemplateClient.AggregatedListNodeTemplatesPagedResponse>`	`aggregatedListNodeTemplatesPagedCallable()` Retrieves an aggregated list of node templates.
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static NodeTemplateClient`	`create()` Constructs an instance of NodeTemplateClient with default settings.
`static NodeTemplateClient`	`create(NodeTemplateSettings settings)` Constructs an instance of NodeTemplateClient, using the given settings.
`static NodeTemplateClient`	`create(NodeTemplateStub stub)` Constructs an instance of NodeTemplateClient, using the given stub for making calls.
`Operation`	`deleteNodeTemplate(DeleteNodeTemplateHttpRequest request)` Deletes the specified NodeTemplate resource.
`Operation`	`deleteNodeTemplate(ProjectRegionNodeTemplateName nodeTemplate)` Deletes the specified NodeTemplate resource.
`Operation`	`deleteNodeTemplate(String nodeTemplate)` Deletes the specified NodeTemplate resource.
`com.google.api.gax.rpc.UnaryCallable<DeleteNodeTemplateHttpRequest,Operation>`	`deleteNodeTemplateCallable()` Deletes the specified NodeTemplate resource.
`Policy`	`getIamPolicyNodeTemplate(GetIamPolicyNodeTemplateHttpRequest request)` Gets the access control policy for a resource.
`Policy`	`getIamPolicyNodeTemplate(ProjectRegionNodeTemplateResourceName resource)` Gets the access control policy for a resource.
`Policy`	`getIamPolicyNodeTemplate(String resource)` Gets the access control policy for a resource.
`com.google.api.gax.rpc.UnaryCallable<GetIamPolicyNodeTemplateHttpRequest,Policy>`	`getIamPolicyNodeTemplateCallable()` Gets the access control policy for a resource.
`NodeTemplate`	`getNodeTemplate(GetNodeTemplateHttpRequest request)` Returns the specified node template.
`NodeTemplate`	`getNodeTemplate(ProjectRegionNodeTemplateName nodeTemplate)` Returns the specified node template.
`NodeTemplate`	`getNodeTemplate(String nodeTemplate)` Returns the specified node template.
`com.google.api.gax.rpc.UnaryCallable<GetNodeTemplateHttpRequest,NodeTemplate>`	`getNodeTemplateCallable()` Returns the specified node template.
`NodeTemplateSettings`	`getSettings()`
`NodeTemplateStub`	`getStub()`
`Operation`	`insertNodeTemplate(InsertNodeTemplateHttpRequest request)` Creates a NodeTemplate resource in the specified project using the data included in the request.
`Operation`	`insertNodeTemplate(ProjectRegionName region, NodeTemplate nodeTemplateResource)` Creates a NodeTemplate resource in the specified project using the data included in the request.
`Operation`	`insertNodeTemplate(String region, NodeTemplate nodeTemplateResource)` Creates a NodeTemplate resource in the specified project using the data included in the request.
`com.google.api.gax.rpc.UnaryCallable<InsertNodeTemplateHttpRequest,Operation>`	`insertNodeTemplateCallable()` Creates a NodeTemplate resource in the specified project using the data included in the request.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`NodeTemplateClient.ListNodeTemplatesPagedResponse`	`listNodeTemplates(ListNodeTemplatesHttpRequest request)` Retrieves a list of node templates available to the specified project.
`NodeTemplateClient.ListNodeTemplatesPagedResponse`	`listNodeTemplates(ProjectRegionName region)` Retrieves a list of node templates available to the specified project.
`NodeTemplateClient.ListNodeTemplatesPagedResponse`	`listNodeTemplates(String region)` Retrieves a list of node templates available to the specified project.
`com.google.api.gax.rpc.UnaryCallable<ListNodeTemplatesHttpRequest,NodeTemplateList>`	`listNodeTemplatesCallable()` Retrieves a list of node templates available to the specified project.
`com.google.api.gax.rpc.UnaryCallable<ListNodeTemplatesHttpRequest,NodeTemplateClient.ListNodeTemplatesPagedResponse>`	`listNodeTemplatesPagedCallable()` Retrieves a list of node templates available to the specified project.
`Policy`	`setIamPolicyNodeTemplate(ProjectRegionNodeTemplateResourceName resource, RegionSetPolicyRequest regionSetPolicyRequestResource)` Sets the access control policy on the specified resource.
`Policy`	`setIamPolicyNodeTemplate(SetIamPolicyNodeTemplateHttpRequest request)` Sets the access control policy on the specified resource.
`Policy`	`setIamPolicyNodeTemplate(String resource, RegionSetPolicyRequest regionSetPolicyRequestResource)` Sets the access control policy on the specified resource.
`com.google.api.gax.rpc.UnaryCallable<SetIamPolicyNodeTemplateHttpRequest,Policy>`	`setIamPolicyNodeTemplateCallable()` Sets the access control policy on the specified resource.
`void`	`shutdown()`
`void`	`shutdownNow()`
`TestPermissionsResponse`	`testIamPermissionsNodeTemplate(ProjectRegionNodeTemplateResourceName resource, TestPermissionsRequest testPermissionsRequestResource)` Returns permissions that a caller has on the specified resource.
`TestPermissionsResponse`	`testIamPermissionsNodeTemplate(String resource, TestPermissionsRequest testPermissionsRequestResource)` Returns permissions that a caller has on the specified resource.
`TestPermissionsResponse`	`testIamPermissionsNodeTemplate(TestIamPermissionsNodeTemplateHttpRequest request)` Returns permissions that a caller has on the specified resource.
`com.google.api.gax.rpc.UnaryCallable<TestIamPermissionsNodeTemplateHttpRequest,TestPermissionsResponse>`	`testIamPermissionsNodeTemplateCallable()` 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
- NodeTemplateClient
```
protected NodeTemplateClient(NodeTemplateSettings settings)
                      throws IOException
```
  Constructs an instance of NodeTemplateClient, 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
- NodeTemplateClient
```
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected NodeTemplateClient(NodeTemplateStub stub)
```

Method Detail

create

public static final NodeTemplateClient create()
                                       throws IOException

Constructs an instance of NodeTemplateClient with default settings.

Throws:: IOException

create
```
public static final NodeTemplateClient create(NodeTemplateSettings settings)
                                       throws IOException
```
Constructs an instance of NodeTemplateClient, 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 NodeTemplateClient create(NodeTemplateStub stub)

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

getSettings

public final NodeTemplateSettings getSettings()