TargetInstanceClient (Google Cloud 0.119.0-alpha API)

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

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
 @BetaApi
public class TargetInstanceClient
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 (TargetInstanceClient targetInstanceClient = TargetInstanceClient.create()) {
   ProjectZoneTargetInstanceName targetInstance = ProjectZoneTargetInstanceName.of("[PROJECT]", "[ZONE]", "[TARGET_INSTANCE]");
   Operation response = targetInstanceClient.deleteTargetInstance(targetInstance);
 }
 
 
```
Note: close() needs to be called on the targetInstanceClient 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 TargetInstanceSettings to create(). For example:
To customize credentials:
```
 
 TargetInstanceSettings targetInstanceSettings =
     TargetInstanceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 TargetInstanceClient targetInstanceClient =
     TargetInstanceClient.create(targetInstanceSettings);
 
 
```
To customize the endpoint:
```
 
 TargetInstanceSettings targetInstanceSettings =
     TargetInstanceSettings.newBuilder().setEndpoint(myEndpoint).build();
 TargetInstanceClient targetInstanceClient =
     TargetInstanceClient.create(targetInstanceSettings);
 
 
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`TargetInstanceClient.AggregatedListTargetInstancesFixedSizeCollection`
`static class`	`TargetInstanceClient.AggregatedListTargetInstancesPage`
`static class`	`TargetInstanceClient.AggregatedListTargetInstancesPagedResponse`
`static class`	`TargetInstanceClient.ListTargetInstancesFixedSizeCollection`
`static class`	`TargetInstanceClient.ListTargetInstancesPage`
`static class`	`TargetInstanceClient.ListTargetInstancesPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`TargetInstanceClient(TargetInstanceSettings settings)` Constructs an instance of TargetInstanceClient, using the given settings.
`protected`	`TargetInstanceClient(TargetInstanceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TargetInstanceClient.AggregatedListTargetInstancesPagedResponse`	`aggregatedListTargetInstances(AggregatedListTargetInstancesHttpRequest request)` Retrieves an aggregated list of target instances.
`TargetInstanceClient.AggregatedListTargetInstancesPagedResponse`	`aggregatedListTargetInstances(ProjectName project)` Retrieves an aggregated list of target instances.
`TargetInstanceClient.AggregatedListTargetInstancesPagedResponse`	`aggregatedListTargetInstances(String project)` Retrieves an aggregated list of target instances.
`com.google.api.gax.rpc.UnaryCallable<AggregatedListTargetInstancesHttpRequest,TargetInstanceAggregatedList>`	`aggregatedListTargetInstancesCallable()` Retrieves an aggregated list of target instances.
`com.google.api.gax.rpc.UnaryCallable<AggregatedListTargetInstancesHttpRequest,TargetInstanceClient.AggregatedListTargetInstancesPagedResponse>`	`aggregatedListTargetInstancesPagedCallable()` Retrieves an aggregated list of target instances.
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static TargetInstanceClient`	`create()` Constructs an instance of TargetInstanceClient with default settings.
`static TargetInstanceClient`	`create(TargetInstanceSettings settings)` Constructs an instance of TargetInstanceClient, using the given settings.
`static TargetInstanceClient`	`create(TargetInstanceStub stub)` Constructs an instance of TargetInstanceClient, using the given stub for making calls.
`Operation`	`deleteTargetInstance(DeleteTargetInstanceHttpRequest request)` Deletes the specified TargetInstance resource.
`Operation`	`deleteTargetInstance(ProjectZoneTargetInstanceName targetInstance)` Deletes the specified TargetInstance resource.
`Operation`	`deleteTargetInstance(String targetInstance)` Deletes the specified TargetInstance resource.
`com.google.api.gax.rpc.UnaryCallable<DeleteTargetInstanceHttpRequest,Operation>`	`deleteTargetInstanceCallable()` Deletes the specified TargetInstance resource.
`TargetInstanceSettings`	`getSettings()`
`TargetInstanceStub`	`getStub()`
`TargetInstance`	`getTargetInstance(GetTargetInstanceHttpRequest request)` Returns the specified TargetInstance resource.
`TargetInstance`	`getTargetInstance(ProjectZoneTargetInstanceName targetInstance)` Returns the specified TargetInstance resource.
`TargetInstance`	`getTargetInstance(String targetInstance)` Returns the specified TargetInstance resource.
`com.google.api.gax.rpc.UnaryCallable<GetTargetInstanceHttpRequest,TargetInstance>`	`getTargetInstanceCallable()` Returns the specified TargetInstance resource.
`Operation`	`insertTargetInstance(InsertTargetInstanceHttpRequest request)` Creates a TargetInstance resource in the specified project and zone using the data included in the request.
`Operation`	`insertTargetInstance(ProjectZoneName zone, TargetInstance targetInstanceResource)` Creates a TargetInstance resource in the specified project and zone using the data included in the request.
`Operation`	`insertTargetInstance(String zone, TargetInstance targetInstanceResource)` Creates a TargetInstance resource in the specified project and zone using the data included in the request.
`com.google.api.gax.rpc.UnaryCallable<InsertTargetInstanceHttpRequest,Operation>`	`insertTargetInstanceCallable()` Creates a TargetInstance resource in the specified project and zone using the data included in the request.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`TargetInstanceClient.ListTargetInstancesPagedResponse`	`listTargetInstances(ListTargetInstancesHttpRequest request)` Retrieves a list of TargetInstance resources available to the specified project and zone.
`TargetInstanceClient.ListTargetInstancesPagedResponse`	`listTargetInstances(ProjectZoneName zone)` Retrieves a list of TargetInstance resources available to the specified project and zone.
`TargetInstanceClient.ListTargetInstancesPagedResponse`	`listTargetInstances(String zone)` Retrieves a list of TargetInstance resources available to the specified project and zone.
`com.google.api.gax.rpc.UnaryCallable<ListTargetInstancesHttpRequest,TargetInstanceList>`	`listTargetInstancesCallable()` Retrieves a list of TargetInstance resources available to the specified project and zone.
`com.google.api.gax.rpc.UnaryCallable<ListTargetInstancesHttpRequest,TargetInstanceClient.ListTargetInstancesPagedResponse>`	`listTargetInstancesPagedCallable()` Retrieves a list of TargetInstance resources available to the specified project and zone.
`void`	`shutdown()`
`void`	`shutdownNow()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- TargetInstanceClient
```
protected TargetInstanceClient(TargetInstanceSettings settings)
                        throws IOException
```
  Constructs an instance of TargetInstanceClient, 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
- TargetInstanceClient
```
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected TargetInstanceClient(TargetInstanceStub stub)
```

Method Detail

create

public static final TargetInstanceClient create()
                                         throws IOException

Constructs an instance of TargetInstanceClient with default settings.

Throws:: IOException

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

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

getSettings

public final TargetInstanceSettings getSettings()

getStub

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

aggregatedListTargetInstances

@BetaApi
public final TargetInstanceClient.AggregatedListTargetInstancesPagedResponse aggregatedListTargetInstances(ProjectName project)

Retrieves an aggregated list of target instances.

Sample code:


 try (TargetInstanceClient targetInstanceClient = TargetInstanceClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (TargetInstancesScopedList element : targetInstanceClient.aggregatedListTargetInstances(project).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: project - Project ID for this request.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

aggregatedListTargetInstances

@BetaApi
public final TargetInstanceClient.AggregatedListTargetInstancesPagedResponse aggregatedListTargetInstances(String project)

Retrieves an aggregated list of target instances.

Sample code:


 try (TargetInstanceClient targetInstanceClient = TargetInstanceClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (TargetInstancesScopedList element : targetInstanceClient.aggregatedListTargetInstances(project.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: project - Project ID for this request.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

aggregatedListTargetInstances

@BetaApi
public final TargetInstanceClient.AggregatedListTargetInstancesPagedResponse aggregatedListTargetInstances(AggregatedListTargetInstancesHttpRequest request)

Retrieves an aggregated list of target instances.

Sample code:


 try (TargetInstanceClient targetInstanceClient = TargetInstanceClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListTargetInstancesHttpRequest request = AggregatedListTargetInstancesHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   for (TargetInstancesScopedList element : targetInstanceClient.aggregatedListTargetInstances(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

aggregatedListTargetInstancesPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<AggregatedListTargetInstancesHttpRequest,TargetInstanceClient.AggregatedListTargetInstancesPagedResponse> aggregatedListTargetInstancesPagedCallable()

Retrieves an aggregated list of target instances.

Sample code:


 try (TargetInstanceClient targetInstanceClient = TargetInstanceClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListTargetInstancesHttpRequest request = AggregatedListTargetInstancesHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   ApiFuture<AggregatedListTargetInstancesPagedResponse> future = targetInstanceClient.aggregatedListTargetInstancesPagedCallable().futureCall(request);
   // Do something
   for (TargetInstancesScopedList element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

aggregatedListTargetInstancesCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<AggregatedListTargetInstancesHttpRequest,TargetInstanceAggregatedList> aggregatedListTargetInstancesCallable()

Retrieves an aggregated list of target instances.

Sample code:


 try (TargetInstanceClient targetInstanceClient = TargetInstanceClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListTargetInstancesHttpRequest request = AggregatedListTargetInstancesHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   while (true) {
     TargetInstanceAggregatedList response = targetInstanceClient.aggregatedListTargetInstancesCallable().call(request);
     for (TargetInstancesScopedList element : response.getItemsMap()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

deleteTargetInstance

@BetaApi
public final Operation deleteTargetInstance(ProjectZoneTargetInstanceName targetInstance)

Deletes the specified TargetInstance resource.

Sample code:


 try (TargetInstanceClient targetInstanceClient = TargetInstanceClient.create()) {
   ProjectZoneTargetInstanceName targetInstance = ProjectZoneTargetInstanceName.of("[PROJECT]", "[ZONE]", "[TARGET_INSTANCE]");
   Operation response = targetInstanceClient.deleteTargetInstance(targetInstance);
 }

Parameters:: targetInstance - Name of the TargetInstance resource to delete.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteTargetInstance

@BetaApi
public final Operation deleteTargetInstance(String targetInstance)

Deletes the specified TargetInstance resource.

Sample code:


 try (TargetInstanceClient targetInstanceClient = TargetInstanceClient.create()) {
   ProjectZoneTargetInstanceName targetInstance = ProjectZoneTargetInstanceName.of("[PROJECT]", "[ZONE]", "[TARGET_INSTANCE]");
   Operation response = targetInstanceClient.deleteTargetInstance(targetInstance.toString());
 }

Parameters:: targetInstance - Name of the TargetInstance resource to delete.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteTargetInstance

@BetaApi
public final Operation deleteTargetInstance(DeleteTargetInstanceHttpRequest request)

Deletes the specified TargetInstance resource.

Sample code:


 try (TargetInstanceClient targetInstanceClient = TargetInstanceClient.create()) {
   String formattedTargetInstance = ProjectZoneTargetInstanceName.format("[PROJECT]", "[ZONE]", "[TARGET_INSTANCE]");
   DeleteTargetInstanceHttpRequest request = DeleteTargetInstanceHttpRequest.newBuilder()
     .setTargetInstance(formattedTargetInstance)
     .build();
   Operation response = targetInstanceClient.deleteTargetInstance(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

deleteTargetInstanceCallable

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

Deletes the specified TargetInstance resource.

Sample code:


 try (TargetInstanceClient targetInstanceClient = TargetInstanceClient.create()) {
   String formattedTargetInstance = ProjectZoneTargetInstanceName.format("[PROJECT]", "[ZONE]", "[TARGET_INSTANCE]");
   DeleteTargetInstanceHttpRequest request = DeleteTargetInstanceHttpRequest.newBuilder()
     .setTargetInstance(formattedTargetInstance)
     .build();
   ApiFuture<Operation> future = targetInstanceClient.deleteTargetInstanceCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }

getTargetInstance

@BetaApi
public final TargetInstance getTargetInstance(ProjectZoneTargetInstanceName targetInstance)

Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request.

Sample code:


 try (TargetInstanceClient targetInstanceClient = TargetInstanceClient.create()) {
   ProjectZoneTargetInstanceName targetInstance = ProjectZoneTargetInstanceName.of("[PROJECT]", "[ZONE]", "[TARGET_INSTANCE]");
   TargetInstance response = targetInstanceClient.getTargetInstance(targetInstance);
 }

Parameters:: targetInstance - Name of the TargetInstance resource to return.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getTargetInstance

@BetaApi
public final TargetInstance getTargetInstance(String targetInstance)

Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request.

Sample code:


 try (TargetInstanceClient targetInstanceClient = TargetInstanceClient.create()) {
   ProjectZoneTargetInstanceName targetInstance = ProjectZoneTargetInstanceName.of("[PROJECT]", "[ZONE]", "[TARGET_INSTANCE]");
   TargetInstance response = targetInstanceClient.getTargetInstance(targetInstance.toString());
 }

Parameters:: targetInstance - Name of the TargetInstance resource to return.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getTargetInstance

@BetaApi
public final TargetInstance getTargetInstance(GetTargetInstanceHttpRequest request)

Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request.

Sample code:


 try (TargetInstanceClient targetInstanceClient = TargetInstanceClient.create()) {
   String formattedTargetInstance = ProjectZoneTargetInstanceName.format("[PROJECT]", "[ZONE]", "[TARGET_INSTANCE]");
   GetTargetInstanceHttpRequest request = GetTargetInstanceHttpRequest.newBuilder()
     .setTargetInstance(formattedTargetInstance)
     .build();
   TargetInstance response = targetInstanceClient.getTargetInstance(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

getTargetInstanceCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<GetTargetInstanceHttpRequest,TargetInstance> getTargetInstanceCallable()

Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request.

Sample code:


 try (TargetInstanceClient targetInstanceClient = TargetInstanceClient.create()) {
   String formattedTargetInstance = ProjectZoneTargetInstanceName.format("[PROJECT]", "[ZONE]", "[TARGET_INSTANCE]");
   GetTargetInstanceHttpRequest request = GetTargetInstanceHttpRequest.newBuilder()
     .setTargetInstance(formattedTargetInstance)
     .build();
   ApiFuture<TargetInstance> future = targetInstanceClient.getTargetInstanceCallable().futureCall(request);
   // Do something
   TargetInstance response = future.get();
 }

insertTargetInstance
```
@BetaApi
public final Operation insertTargetInstance(ProjectZoneName zone,
                                                     TargetInstance targetInstanceResource)
```
Creates a TargetInstance resource in the specified project and zone using the data included in the request.
Sample code:
```
 try (TargetInstanceClient targetInstanceClient = TargetInstanceClient.create()) {
   ProjectZoneName zone = ProjectZoneName.of("[PROJECT]", "[ZONE]");
   TargetInstance targetInstanceResource = TargetInstance.newBuilder().build();
   Operation response = targetInstanceClient.insertTargetInstance(zone, targetInstanceResource);
 }
 
```
Parameters:

zone - Name of the zone scoping this request.

targetInstanceResource - Represents a Target Instance resource.
You can use a target instance to handle traffic for one or more forwarding rules, which is ideal for forwarding protocol traffic that is managed by a single source. For example, ESP, AH, TCP, or UDP. For more information, read Target instances. (== resource_for beta.targetInstances ==) (== resource_for v1.targetInstances ==)

Throws:

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

insertTargetInstance
```
@BetaApi
public final Operation insertTargetInstance(String zone,
                                                     TargetInstance targetInstanceResource)
```
Creates a TargetInstance resource in the specified project and zone using the data included in the request.
Sample code:
```
 try (TargetInstanceClient targetInstanceClient = TargetInstanceClient.create()) {
   ProjectZoneName zone = ProjectZoneName.of("[PROJECT]", "[ZONE]");
   TargetInstance targetInstanceResource = TargetInstance.newBuilder().build();
   Operation response = targetInstanceClient.insertTargetInstance(zone.toString(), targetInstanceResource);
 }
 
```
Parameters:

zone - Name of the zone scoping this request.

targetInstanceResource - Represents a Target Instance resource.
You can use a target instance to handle traffic for one or more forwarding rules, which is ideal for forwarding protocol traffic that is managed by a single source. For example, ESP, AH, TCP, or UDP. For more information, read Target instances. (== resource_for beta.targetInstances ==) (== resource_for v1.targetInstances ==)

Throws:

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

insertTargetInstance

@BetaApi
public final Operation insertTargetInstance(InsertTargetInstanceHttpRequest request)

Creates a TargetInstance resource in the specified project and zone using the data included in the request.

Sample code:


 try (TargetInstanceClient targetInstanceClient = TargetInstanceClient.create()) {
   String formattedZone = ProjectZoneName.format("[PROJECT]", "[ZONE]");
   TargetInstance targetInstanceResource = TargetInstance.newBuilder().build();
   InsertTargetInstanceHttpRequest request = InsertTargetInstanceHttpRequest.newBuilder()
     .setZone(formattedZone)
     .setTargetInstanceResource(targetInstanceResource)
     .build();
   Operation response = targetInstanceClient.insertTargetInstance(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

insertTargetInstanceCallable

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

Creates a TargetInstance resource in the specified project and zone using the data included in the request.

Sample code:


 try (TargetInstanceClient targetInstanceClient = TargetInstanceClient.create()) {
   String formattedZone = ProjectZoneName.format("[PROJECT]", "[ZONE]");
   TargetInstance targetInstanceResource = TargetInstance.newBuilder().build();
   InsertTargetInstanceHttpRequest request = InsertTargetInstanceHttpRequest.newBuilder()
     .setZone(formattedZone)
     .setTargetInstanceResource(targetInstanceResource)
     .build();
   ApiFuture<Operation> future = targetInstanceClient.insertTargetInstanceCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }