- 1.57.0 (latest)
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
public class TargetInstancesClient implements 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 for illustrative purposes only.
// It may require modifications to work in your environment.
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 for illustrative purposes only.
// It may require modifications to work in your environment.
TargetInstancesSettings targetInstancesSettings =
TargetInstancesSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
TargetInstancesClient targetInstancesClient =
TargetInstancesClient.create(targetInstancesSettings);
To customize the endpoint:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
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.
Implements
BackgroundResourceStatic Methods
create()
public static final TargetInstancesClient create()
Constructs an instance of TargetInstancesClient with default settings.
Type | Description |
TargetInstancesClient |
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.
Name | Description |
settings | TargetInstancesSettings |
Type | Description |
TargetInstancesClient |
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).
Name | Description |
stub | TargetInstancesStub |
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.
Name | Description |
settings | TargetInstancesSettings |
TargetInstancesClient(TargetInstancesStub stub)
protected TargetInstancesClient(TargetInstancesStub stub)
Name | Description |
stub | TargetInstancesStub |
Methods
aggregatedList(AggregatedListTargetInstancesRequest request)
public final TargetInstancesClient.AggregatedListPagedResponse aggregatedList(AggregatedListTargetInstancesRequest request)
Retrieves an aggregated list of target instances.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
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);
}
}
Name | Description |
request | AggregatedListTargetInstancesRequest The request object containing all of the parameters for the API call. |
Type | Description |
TargetInstancesClient.AggregatedListPagedResponse |
aggregatedList(String project)
public final TargetInstancesClient.AggregatedListPagedResponse aggregatedList(String project)
Retrieves an aggregated list of target instances.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (TargetInstancesClient targetInstancesClient = TargetInstancesClient.create()) {
String project = "project-309310695";
for (Map.Entry<String, TargetInstancesScopedList> element :
targetInstancesClient.aggregatedList(project).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
project | String Project ID for this request. |
Type | Description |
TargetInstancesClient.AggregatedListPagedResponse |
aggregatedListCallable()
public final UnaryCallable<AggregatedListTargetInstancesRequest,TargetInstanceAggregatedList> aggregatedListCallable()
Retrieves an aggregated list of target instances.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
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;
}
}
}
Type | Description |
UnaryCallable<AggregatedListTargetInstancesRequest,TargetInstanceAggregatedList> |
aggregatedListPagedCallable()
public final UnaryCallable<AggregatedListTargetInstancesRequest,TargetInstancesClient.AggregatedListPagedResponse> aggregatedListPagedCallable()
Retrieves an aggregated list of target instances.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
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);
}
}
Type | Description |
UnaryCallable<AggregatedListTargetInstancesRequest,AggregatedListPagedResponse> |
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Name | Description |
duration | long |
unit | TimeUnit |
Type | Description |
boolean |
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 for illustrative purposes only.
// It may require modifications to work in your environment.
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();
}
Name | Description |
request | DeleteTargetInstanceRequest The request object containing all of the parameters for the API call. |
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 for illustrative purposes only.
// It may require modifications to work in your environment.
try (TargetInstancesClient targetInstancesClient = TargetInstancesClient.create()) {
String project = "project-309310695";
String zone = "zone3744684";
String targetInstance = "targetInstance-1036957370";
Operation response = targetInstancesClient.deleteAsync(project, zone, targetInstance).get();
}
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. |
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 for illustrative purposes only.
// It may require modifications to work in your environment.
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();
}
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 for illustrative purposes only.
// It may require modifications to work in your environment.
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();
}
Type | Description |
OperationCallable<DeleteTargetInstanceRequest,Operation,Operation> |
get(GetTargetInstanceRequest request)
public final TargetInstance get(GetTargetInstanceRequest request)
Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (TargetInstancesClient targetInstancesClient = TargetInstancesClient.create()) {
GetTargetInstanceRequest request =
GetTargetInstanceRequest.newBuilder()
.setProject("project-309310695")
.setTargetInstance("targetInstance-1036957370")
.setZone("zone3744684")
.build();
TargetInstance response = targetInstancesClient.get(request);
}
Name | Description |
request | GetTargetInstanceRequest The request object containing all of the parameters for the API call. |
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. Gets a list of available target instances by making a list() request.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (TargetInstancesClient targetInstancesClient = TargetInstancesClient.create()) {
String project = "project-309310695";
String zone = "zone3744684";
String targetInstance = "targetInstance-1036957370";
TargetInstance response = targetInstancesClient.get(project, zone, targetInstance);
}
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. |
Type | Description |
TargetInstance |
getCallable()
public final UnaryCallable<GetTargetInstanceRequest,TargetInstance> getCallable()
Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
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();
}
Type | Description |
UnaryCallable<GetTargetInstanceRequest,TargetInstance> |
getSettings()
public final TargetInstancesSettings getSettings()
Type | Description |
TargetInstancesSettings |
getStub()
public TargetInstancesStub getStub()
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 for illustrative purposes only.
// It may require modifications to work in your environment.
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();
}
Name | Description |
request | InsertTargetInstanceRequest The request object containing all of the parameters for the API call. |
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 for illustrative purposes only.
// It may require modifications to work in your environment.
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();
}
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 |
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 for illustrative purposes only.
// It may require modifications to work in your environment.
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();
}
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 for illustrative purposes only.
// It may require modifications to work in your environment.
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();
}
Type | Description |
OperationCallable<InsertTargetInstanceRequest,Operation,Operation> |
isShutdown()
public boolean isShutdown()
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
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 for illustrative purposes only.
// It may require modifications to work in your environment.
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);
}
}
Name | Description |
request | ListTargetInstancesRequest The request object containing all of the parameters for the API call. |
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 for illustrative purposes only.
// It may require modifications to work in your environment.
try (TargetInstancesClient targetInstancesClient = TargetInstancesClient.create()) {
String project = "project-309310695";
String zone = "zone3744684";
for (TargetInstance element : targetInstancesClient.list(project, zone).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
project | String Project ID for this request. |
zone | String Name of the zone scoping this request. |
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 for illustrative purposes only.
// It may require modifications to work in your environment.
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;
}
}
}
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 for illustrative purposes only.
// It may require modifications to work in your environment.
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);
}
}
Type | Description |
UnaryCallable<ListTargetInstancesRequest,ListPagedResponse> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()