Class InstancesClient (0.83.0)

Service Description: The Cloud Run Instances API allows you to manage Cloud Run Instances.

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 (InstancesClient instancesClient = InstancesClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   Instance response = instancesClient.getInstance(name);
 }

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().

Methods
Method	Description	Method Variants
CreateInstance	Creates an Instance.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createInstanceAsync(CreateInstanceRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createInstanceAsync(LocationName parent, Instance instance) createInstanceAsync(String parent, Instance instance) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createInstanceOperationCallable() createInstanceCallable()
DeleteInstance	Deletes a Instance	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteInstanceAsync(DeleteInstanceRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteInstanceAsync(InstanceName name) deleteInstanceAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteInstanceOperationCallable() deleteInstanceCallable()
GetInstance	Gets a Instance	Request object method variants only take one parameter, a request object, which must be constructed before the call. getInstance(GetInstanceRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getInstance(InstanceName name) getInstance(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getInstanceCallable()
ListInstances	Lists Instances. Results are sorted by creation time, descending.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listInstances(ListInstancesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listInstances(LocationName parent) listInstances(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listInstancesPagedCallable() listInstancesCallable()
StopInstance	Stops an Instance.	Request object method variants only take one parameter, a request object, which must be constructed before the call. stopInstanceAsync(StopInstanceRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. stopInstanceAsync(InstanceName name) stopInstanceAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. stopInstanceOperationCallable() stopInstanceCallable()
StartInstance	Starts an Instance.	Request object method variants only take one parameter, a request object, which must be constructed before the call. startInstanceAsync(StartInstanceRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. startInstanceAsync(InstanceName name) startInstanceAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. startInstanceOperationCallable() startInstanceCallable()

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
 InstancesSettings instancesSettings =
     InstancesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 InstancesClient instancesClient = 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
 InstancesSettings instancesSettings =
     InstancesSettings.newBuilder().setEndpoint(myEndpoint).build();
 InstancesClient instancesClient = 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
 InstancesSettings instancesSettings = InstancesSettings.newHttpJsonBuilder().build();
 InstancesClient instancesClient = InstancesClient.create(instancesSettings);

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

Inheritance

java.lang.Object > InstancesClient

Static Methods

create()

public static final InstancesClient create()

Constructs an instance of InstancesClient with default settings.

Returns
Type	Description
`InstancesClient`

Exceptions
Type	Description
`IOException`

create(InstancesSettings settings)

public static final InstancesClient create(InstancesSettings settings)

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)

public static final InstancesClient create(InstancesStub stub)

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)

protected InstancesClient(InstancesSettings settings)

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)

protected InstancesClient(InstancesStub stub)

Parameter
Name	Description
`stub`	`InstancesStub`

Methods

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

createInstanceAsync(CreateInstanceRequest request)

public final OperationFuture<Instance,Instance> createInstanceAsync(CreateInstanceRequest request)

Creates an Instance.

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 (InstancesClient instancesClient = InstancesClient.create()) {
   CreateInstanceRequest request =
       CreateInstanceRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setInstance(Instance.newBuilder().build())
           .setInstanceId("instanceId902024336")
           .setValidateOnly(true)
           .build();
   Instance response = instancesClient.createInstanceAsync(request).get();
 }

Parameter
Name	Description
`request`	`CreateInstanceRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Instance,Instance>`

createInstanceAsync(LocationName parent, Instance instance)

public final OperationFuture<Instance,Instance> createInstanceAsync(LocationName parent, Instance instance)

Creates an Instance.

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 (InstancesClient instancesClient = InstancesClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Instance instance = Instance.newBuilder().build();
   Instance response = instancesClient.createInstanceAsync(parent, instance).get();
 }

Parameters
Name	Description
`parent`	`LocationName`
`instance`	`Instance`

Returns
Type	Description
`OperationFuture<Instance,Instance>`

createInstanceAsync(String parent, Instance instance)

public final OperationFuture<Instance,Instance> createInstanceAsync(String parent, Instance instance)

Creates an Instance.

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 (InstancesClient instancesClient = InstancesClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Instance instance = Instance.newBuilder().build();
   Instance response = instancesClient.createInstanceAsync(parent, instance).get();
 }

Parameters
Name	Description
`parent`	`String`
`instance`	`Instance`

Returns
Type	Description
`OperationFuture<Instance,Instance>`

createInstanceCallable()

public final UnaryCallable<CreateInstanceRequest,Operation> createInstanceCallable()

Creates an Instance.

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 (InstancesClient instancesClient = InstancesClient.create()) {
   CreateInstanceRequest request =
       CreateInstanceRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setInstance(Instance.newBuilder().build())
           .setInstanceId("instanceId902024336")
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future = instancesClient.createInstanceCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateInstanceRequest,Operation>`

createInstanceOperationCallable()

public final OperationCallable<CreateInstanceRequest,Instance,Instance> createInstanceOperationCallable()

Creates an Instance.

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 (InstancesClient instancesClient = InstancesClient.create()) {
   CreateInstanceRequest request =
       CreateInstanceRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setInstance(Instance.newBuilder().build())
           .setInstanceId("instanceId902024336")
           .setValidateOnly(true)
           .build();
   OperationFuture<Instance, Instance> future =
       instancesClient.createInstanceOperationCallable().futureCall(request);
   // Do something.
   Instance response = future.get();
 }

Returns
Type	Description
`OperationCallable<CreateInstanceRequest,Instance,Instance>`

deleteInstanceAsync(DeleteInstanceRequest request)

public final OperationFuture<Instance,Instance> deleteInstanceAsync(DeleteInstanceRequest request)

Deletes a Instance

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 (InstancesClient instancesClient = InstancesClient.create()) {
   DeleteInstanceRequest request =
       DeleteInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .build();
   Instance response = 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<Instance,Instance>`

deleteInstanceAsync(InstanceName name)

public final OperationFuture<Instance,Instance> deleteInstanceAsync(InstanceName name)

Deletes a Instance

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 (InstancesClient instancesClient = InstancesClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   Instance response = instancesClient.deleteInstanceAsync(name).get();
 }

Parameter
Name	Description
`name`	`InstanceName`

Returns
Type	Description
`OperationFuture<Instance,Instance>`

deleteInstanceAsync(String name)

public final OperationFuture<Instance,Instance> deleteInstanceAsync(String name)

Deletes a Instance

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 (InstancesClient instancesClient = InstancesClient.create()) {
   String name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   Instance response = instancesClient.deleteInstanceAsync(name).get();
 }

Parameter
Name	Description
`name`	`String`

Returns
Type	Description
`OperationFuture<Instance,Instance>`

deleteInstanceCallable()

public final UnaryCallable<DeleteInstanceRequest,Operation> deleteInstanceCallable()

Deletes a Instance

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 (InstancesClient instancesClient = InstancesClient.create()) {
   DeleteInstanceRequest request =
       DeleteInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .build();
   ApiFuture<Operation> future = instancesClient.deleteInstanceCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<DeleteInstanceRequest,Operation>`

deleteInstanceOperationCallable()

public final OperationCallable<DeleteInstanceRequest,Instance,Instance> deleteInstanceOperationCallable()

Deletes a Instance

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 (InstancesClient instancesClient = InstancesClient.create()) {
   DeleteInstanceRequest request =
       DeleteInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .build();
   OperationFuture<Instance, Instance> future =
       instancesClient.deleteInstanceOperationCallable().futureCall(request);
   // Do something.
   Instance response = future.get();
 }

Returns
Type	Description
`OperationCallable<DeleteInstanceRequest,Instance,Instance>`

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

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)

public final Instance getInstance(GetInstanceRequest request)

Gets a Instance

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 (InstancesClient instancesClient = InstancesClient.create()) {
   GetInstanceRequest request =
       GetInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .build();
   Instance response = instancesClient.getInstance(request);
 }

Parameter
Name	Description
`request`	`GetInstanceRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Instance`

getInstance(InstanceName name)

public final Instance getInstance(InstanceName name)

Gets a Instance

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 (InstancesClient instancesClient = InstancesClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   Instance response = instancesClient.getInstance(name);
 }

Parameter
Name	Description
`name`	`InstanceName`

Returns
Type	Description
`Instance`

getInstance(String name)

public final Instance getInstance(String name)

Gets a Instance

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 (InstancesClient instancesClient = InstancesClient.create()) {
   String name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   Instance response = instancesClient.getInstance(name);
 }

Parameter
Name	Description
`name`	`String`

Returns
Type	Description
`Instance`

getInstanceCallable()

public final UnaryCallable<GetInstanceRequest,Instance> getInstanceCallable()

Gets a Instance

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 (InstancesClient instancesClient = InstancesClient.create()) {
   GetInstanceRequest request =
       GetInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .build();
   ApiFuture<Instance> future = instancesClient.getInstanceCallable().futureCall(request);
   // Do something.
   Instance response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetInstanceRequest,Instance>`

getOperationsClient()

public final OperationsClient getOperationsClient()

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

public final InstancesSettings getSettings()

Returns
Type	Description
`InstancesSettings`

getStub()

public InstancesStub getStub()

Returns
Type	Description
`InstancesStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listInstances(ListInstancesRequest request)

public final InstancesClient.ListInstancesPagedResponse listInstances(ListInstancesRequest request)

Lists Instances. Results are sorted by creation time, descending.

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 (InstancesClient instancesClient = InstancesClient.create()) {
   ListInstancesRequest request =
       ListInstancesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setShowDeleted(true)
           .build();
   for (Instance element : 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`

listInstances(LocationName parent)

public final InstancesClient.ListInstancesPagedResponse listInstances(LocationName parent)

Lists Instances. Results are sorted by creation time, descending.

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 (InstancesClient instancesClient = InstancesClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Instance element : instancesClient.listInstances(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`LocationName` Required. The location and project to list resources on. Format: projects/{project}/locations/{location}, where {project} can be project id or number.

Returns
Type	Description
`InstancesClient.ListInstancesPagedResponse`

listInstances(String parent)

public final InstancesClient.ListInstancesPagedResponse listInstances(String parent)

Lists Instances. Results are sorted by creation time, descending.

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 (InstancesClient instancesClient = InstancesClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Instance element : instancesClient.listInstances(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The location and project to list resources on. Format: projects/{project}/locations/{location}, where {project} can be project id or number.

Returns
Type	Description
`InstancesClient.ListInstancesPagedResponse`

listInstancesCallable()

public final UnaryCallable<ListInstancesRequest,ListInstancesResponse> listInstancesCallable()

Lists Instances. Results are sorted by creation time, descending.

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 (InstancesClient instancesClient = InstancesClient.create()) {
   ListInstancesRequest request =
       ListInstancesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setShowDeleted(true)
           .build();
   while (true) {
     ListInstancesResponse response = instancesClient.listInstancesCallable().call(request);
     for (Instance element : response.getInstancesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListInstancesRequest,ListInstancesResponse>`

listInstancesPagedCallable()

public final UnaryCallable<ListInstancesRequest,InstancesClient.ListInstancesPagedResponse> listInstancesPagedCallable()

Lists Instances. Results are sorted by creation time, descending.

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 (InstancesClient instancesClient = InstancesClient.create()) {
   ListInstancesRequest request =
       ListInstancesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setShowDeleted(true)
           .build();
   ApiFuture<Instance> future = instancesClient.listInstancesPagedCallable().futureCall(request);
   // Do something.
   for (Instance element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListInstancesRequest,ListInstancesPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

startInstanceAsync(InstanceName name)

public final OperationFuture<Instance,Instance> startInstanceAsync(InstanceName name)

Starts an Instance.

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 (InstancesClient instancesClient = InstancesClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   Instance response = instancesClient.startInstanceAsync(name).get();
 }

Parameter
Name	Description
`name`	`InstanceName` Required. The name of the Instance to stop. Format: `projects/{project}/locations/{location}/instances/{instance}`, where `{project}` can be project id or number.

Returns
Type	Description
`OperationFuture<Instance,Instance>`

startInstanceAsync(StartInstanceRequest request)

public final OperationFuture<Instance,Instance> startInstanceAsync(StartInstanceRequest request)

Starts an Instance.

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 (InstancesClient instancesClient = InstancesClient.create()) {
   StartInstanceRequest request =
       StartInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .build();
   Instance response = instancesClient.startInstanceAsync(request).get();
 }

Parameter
Name	Description
`request`	`StartInstanceRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Instance,Instance>`

startInstanceAsync(String name)

public final OperationFuture<Instance,Instance> startInstanceAsync(String name)

Starts an Instance.

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 (InstancesClient instancesClient = InstancesClient.create()) {
   String name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   Instance response = instancesClient.startInstanceAsync(name).get();
 }

Parameter
Name	Description
`name`	`String` Required. The name of the Instance to stop. Format: `projects/{project}/locations/{location}/instances/{instance}`, where `{project}` can be project id or number.

Returns
Type	Description
`OperationFuture<Instance,Instance>`

startInstanceCallable()

public final UnaryCallable<StartInstanceRequest,Operation> startInstanceCallable()

Starts an Instance.

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 (InstancesClient instancesClient = InstancesClient.create()) {
   StartInstanceRequest request =
       StartInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .build();
   ApiFuture<Operation> future = instancesClient.startInstanceCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<StartInstanceRequest,Operation>`

startInstanceOperationCallable()

public final OperationCallable<StartInstanceRequest,Instance,Instance> startInstanceOperationCallable()

Starts an Instance.

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 (InstancesClient instancesClient = InstancesClient.create()) {
   StartInstanceRequest request =
       StartInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .build();
   OperationFuture<Instance, Instance> future =
       instancesClient.startInstanceOperationCallable().futureCall(request);
   // Do something.
   Instance response = future.get();
 }

Returns
Type	Description
`OperationCallable<StartInstanceRequest,Instance,Instance>`

stopInstanceAsync(InstanceName name)

public final OperationFuture<Instance,Instance> stopInstanceAsync(InstanceName name)

Stops an Instance.

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 (InstancesClient instancesClient = InstancesClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   Instance response = instancesClient.stopInstanceAsync(name).get();
 }

Parameter
Name	Description
`name`	`InstanceName` Required. The name of the Instance to stop. Format: `projects/{project}/locations/{location}/instances/{instance}`, where `{project}` can be project id or number.

Returns
Type	Description
`OperationFuture<Instance,Instance>`

stopInstanceAsync(StopInstanceRequest request)

public final OperationFuture<Instance,Instance> stopInstanceAsync(StopInstanceRequest request)

Stops an Instance.

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 (InstancesClient instancesClient = InstancesClient.create()) {
   StopInstanceRequest request =
       StopInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .build();
   Instance response = instancesClient.stopInstanceAsync(request).get();
 }

Parameter
Name	Description
`request`	`StopInstanceRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Instance,Instance>`

stopInstanceAsync(String name)

public final OperationFuture<Instance,Instance> stopInstanceAsync(String name)

Stops an Instance.

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 (InstancesClient instancesClient = InstancesClient.create()) {
   String name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   Instance response = instancesClient.stopInstanceAsync(name).get();
 }

Parameter
Name	Description
`name`	`String` Required. The name of the Instance to stop. Format: `projects/{project}/locations/{location}/instances/{instance}`, where `{project}` can be project id or number.

Returns
Type	Description
`OperationFuture<Instance,Instance>`

stopInstanceCallable()

public final UnaryCallable<StopInstanceRequest,Operation> stopInstanceCallable()

Stops an Instance.

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 (InstancesClient instancesClient = InstancesClient.create()) {
   StopInstanceRequest request =
       StopInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .build();
   ApiFuture<Operation> future = instancesClient.stopInstanceCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<StopInstanceRequest,Operation>`

stopInstanceOperationCallable()

public final OperationCallable<StopInstanceRequest,Instance,Instance> stopInstanceOperationCallable()

Stops an Instance.

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 (InstancesClient instancesClient = InstancesClient.create()) {
   StopInstanceRequest request =
       StopInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .build();
   OperationFuture<Instance, Instance> future =
       instancesClient.stopInstanceOperationCallable().futureCall(request);
   // Do something.
   Instance response = future.get();
 }

Returns
Type	Description
`OperationCallable<StopInstanceRequest,Instance,Instance>`

Class InstancesClient (0.83.0) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Static Methods

create()

create(InstancesSettings settings)

create(InstancesStub stub)

Constructors

InstancesClient(InstancesSettings settings)

InstancesClient(InstancesStub stub)

Methods

awaitTermination(long duration, TimeUnit unit)

close()

createInstanceAsync(CreateInstanceRequest request)

createInstanceAsync(LocationName parent, Instance instance)

createInstanceAsync(String parent, Instance instance)

createInstanceCallable()

createInstanceOperationCallable()

deleteInstanceAsync(DeleteInstanceRequest request)

deleteInstanceAsync(InstanceName name)

deleteInstanceAsync(String name)

deleteInstanceCallable()

deleteInstanceOperationCallable()

getHttpJsonOperationsClient()

getInstance(GetInstanceRequest request)

getInstance(InstanceName name)

getInstance(String name)

getInstanceCallable()

getOperationsClient()

getSettings()

getStub()

isShutdown()

isTerminated()

listInstances(ListInstancesRequest request)

listInstances(LocationName parent)

listInstances(String parent)

listInstancesCallable()

listInstancesPagedCallable()

shutdown()

shutdownNow()

startInstanceAsync(InstanceName name)

startInstanceAsync(StartInstanceRequest request)

startInstanceAsync(String name)

startInstanceCallable()

startInstanceOperationCallable()

stopInstanceAsync(InstanceName name)

stopInstanceAsync(StopInstanceRequest request)

stopInstanceAsync(String name)

stopInstanceCallable()

stopInstanceOperationCallable()

Class InstancesClient (0.83.0)