Class OperationsClient (2.34.0)

public class OperationsClient implements BackgroundResource

Service Description: Manages long-running operations with an API service.

When an API method normally takes long time to complete, it can be designed to return Operation to the client, and the client can use this interface to receive the real response asynchronously by polling the operation resource, or pass the operation resource to another API (such as Google Cloud Pub/Sub API) to receive the response. Any API service that returns long-running operations should implement the Operations interface so developers can have a consistent client experience.

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:

 
 try (OperationsClient operationsClient = OperationsClient.create()) {
   String name = "";
   Operation response = operationsClient.getOperation(name);
 }

Note: close() needs to be called on the operationsClient 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 OperationsSettings to create(). For example:

To customize credentials:

 
 OperationsSettings operationsSettings =
     OperationsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 OperationsClient operationsClient =
     OperationsClient.create(operationsSettings);

Inheritance

java.lang.Object > OperationsClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create(OperationsSettings settings)

public static final OperationsClient create(OperationsSettings settings)

Constructs an instance of OperationsClient, 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`	`OperationsSettings`

Returns
Type	Description
`OperationsClient`

Exceptions
Type	Description
`IOException`

create(OperationsStub stub)

public static final OperationsClient create(OperationsStub stub)

Constructs an instance of OperationsClient, using the given stub for making calls. This is for advanced usage - prefer to use OperationsSettings}.

Parameter
Name	Description
`stub`	`OperationsStub`

Returns
Type	Description
`OperationsClient`

Constructors

OperationsClient(OperationsSettings settings)

protected OperationsClient(OperationsSettings settings)

Constructs an instance of OperationsClient, 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`	`OperationsSettings`

OperationsClient(OperationsStub stub)

protected OperationsClient(OperationsStub stub)

Parameter
Name	Description
`stub`	`OperationsStub`

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Blocks until all work has completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first.

Parameters
Name	Description
`duration`	`long`
`unit`	`TimeUnit`

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`InterruptedException`

cancelOperation(String name)

public final void cancelOperation(String name)

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Sample code:


 try (OperationsClient operationsClient = OperationsClient.create()) {
   String name = "";
   operationsClient.cancelOperation(name);
 }

Parameter
Name	Description
`name`	`String` The name of the operation resource to be cancelled.

cancelOperationCallable()

public final UnaryCallable<CancelOperationRequest,Empty> cancelOperationCallable()

Sample code:


 try (OperationsClient operationsClient = OperationsClient.create()) {
   String name = "";
   CancelOperationRequest request = CancelOperationRequest.newBuilder()
     .setName(name)
     .build();
   ApiFuture<Void> future = operationsClient.cancelOperationCallable().futureCall(request);
   // Do something
   future.get();
 }

Returns
Type	Description
`UnaryCallable<CancelOperationRequest,Empty>`

close()

public final void close()

deleteOperation(String name)

public final void deleteOperation(String name)

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Sample code:


 try (OperationsClient operationsClient = OperationsClient.create()) {
   String name = "";
   operationsClient.deleteOperation(name);
 }

Parameter
Name	Description
`name`	`String` The name of the operation resource to be deleted.

deleteOperationCallable()

public final UnaryCallable<DeleteOperationRequest,Empty> deleteOperationCallable()

Sample code:


 try (OperationsClient operationsClient = OperationsClient.create()) {
   String name = "";
   DeleteOperationRequest request = DeleteOperationRequest.newBuilder()
     .setName(name)
     .build();
   ApiFuture<Void> future = operationsClient.deleteOperationCallable().futureCall(request);
   // Do something
   future.get();
 }

Returns
Type	Description
`UnaryCallable<DeleteOperationRequest,Empty>`

getOperation(String name)

public final Operation getOperation(String name)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Sample code:


 try (OperationsClient operationsClient = OperationsClient.create()) {
   String name = "";
   Operation response = operationsClient.getOperation(name);
 }

Parameter
Name	Description
`name`	`String` The name of the operation resource.

Returns
Type	Description
`Operation`

getOperationCallable()

