Class TargetInstancesClient (1.61.0)

GitHub RepositoryProduct Reference

Service Description: The TargetInstances 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 (TargetInstancesClient targetInstancesClient = TargetInstancesClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String targetInstance = "targetInstance-1036957370";
   TargetInstance response = targetInstancesClient.get(project, zone, targetInstance);
 }

Note: close() needs to be called on the TargetInstancesClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method Description Method Variants

AggregatedList

Retrieves an aggregated list of target instances. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • aggregatedList(AggregatedListTargetInstancesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • aggregatedList(String project)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • aggregatedListPagedCallable()

  • aggregatedListCallable()

Delete

Deletes the specified TargetInstance resource.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteAsync(DeleteTargetInstanceRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteAsync(String project, String zone, String targetInstance)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteOperationCallable()

  • deleteCallable()

Get

Returns the specified TargetInstance resource.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • get(GetTargetInstanceRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • get(String project, String zone, String targetInstance)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getCallable()

Insert

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • insertAsync(InsertTargetInstanceRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • insertAsync(String project, String zone, TargetInstance targetInstanceResource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • insertOperationCallable()

  • insertCallable()

List

Retrieves a list of TargetInstance resources available to the specified project and zone.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • list(ListTargetInstancesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • list(String project, String zone)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listPagedCallable()

  • listCallable()

SetSecurityPolicy

Sets the Google Cloud Armor security policy for the specified target instance. For more information, see Google Cloud Armor Overview

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • setSecurityPolicyAsync(SetSecurityPolicyTargetInstanceRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • setSecurityPolicyAsync(String project, String zone, String targetInstance, SecurityPolicyReference securityPolicyReferenceResource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • setSecurityPolicyOperationCallable()

  • setSecurityPolicyCallable()

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 TargetInstancesSettings 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
 TargetInstancesSettings targetInstancesSettings =
     TargetInstancesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 TargetInstancesClient targetInstancesClient =
     TargetInstancesClient.create(targetInstancesSettings);

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
 TargetInstancesSettings targetInstancesSettings =
     TargetInstancesSettings.newBuilder().setEndpoint(myEndpoint).build();
 TargetInstancesClient targetInstancesClient =
     TargetInstancesClient.create(targetInstancesSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > TargetInstancesClient

Static Methods

create()

public static final TargetInstancesClient create()

Constructs an instance of TargetInstancesClient with default settings.

Returns
Type Description
TargetInstancesClient
Exceptions
Type Description
IOException

create(TargetInstancesSettings settings)

public static final TargetInstancesClient create(TargetInstancesSettings settings)

Constructs an instance of TargetInstancesClient, 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 TargetInstancesSettings
Returns
Type Description
TargetInstancesClient
Exceptions
Type Description
IOException

create(TargetInstancesStub stub)

public static final TargetInstancesClient create(TargetInstancesStub stub)

Constructs an instance of TargetInstancesClient, using the given stub for making calls. This is for advanced usage - prefer using create(TargetInstancesSettings).

Parameter
Name Description
stub TargetInstancesStub
Returns
Type Description
TargetInstancesClient

Constructors

TargetInstancesClient(TargetInstancesSettings settings)

protected TargetInstancesClient(TargetInstancesSettings settings)

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

TargetInstancesClient(TargetInstancesStub stub)

protected TargetInstancesClient(TargetInstancesStub stub)
Parameter
Name Description
stub TargetInstancesStub

Methods

aggregatedList(AggregatedListTargetInstancesRequest request)

public final TargetInstancesClient.AggregatedListPagedResponse aggregatedList(AggregatedListTargetInstancesRequest request)

Retrieves an aggregated list of target instances. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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 (TargetInstancesClient targetInstancesClient = TargetInstancesClient.create()) {
   AggregatedListTargetInstancesRequest request =
       AggregatedListTargetInstancesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setServiceProjectNumber(-1293855239)
           .build();
   for (Map.Entry<String, TargetInstancesScopedList> element :
       targetInstancesClient.aggregatedList(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request AggregatedListTargetInstancesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
TargetInstancesClient.AggregatedListPagedResponse

aggregatedList(String project)

public final TargetInstancesClient.AggregatedListPagedResponse aggregatedList(String project)

Retrieves an aggregated list of target instances. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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 (TargetInstancesClient targetInstancesClient = TargetInstancesClient.create()) {
   String project = "project-309310695";
   for (Map.Entry<String, TargetInstancesScopedList> element :
       targetInstancesClient.aggregatedList(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
project String

Project ID for this request.
Returns
Type Description
TargetInstancesClient.AggregatedListPagedResponse

aggregatedListCallable()

public final UnaryCallable<AggregatedListTargetInstancesRequest,TargetInstanceAggregatedList> aggregatedListCallable()

Retrieves an aggregated list of target instances. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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 (TargetInstancesClient targetInstancesClient = TargetInstancesClient.create()) {
   AggregatedListTargetInstancesRequest request =
       AggregatedListTargetInstancesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setServiceProjectNumber(-1293855239)
           .build();
   while (true) {
     TargetInstanceAggregatedList response =
         targetInstancesClient.aggregatedListCallable().call(request);
     for (Map.Entry<String, TargetInstancesScopedList> 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<AggregatedListTargetInstancesRequest,TargetInstanceAggregatedList>

aggregatedListPagedCallable()

public final UnaryCallable<AggregatedListTargetInstancesRequest,TargetInstancesClient.AggregatedListPagedResponse> aggregatedListPagedCallable()

Retrieves an aggregated list of target instances. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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 (TargetInstancesClient targetInstancesClient = TargetInstancesClient.create()) {
   AggregatedListTargetInstancesRequest request =
       AggregatedListTargetInstancesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setServiceProjectNumber(-1293855239)
           .build();
   ApiFuture<Map.Entry<String, TargetInstancesScopedList>> future =
       targetInstancesClient.aggregatedListPagedCallable().futureCall(request);
   // Do something.
   for (Map.Entry<String, TargetInstancesScopedList> element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<AggregatedListTargetInstancesRequest,AggregatedListPagedResponse>

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(DeleteTargetInstanceRequest request)

public final OperationFuture<Operation,Operation> deleteAsync(DeleteTargetInstanceRequest request)

Deletes the specified TargetInstance resource.

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 (TargetInstancesClient targetInstancesClient = TargetInstancesClient.create()) {
   DeleteTargetInstanceRequest request =
       DeleteTargetInstanceRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setTargetInstance("targetInstance-1036957370")
           .setZone("zone3744684")
           .build();
   Operation response = targetInstancesClient.deleteAsync(request).get();
 }
Parameter
Name Description
request DeleteTargetInstanceRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

deleteAsync(String project, String zone, String targetInstance)

public final OperationFuture<Operation,Operation> deleteAsync(String project, String zone, String targetInstance)

Deletes the specified TargetInstance resource.

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 (TargetInstancesClient targetInstancesClient = TargetInstancesClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String targetInstance = "targetInstance-1036957370";
   Operation response = targetInstancesClient.deleteAsync(project, zone, targetInstance).get();
 }
Parameters
Name Description
project String

Project ID for this request.
zone String

Name of the zone scoping this request.
targetInstance String

Name of the TargetInstance resource to delete.
Returns
Type Description
OperationFuture<Operation,Operation>

deleteCallable()

public final UnaryCallable<DeleteTargetInstanceRequest,Operation> deleteCallable()

Deletes the specified TargetInstance resource.

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 (TargetInstancesClient targetInstancesClient = TargetInstancesClient.create()) {
   DeleteTargetInstanceRequest request =
       DeleteTargetInstanceRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setTargetInstance("targetInstance-1036957370")
           .setZone("zone3744684")
           .build();
   ApiFuture<Operation> future = targetInstancesClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<DeleteTargetInstanceRequest,Operation>

deleteOperationCallable()

public final OperationCallable<DeleteTargetInstanceRequest,Operation,Operation> deleteOperationCallable()

Deletes the specified TargetInstance resource.

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 (TargetInstancesClient targetInstancesClient = TargetInstancesClient.create()) {
   DeleteTargetInstanceRequest request =
       DeleteTargetInstanceRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setTargetInstance("targetInstance-1036957370")
           .setZone("zone3744684")
           .build();
   OperationFuture<Operation, Operation> future =
       targetInstancesClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<DeleteTargetInstanceRequest,Operation,Operation>

get(GetTargetInstanceRequest request)

public final TargetInstance get(GetTargetInstanceRequest request)

Returns the specified TargetInstance resource.

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 (TargetInstancesClient targetInstancesClient = TargetInstancesClient.create()) {
   GetTargetInstanceRequest request =
       GetTargetInstanceRequest.newBuilder()
           .setProject("project-309310695")
           .setTargetInstance("targetInstance-1036957370")
           .setZone("zone3744684")
           .build();
   TargetInstance response = targetInstancesClient.get(request);
 }
Parameter
Name Description
request GetTargetInstanceRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
TargetInstance

get(String project, String zone, String targetInstance)

public final TargetInstance get(String project, String zone, String targetInstance)

Returns the specified TargetInstance resource.

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 (TargetInstancesClient targetInstancesClient = TargetInstancesClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String targetInstance = "targetInstance-1036957370";
   TargetInstance response = targetInstancesClient.get(project, zone, targetInstance);
 }
Parameters
Name Description
project String

Project ID for this request.
zone String

Name of the zone scoping this request.
targetInstance String

Name of the TargetInstance resource to return.
Returns
Type Description
TargetInstance

getCallable()

public final UnaryCallable<GetTargetInstanceRequest,TargetInstance> getCallable()

Returns the specified TargetInstance resource.

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 (TargetInstancesClient targetInstancesClient = TargetInstancesClient.create()) {
   GetTargetInstanceRequest request =
       GetTargetInstanceRequest.newBuilder()
           .setProject("project-309310695")
           .setTargetInstance("targetInstance-1036957370")
           .setZone("zone3744684")
           .build();
   ApiFuture<TargetInstance> future = targetInstancesClient.getCallable().futureCall(request);
   // Do something.
   TargetInstance response = future.get();
 }
Returns
Type Description
UnaryCallable<GetTargetInstanceRequest,TargetInstance>

getSettings()

public final TargetInstancesSettings getSettings()
Returns
Type Description
TargetInstancesSettings

getStub()

public TargetInstancesStub getStub()
Returns
Type Description
TargetInstancesStub

insertAsync(InsertTargetInstanceRequest request)

public final OperationFuture<Operation,Operation> insertAsync(InsertTargetInstanceRequest request)

Creates a TargetInstance resource in the specified project and zone using the data 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 (TargetInstancesClient targetInstancesClient = TargetInstancesClient.create()) {
   InsertTargetInstanceRequest request =
       InsertTargetInstanceRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setTargetInstanceResource(TargetInstance.newBuilder().build())
           .setZone("zone3744684")
           .build();
   Operation response = targetInstancesClient.insertAsync(request).get();
 }
Parameter
Name Description
request InsertTargetInstanceRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

insertAsync(String project, String zone, TargetInstance targetInstanceResource)

public final OperationFuture<Operation,Operation> insertAsync(String project, String zone, TargetInstance targetInstanceResource)

Creates a TargetInstance resource in the specified project and zone using the data 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 (TargetInstancesClient targetInstancesClient = TargetInstancesClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   TargetInstance targetInstanceResource = TargetInstance.newBuilder().build();
   Operation response =
       targetInstancesClient.insertAsync(project, zone, targetInstanceResource).get();
 }
Parameters
Name Description
project String

Project ID for this request.
zone String

Name of the zone scoping this request.
targetInstanceResource TargetInstance

The body resource for this request
Returns
Type Description
OperationFuture<Operation,Operation>

insertCallable()

public final UnaryCallable<InsertTargetInstanceRequest,Operation> insertCallable()

Creates a TargetInstance resource in the specified project and zone using the data 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 (TargetInstancesClient targetInstancesClient = TargetInstancesClient.create()) {
   InsertTargetInstanceRequest request =
       InsertTargetInstanceRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setTargetInstanceResource(TargetInstance.newBuilder().build())
           .setZone("zone3744684")
           .build();
   ApiFuture<Operation> future = targetInstancesClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<InsertTargetInstanceRequest,Operation>

insertOperationCallable()

public final OperationCallable<InsertTargetInstanceRequest,Operation,Operation> insertOperationCallable()

Creates a TargetInstance resource in the specified project and zone using the data 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 (TargetInstancesClient targetInstancesClient = TargetInstancesClient.create()) {
   InsertTargetInstanceRequest request =
       InsertTargetInstanceRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setTargetInstanceResource(TargetInstance.newBuilder().build())
           .setZone("zone3744684")
           .build();
   OperationFuture<Operation, Operation> future =
       targetInstancesClient.insertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<InsertTargetInstanceRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

list(ListTargetInstancesRequest request)

public final TargetInstancesClient.ListPagedResponse list(ListTargetInstancesRequest request)

Retrieves a list of TargetInstance resources available to the specified project and zone.

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 (TargetInstancesClient targetInstancesClient = TargetInstancesClient.create()) {
   ListTargetInstancesRequest request =
       ListTargetInstancesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   for (TargetInstance element : targetInstancesClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListTargetInstancesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
TargetInstancesClient.ListPagedResponse

list(String project, String zone)

public final TargetInstancesClient.ListPagedResponse list(String project, String zone)

Retrieves a list of TargetInstance resources available to the specified project and zone.

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 (TargetInstancesClient targetInstancesClient = TargetInstancesClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   for (TargetInstance element : targetInstancesClient.list(project, zone).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameters
Name Description
project String

Project ID for this request.
zone String

Name of the zone scoping this request.
Returns
Type Description
TargetInstancesClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListTargetInstancesRequest,TargetInstanceList> listCallable()

Retrieves a list of TargetInstance resources available to the specified project and zone.

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 (TargetInstancesClient targetInstancesClient = TargetInstancesClient.create()) {
   ListTargetInstancesRequest request =
       ListTargetInstancesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   while (true) {
     TargetInstanceList response = targetInstancesClient.listCallable().call(request);
     for (TargetInstance 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<ListTargetInstancesRequest,TargetInstanceList>

listPagedCallable()

public final UnaryCallable<ListTargetInstancesRequest,TargetInstancesClient.ListPagedResponse> listPagedCallable()

Retrieves a list of TargetInstance resources available to the specified project and zone.

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 (TargetInstancesClient targetInstancesClient = TargetInstancesClient.create()) {
   ListTargetInstancesRequest request =
       ListTargetInstancesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   ApiFuture<TargetInstance> future =
       targetInstancesClient.listPagedCallable().futureCall(request);
   // Do something.
   for (TargetInstance element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListTargetInstancesRequest,ListPagedResponse>

setSecurityPolicyAsync(SetSecurityPolicyTargetInstanceRequest request)

public final OperationFuture<Operation,Operation> setSecurityPolicyAsync(SetSecurityPolicyTargetInstanceRequest request)

Sets the Google Cloud Armor security policy for the specified target instance. For more information, see Google Cloud Armor Overview

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 (TargetInstancesClient targetInstancesClient = TargetInstancesClient.create()) {
   SetSecurityPolicyTargetInstanceRequest request =
       SetSecurityPolicyTargetInstanceRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSecurityPolicyReferenceResource(SecurityPolicyReference.newBuilder().build())
           .setTargetInstance("targetInstance-1036957370")
           .setZone("zone3744684")
           .build();
   Operation response = targetInstancesClient.setSecurityPolicyAsync(request).get();
 }
Parameter
Name Description
request SetSecurityPolicyTargetInstanceRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

setSecurityPolicyAsync(String project, String zone, String targetInstance, SecurityPolicyReference securityPolicyReferenceResource)

public final OperationFuture<Operation,Operation> setSecurityPolicyAsync(String project, String zone, String targetInstance, SecurityPolicyReference securityPolicyReferenceResource)

Sets the Google Cloud Armor security policy for the specified target instance. For more information, see Google Cloud Armor Overview

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 (TargetInstancesClient targetInstancesClient = TargetInstancesClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String targetInstance = "targetInstance-1036957370";
   SecurityPolicyReference securityPolicyReferenceResource =
       SecurityPolicyReference.newBuilder().build();
   Operation response =
       targetInstancesClient
           .setSecurityPolicyAsync(
               project, zone, targetInstance, securityPolicyReferenceResource)
           .get();
 }
Parameters
Name Description
project String

Project ID for this request.
zone String

Name of the zone scoping this request.
targetInstance String

Name of the TargetInstance resource to which the security policy should be set. The name should conform to RFC1035.
securityPolicyReferenceResource SecurityPolicyReference

The body resource for this request
Returns
Type Description
OperationFuture<Operation,Operation>

setSecurityPolicyCallable()

public final UnaryCallable<SetSecurityPolicyTargetInstanceRequest,Operation> setSecurityPolicyCallable()

Sets the Google Cloud Armor security policy for the specified target instance. For more information, see Google Cloud Armor Overview

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 (TargetInstancesClient targetInstancesClient = TargetInstancesClient.create()) {
   SetSecurityPolicyTargetInstanceRequest request =
       SetSecurityPolicyTargetInstanceRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSecurityPolicyReferenceResource(SecurityPolicyReference.newBuilder().build())
           .setTargetInstance("targetInstance-1036957370")
           .setZone("zone3744684")
           .build();
   ApiFuture<Operation> future =
       targetInstancesClient.setSecurityPolicyCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<SetSecurityPolicyTargetInstanceRequest,Operation>

setSecurityPolicyOperationCallable()

public final OperationCallable<SetSecurityPolicyTargetInstanceRequest,Operation,Operation> setSecurityPolicyOperationCallable()

Sets the Google Cloud Armor security policy for the specified target instance. For more information, see Google Cloud Armor Overview

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 (TargetInstancesClient targetInstancesClient = TargetInstancesClient.create()) {
   SetSecurityPolicyTargetInstanceRequest request =
       SetSecurityPolicyTargetInstanceRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSecurityPolicyReferenceResource(SecurityPolicyReference.newBuilder().build())
           .setTargetInstance("targetInstance-1036957370")
           .setZone("zone3744684")
           .build();
   OperationFuture<Operation, Operation> future =
       targetInstancesClient.setSecurityPolicyOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<SetSecurityPolicyTargetInstanceRequest,Operation,Operation>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()