Class InstancesClient (2.54.0)
Stay organized with collections
Save and categorize content based on your preferences.
- 2.78.0 (latest)
- 2.76.0
- 2.75.0
- 2.74.0
- 2.73.0
- 2.72.0
- 2.70.0
- 2.68.0
- 2.67.0
- 2.64.0
- 2.63.0
- 2.62.0
- 2.60.0
- 2.59.0
- 2.58.0
- 2.57.0
- 2.56.0
- 2.55.0
- 2.54.0
- 2.53.0
- 2.52.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.4
- 2.2.0
- 2.1.10
- 0.2.0
Service Description: Manages instances of a version.
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(InstancesClientinstancesClient=InstancesClient.create()){
GetInstanceRequestrequest=GetInstanceRequest.newBuilder().setName("name3373707").build();
Instanceresponse=instancesClient.getInstance(request);
}
Note: close() needs to be called on the InstancesClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
| Method | Description | Method Variants |
|---|---|---|
ListInstances |
Lists the instances of a version. Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetInstance |
Gets instance information. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteInstance |
Stops a running instance. The instance might be automatically recreated based on the scaling settings of the version. For more information, see "How Instances are Managed" (standard environment | flexible environment). To ensure that instances are not re-created and avoid getting billed, you can stop all instances within the target version by changing the serving status of the version to |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DebugInstance |
Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started. Only applicable for instances in App Engine flexible environment. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return 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 InstancesSettings 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
InstancesSettingsinstancesSettings=
InstancesSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
InstancesClientinstancesClient=InstancesClient.create(instancesSettings);
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
InstancesSettingsinstancesSettings=
InstancesSettings.newBuilder().setEndpoint(myEndpoint).build();
InstancesClientinstancesClient=InstancesClient.create(instancesSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// 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
InstancesSettingsinstancesSettings=InstancesSettings.newHttpJsonBuilder().build();
InstancesClientinstancesClient=InstancesClient.create(instancesSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
publicstaticfinalInstancesClientcreate()Constructs an instance of InstancesClient with default settings.
| Returns | |
|---|---|
| Type | Description |
InstancesClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(InstancesSettings settings)
publicstaticfinalInstancesClientcreate(InstancesSettingssettings)Constructs an instance of InstancesClient, 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 |
InstancesSettings |
| Returns | |
|---|---|
| Type | Description |
InstancesClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(InstancesStub stub)
publicstaticfinalInstancesClientcreate(InstancesStubstub)Constructs an instance of InstancesClient, using the given stub for making calls. This is for advanced usage - prefer using create(InstancesSettings).
| Parameter | |
|---|---|
| Name | Description |
stub |
InstancesStub |
| Returns | |
|---|---|
| Type | Description |
InstancesClient |
|
Constructors
InstancesClient(InstancesSettings settings)
protectedInstancesClient(InstancesSettingssettings)Constructs an instance of InstancesClient, 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 |
InstancesSettings |
InstancesClient(InstancesStub stub)
protectedInstancesClient(InstancesStubstub)| Parameter | |
|---|---|
| Name | Description |
stub |
InstancesStub |
Methods
awaitTermination(long duration, TimeUnit unit)
publicbooleanawaitTermination(longduration,TimeUnitunit)| Parameters | |
|---|---|
| Name | Description |
duration |
long |
unit |
TimeUnit |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
| Exceptions | |
|---|---|
| Type | Description |
InterruptedException |
|
close()
publicfinalvoidclose()debugInstanceAsync(DebugInstanceRequest request)
publicfinalOperationFuture<Instance,OperationMetadataV1>debugInstanceAsync(DebugInstanceRequestrequest)Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.
Only applicable for instances in App Engine flexible environment.
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(InstancesClientinstancesClient=InstancesClient.create()){
DebugInstanceRequestrequest=
DebugInstanceRequest.newBuilder()
.setName("name3373707")
.setSshKey("sshKey-893236425")
.build();
Instanceresponse=instancesClient.debugInstanceAsync(request).get();
}
| Parameter | |
|---|---|
| Name | Description |
request |
DebugInstanceRequest The request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Instance,OperationMetadataV1> |
|
debugInstanceCallable()
publicfinalUnaryCallable<DebugInstanceRequest,Operation>debugInstanceCallable()Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.
Only applicable for instances in App Engine flexible environment.
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(InstancesClientinstancesClient=InstancesClient.create()){
DebugInstanceRequestrequest=
DebugInstanceRequest.newBuilder()
.setName("name3373707")
.setSshKey("sshKey-893236425")
.build();
ApiFuture<Operation>future=instancesClient.debugInstanceCallable().futureCall(request);
// Do something.
Operationresponse=future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<DebugInstanceRequest,Operation> |
|
debugInstanceOperationCallable()
publicfinalOperationCallable<DebugInstanceRequest,Instance,OperationMetadataV1>debugInstanceOperationCallable()Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.
Only applicable for instances in App Engine flexible environment.
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(InstancesClientinstancesClient=InstancesClient.create()){
DebugInstanceRequestrequest=
DebugInstanceRequest.newBuilder()
.setName("name3373707")
.setSshKey("sshKey-893236425")
.build();
OperationFuture<Instance,OperationMetadataV1>future=
instancesClient.debugInstanceOperationCallable().futureCall(request);
// Do something.
Instanceresponse=future.get();
}
| Returns | |
|---|---|
| Type | Description |
OperationCallable<DebugInstanceRequest,Instance,OperationMetadataV1> |
|
deleteInstanceAsync(DeleteInstanceRequest request)
publicfinalOperationFuture<Empty,OperationMetadataV1>deleteInstanceAsync(DeleteInstanceRequestrequest)Stops a running instance.
The instance might be automatically recreated based on the scaling settings of the version. For more information, see "How Instances are Managed" (standard environment | flexible environment).
To ensure that instances are not re-created and avoid getting billed, you can stop all
instances within the target version by changing the serving status of the version to STOPPED
with the
apps.services.versions.patch
method.
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(InstancesClientinstancesClient=InstancesClient.create()){
DeleteInstanceRequestrequest=
DeleteInstanceRequest.newBuilder().setName("name3373707").build();
instancesClient.deleteInstanceAsync(request).get();
}
| Parameter | |
|---|---|
| Name | Description |
request |
DeleteInstanceRequest The request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Empty,OperationMetadataV1> |
|
deleteInstanceCallable()
publicfinalUnaryCallable<DeleteInstanceRequest,Operation>deleteInstanceCallable()Stops a running instance.
The instance might be automatically recreated based on the scaling settings of the version. For more information, see "How Instances are Managed" (standard environment | flexible environment).
To ensure that instances are not re-created and avoid getting billed, you can stop all
instances within the target version by changing the serving status of the version to STOPPED
with the
apps.services.versions.patch
method.
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(InstancesClientinstancesClient=InstancesClient.create()){
DeleteInstanceRequestrequest=
DeleteInstanceRequest.newBuilder().setName("name3373707").build();
ApiFuture<Operation>future=instancesClient.deleteInstanceCallable().futureCall(request);
// Do something.
future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<DeleteInstanceRequest,Operation> |
|
deleteInstanceOperationCallable()
publicfinalOperationCallable<DeleteInstanceRequest,Empty,OperationMetadataV1>deleteInstanceOperationCallable()Stops a running instance.
The instance might be automatically recreated based on the scaling settings of the version. For more information, see "How Instances are Managed" (standard environment | flexible environment).
To ensure that instances are not re-created and avoid getting billed, you can stop all
instances within the target version by changing the serving status of the version to STOPPED
with the
apps.services.versions.patch
method.
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(InstancesClientinstancesClient=InstancesClient.create()){
DeleteInstanceRequestrequest=
DeleteInstanceRequest.newBuilder().setName("name3373707").build();
OperationFuture<Empty,OperationMetadataV1>future=
instancesClient.deleteInstanceOperationCallable().futureCall(request);
// Do something.
future.get();
}
| Returns | |
|---|---|
| Type | Description |
OperationCallable<DeleteInstanceRequest,Empty,OperationMetadataV1> |
|
getHttpJsonOperationsClient()
publicfinalOperationsClientgetHttpJsonOperationsClient()Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
| Returns | |
|---|---|
| Type | Description |
OperationsClient |
|
getInstance(GetInstanceRequest request)
publicfinalInstancegetInstance(GetInstanceRequestrequest)Gets instance information.
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(InstancesClientinstancesClient=InstancesClient.create()){
GetInstanceRequestrequest=GetInstanceRequest.newBuilder().setName("name3373707").build();
Instanceresponse=instancesClient.getInstance(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
GetInstanceRequest The request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
Instance |
|
getInstanceCallable()
publicfinalUnaryCallable<GetInstanceRequest,Instance>getInstanceCallable()Gets instance information.
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(InstancesClientinstancesClient=InstancesClient.create()){
GetInstanceRequestrequest=GetInstanceRequest.newBuilder().setName("name3373707").build();
ApiFuture<Instance>future=instancesClient.getInstanceCallable().futureCall(request);
// Do something.
Instanceresponse=future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<GetInstanceRequest,Instance> |
|
getOperationsClient()
publicfinalOperationsClientgetOperationsClient()Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
| Returns | |
|---|---|
| Type | Description |
OperationsClient |
|
getSettings()
publicfinalInstancesSettingsgetSettings()| Returns | |
|---|---|
| Type | Description |
InstancesSettings |
|
getStub()
publicInstancesStubgetStub()| Returns | |
|---|---|
| Type | Description |
InstancesStub |
|
isShutdown()
publicbooleanisShutdown()| Returns | |
|---|---|
| Type | Description |
boolean |
|
isTerminated()
publicbooleanisTerminated()| Returns | |
|---|---|
| Type | Description |
boolean |
|
listInstances(ListInstancesRequest request)
publicfinalInstancesClient.ListInstancesPagedResponselistInstances(ListInstancesRequestrequest)Lists the instances of a version.
Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API.
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(InstancesClientinstancesClient=InstancesClient.create()){
ListInstancesRequestrequest=
ListInstancesRequest.newBuilder()
.setParent("parent-995424086")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for(Instanceelement:instancesClient.listInstances(request).iterateAll()){
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
request |
ListInstancesRequest The request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
InstancesClient.ListInstancesPagedResponse |
|
listInstancesCallable()
publicfinalUnaryCallable<ListInstancesRequest,ListInstancesResponse>listInstancesCallable()Lists the instances of a version.
Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API.
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(InstancesClientinstancesClient=InstancesClient.create()){
ListInstancesRequestrequest=
ListInstancesRequest.newBuilder()
.setParent("parent-995424086")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while(true){
ListInstancesResponseresponse=instancesClient.listInstancesCallable().call(request);
for(Instanceelement:response.getInstancesList()){
// doThingsWith(element);
}
StringnextPageToken=response.getNextPageToken();
if(!Strings.isNullOrEmpty(nextPageToken)){
request=request.toBuilder().setPageToken(nextPageToken).build();
}else{
break;
}
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListInstancesRequest,ListInstancesResponse> |
|
listInstancesPagedCallable()
publicfinalUnaryCallable<ListInstancesRequest,InstancesClient.ListInstancesPagedResponse>listInstancesPagedCallable()Lists the instances of a version.
Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API.
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(InstancesClientinstancesClient=InstancesClient.create()){
ListInstancesRequestrequest=
ListInstancesRequest.newBuilder()
.setParent("parent-995424086")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Instance>future=instancesClient.listInstancesPagedCallable().futureCall(request);
// Do something.
for(Instanceelement:future.get().iterateAll()){
// doThingsWith(element);
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListInstancesRequest,ListInstancesPagedResponse> |
|
shutdown()
publicvoidshutdown()shutdownNow()
publicvoidshutdownNow()