public final UnaryCallable<GetOperationRequest,Operation> getOperationCallable()

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Sample code:


 try (OperationsClient operationsClient = OperationsClient.create()) {
   String name = "";
   GetOperationRequest request = GetOperationRequest.newBuilder()
     .setName(name)
     .build();
   ApiFuture<Operation> future = operationsClient.getOperationCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetOperationRequest,Operation>`

getSettings()

public final OperationsSettings getSettings()

Returns
Type	Description
`OperationsSettings`

getStub()

public OperationsStub getStub()

Returns
Type	Description
`OperationsStub`

isShutdown()

public boolean isShutdown()

Returns true if this background resource has been shut down.

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns true if all work has completed following shut down. Note that isTerminated is never true unless either shutdown or shutdownNow was called first.

Returns
Type	Description
`boolean`

listOperations(ListOperationsRequest request)

public final OperationsClient.ListOperationsPagedResponse listOperations(ListOperationsRequest request)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

NOTE: the name binding below allows API services to override the binding to use different resource name schemes, such as users/*/operations.

Sample code:


 try (OperationsClient operationsClient = OperationsClient.create()) {
   String name = "";
   String filter = "";
   ListOperationsRequest request = ListOperationsRequest.newBuilder()
     .setName(name)
     .setFilter(filter)
     .build();
   for (Operation element : operationsClient.listOperations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

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

Returns
Type	Description
`OperationsClient.ListOperationsPagedResponse`

listOperations(String name, String filter)

public final OperationsClient.ListOperationsPagedResponse listOperations(String name, String filter)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

NOTE: the name binding below allows API services to override the binding to use different resource name schemes, such as users/*/operations.

Sample code:


 try (OperationsClient operationsClient = OperationsClient.create()) {
   String name = "";
   String filter = "";
   for (Operation element : operationsClient.listOperations(name, filter).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters
Name	Description
`name`	`String` The name of the operation collection.
`filter`	`String` The standard list filter.

Returns
Type	Description
`OperationsClient.ListOperationsPagedResponse`

listOperationsCallable()

public final UnaryCallable<ListOperationsRequest,ListOperationsResponse> listOperationsCallable()

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

NOTE: the name binding below allows API services to override the binding to use different resource name schemes, such as users/*/operations.

Sample code:


 try (OperationsClient operationsClient = OperationsClient.create()) {
   String name = "";
   String filter = "";
   ListOperationsRequest request = ListOperationsRequest.newBuilder()
     .setName(name)
     .setFilter(filter)
     .build();
   while (true) {
     ListOperationsResponse response = operationsClient.listOperationsCallable().call(request);
     for (Operation element : response.getOperationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListOperationsRequest,ListOperationsResponse>`

listOperationsPagedCallable()

public final UnaryCallable<ListOperationsRequest,OperationsClient.ListOperationsPagedResponse> listOperationsPagedCallable()

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

NOTE: the name binding below allows API services to override the binding to use different resource name schemes, such as users/*/operations.

Sample code:


 try (OperationsClient operationsClient = OperationsClient.create()) {
   String name = "";
   String filter = "";
   ListOperationsRequest request = ListOperationsRequest.newBuilder()
     .setName(name)
     .setFilter(filter)
     .build();
   ApiFuture<ListOperationsPagedResponse> future = operationsClient.listOperationsPagedCallable().futureCall(request);
   // Do something
   for (Operation element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListOperationsRequest,ListOperationsPagedResponse>`

shutdown()

public void shutdown()

Initiates an orderly shutdown in which previously submitted work is finished, but no new work will be accepted. Invocation has no additional effect if already shut down.

This method does not wait for previously submitted work to complete execution. Use awaitTermination to do that.

shutdownNow()

public void shutdownNow()

Attempts to stop all actively executing work and halts the processing of waiting work.

This method does not wait for actively executing work to terminate. Use awaitTermination to do that.

There are no guarantees beyond best-effort attempts to stop processing actively executing work. For example, typical implementations will cancel via Thread.interrupt(), so any task that fails to respond to interrupts may never terminate.

waitOperation(WaitOperationRequest request)

public final Operation waitOperation(WaitOperationRequest request)

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Sample code:


 try (OperationsClient operationsClient = OperationsClient.create()) {
   String name = "";
   WaitOperationRequest request = WaitOperationRequest.newBuilder()
     .setName(name)
     .setTimeout(Duration.ofMillis(100))
     .build();
   Operation response = operationsClient.waitOperation(request);
 }

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

Returns
Type	Description
`Operation`

waitOperationCallable()

public final UnaryCallable<WaitOperationRequest,Operation> waitOperationCallable()

Sample code:


 try (OperationsClient operationsClient = OperationsClient.create()) {
   String name = "";
   WaitOperationRequest request = WaitOperationRequest.newBuilder()
     .setName(name)
     .setTimeout(Duration.ofMillis(100))
     .build();
   ApiFuture<Operation> future = operationsClient.waitOperationCallable().futureCall(request);
 }

Returns
Type	Description
`UnaryCallable<WaitOperationRequest,Operation>`