Class TargetInstancesClient
- java.lang.Object
-
- com.google.cloud.compute.v1.TargetInstancesClient
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource
,AutoCloseable
@Generated("by gapic-generator-java") public class TargetInstancesClient extends Object implements com.google.api.gax.core.BackgroundResource
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().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of 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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
TargetInstancesClient.AggregatedListFixedSizeCollection
static class
TargetInstancesClient.AggregatedListPage
static class
TargetInstancesClient.AggregatedListPagedResponse
static class
TargetInstancesClient.ListFixedSizeCollection
static class
TargetInstancesClient.ListPage
static class
TargetInstancesClient.ListPagedResponse
-
Constructor Summary
Constructors Modifier Constructor Description protected
TargetInstancesClient(TargetInstancesStub stub)
protected
TargetInstancesClient(TargetInstancesSettings settings)
Constructs an instance of TargetInstancesClient, using the given settings.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description TargetInstancesClient.AggregatedListPagedResponse
aggregatedList(AggregatedListTargetInstancesRequest request)
Retrieves an aggregated list of target instances.TargetInstancesClient.AggregatedListPagedResponse
aggregatedList(String project)
Retrieves an aggregated list of target instances.com.google.api.gax.rpc.UnaryCallable<AggregatedListTargetInstancesRequest,TargetInstanceAggregatedList>
aggregatedListCallable()
Retrieves an aggregated list of target instances.com.google.api.gax.rpc.UnaryCallable<AggregatedListTargetInstancesRequest,TargetInstancesClient.AggregatedListPagedResponse>
aggregatedListPagedCallable()
Retrieves an aggregated list of target instances.boolean
awaitTermination(long duration, TimeUnit unit)
void
close()
static TargetInstancesClient
create()
Constructs an instance of TargetInstancesClient with default settings.static TargetInstancesClient
create(TargetInstancesStub stub)
Constructs an instance of TargetInstancesClient, using the given stub for making calls.static TargetInstancesClient
create(TargetInstancesSettings settings)
Constructs an instance of TargetInstancesClient, using the given settings.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
deleteAsync(DeleteTargetInstanceRequest request)
Deletes the specified TargetInstance resource.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
deleteAsync(String project, String zone, String targetInstance)
Deletes the specified TargetInstance resource.com.google.api.gax.rpc.UnaryCallable<DeleteTargetInstanceRequest,Operation>
deleteCallable()
Deletes the specified TargetInstance resource.com.google.api.gax.rpc.OperationCallable<DeleteTargetInstanceRequest,Operation,Operation>
deleteOperationCallable()
Deletes the specified TargetInstance resource.TargetInstance
get(GetTargetInstanceRequest request)
Returns the specified TargetInstance resource.TargetInstance
get(String project, String zone, String targetInstance)
Returns the specified TargetInstance resource.com.google.api.gax.rpc.UnaryCallable<GetTargetInstanceRequest,TargetInstance>
getCallable()
Returns the specified TargetInstance resource.TargetInstancesSettings
getSettings()
TargetInstancesStub
getStub()
com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
insertAsync(InsertTargetInstanceRequest request)
Creates a TargetInstance resource in the specified project and zone using the data included in the request.com.google.api.gax.longrunning.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.com.google.api.gax.rpc.UnaryCallable<InsertTargetInstanceRequest,Operation>
insertCallable()
Creates a TargetInstance resource in the specified project and zone using the data included in the request.com.google.api.gax.rpc.OperationCallable<InsertTargetInstanceRequest,Operation,Operation>
insertOperationCallable()
Creates a TargetInstance resource in the specified project and zone using the data included in the request.boolean
isShutdown()
boolean
isTerminated()
TargetInstancesClient.ListPagedResponse
list(ListTargetInstancesRequest request)
Retrieves a list of TargetInstance resources available to the specified project and zone.TargetInstancesClient.ListPagedResponse
list(String project, String zone)
Retrieves a list of TargetInstance resources available to the specified project and zone.com.google.api.gax.rpc.UnaryCallable<ListTargetInstancesRequest,TargetInstanceList>
listCallable()
Retrieves a list of TargetInstance resources available to the specified project and zone.com.google.api.gax.rpc.UnaryCallable<ListTargetInstancesRequest,TargetInstancesClient.ListPagedResponse>
listPagedCallable()
Retrieves a list of TargetInstance resources available to the specified project and zone.void
shutdown()
void
shutdownNow()
-
-
-
Constructor Detail
-
TargetInstancesClient
protected TargetInstancesClient(TargetInstancesSettings settings) throws IOException
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.- Throws:
IOException
-
TargetInstancesClient
protected TargetInstancesClient(TargetInstancesStub stub)
-
-
Method Detail
-
create
public static final TargetInstancesClient create() throws IOException
Constructs an instance of TargetInstancesClient with default settings.- Throws:
IOException
-
create
public static final TargetInstancesClient create(TargetInstancesSettings settings) throws IOException
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.- Throws:
IOException
-
create
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).
-
getSettings
public final TargetInstancesSettings getSettings()
-
getStub
public TargetInstancesStub getStub()
-
aggregatedList
public final TargetInstancesClient.AggregatedListPagedResponse aggregatedList(String project)
Retrieves an aggregated list of target instances.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); } }
- Parameters:
project
- Project ID for this request.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
aggregatedList
public final TargetInstancesClient.AggregatedListPagedResponse aggregatedList(AggregatedListTargetInstancesRequest request)
Retrieves an aggregated list of target instances.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) .build(); for (Map.Entry<String, TargetInstancesScopedList> element : targetInstancesClient.aggregatedList(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
-
aggregatedListPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<AggregatedListTargetInstancesRequest,TargetInstancesClient.AggregatedListPagedResponse> aggregatedListPagedCallable()
Retrieves an aggregated list of target instances.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) .build(); ApiFuture<Map.Entry<String, TargetInstancesScopedList>> future = targetInstancesClient.aggregatedListPagedCallable().futureCall(request); // Do something. for (Map.Entry<String, TargetInstancesScopedList> element : future.get().iterateAll()) { // doThingsWith(element); } }
-
aggregatedListCallable
public final com.google.api.gax.rpc.UnaryCallable<AggregatedListTargetInstancesRequest,TargetInstanceAggregatedList> aggregatedListCallable()
Retrieves an aggregated list of target instances.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) .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; } } }
-
deleteAsync
public final com.google.api.gax.longrunning.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:
project
- Project ID for this request.zone
- Name of the zone scoping this request.targetInstance
- Name of the TargetInstance resource to delete.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteAsync
@BetaApi("The surface for long-running operations is not stable yet and may change in the future.") public final com.google.api.gax.longrunning.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(); }
- 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
-
deleteOperationCallable
public final com.google.api.gax.rpc.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(); }
-
deleteCallable
public final com.google.api.gax.rpc.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(); }
-
get
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:
project
- Project ID for this request.zone
- Name of the zone scoping this request.targetInstance
- Name of the TargetInstance resource to return.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
get
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); }
- 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
-
getCallable
public final com.google.api.gax.rpc.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(); }
-
insertAsync
public final com.google.api.gax.longrunning.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:
project
- Project ID for this request.zone
- Name of the zone scoping this request.targetInstanceResource
- The body resource for this request- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
insertAsync
@BetaApi("The surface for long-running operations is not stable yet and may change in the future.") public final com.google.api.gax.longrunning.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(); }
- 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
-
insertOperationCallable
public final com.google.api.gax.rpc.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(); }
-
insertCallable
public final com.google.api.gax.rpc.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(); }
-
list
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:
project
- Project ID for this request.zone
- Name of the zone scoping this request.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
list
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); } }
- 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
-
listPagedCallable
public final com.google.api.gax.rpc.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); } }
-
listCallable
public final com.google.api.gax.rpc.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; } } }
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
shutdown
public void shutdown()
- Specified by:
shutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isShutdown
public boolean isShutdown()
- Specified by:
isShutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isTerminated
public boolean isTerminated()
- Specified by:
isTerminated
in interfacecom.google.api.gax.core.BackgroundResource
-
shutdownNow
public void shutdownNow()
- Specified by:
shutdownNow
in interfacecom.google.api.gax.core.BackgroundResource
-
awaitTermination
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
- Specified by:
awaitTermination
in interfacecom.google.api.gax.core.BackgroundResource
- Throws:
InterruptedException
-
-