public class OperationsClient implements BackgroundResourceService 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 = "name3373707";
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);
To customize the endpoint:
OperationsSettings operationsSettings =
OperationsSettings.newBuilder().setEndpoint(myEndpoint).build();
OperationsClient operationsClient = OperationsClient.create(operationsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceConstructors
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.
| Name | Description |
| settings | OperationsSettings |
OperationsClient(OperationsStub stub)
protected OperationsClient(OperationsStub stub)| 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.
| Name | Description |
| duration | long |
| unit | TimeUnit |
| Type | Description |
| boolean |
| Type | Description |
| InterruptedException |
cancelOperation(CancelOperationRequest request)
public final void cancelOperation(CancelOperationRequest request)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()) {
CancelOperationRequest request =
CancelOperationRequest.newBuilder().setName("name3373707").build();
operationsClient.cancelOperation(request);
}
| Name | Description |
| request | CancelOperationRequestThe request object containing all of the parameters for the API call. |
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 = "name3373707";
operationsClient.cancelOperation(name);
}
| Name | Description |
| name | StringThe name of the operation resource to be cancelled. |
cancelOperationCallable()
public final UnaryCallable<CancelOperationRequest,Empty> cancelOperationCallable()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()) {
CancelOperationRequest request =
CancelOperationRequest.newBuilder().setName("name3373707").build();
ApiFuture<Empty> future = operationsClient.cancelOperationCallable().futureCall(request);
// Do something.
future.get();
}
| Type | Description |
| UnaryCallable<CancelOperationRequest,com.google.protobuf.Empty> |
close()
public final void close()create()
public static final OperationsClient create()Constructs an instance of OperationsClient with default settings.
| Type | Description |
| OperationsClient |
| Type | Description |
| IOException |
create(BackgroundResource stub)
public static final OperationsClient create(BackgroundResource stub)Constructs an instance of OperationsClient, using the given stub for making calls. This is for advanced usage - prefer using create(OperationsSettings).
| Name | Description |
| stub | BackgroundResource |
| Type | Description |
| OperationsClient |
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.
| Name | Description |
| settings | OperationsSettings |
| Type | Description |
| OperationsClient |
| 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 using create(OperationsSettings).
| Name | Description |
| stub | OperationsStub |
| Type | Description |
| OperationsClient |
deleteOperation(DeleteOperationRequest request)
public final void deleteOperation(DeleteOperationRequest request)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()) {
DeleteOperationRequest request =
DeleteOperationRequest.newBuilder().setName("name3373707").build();
operationsClient.deleteOperation(request);
}
| Name | Description |
| request | DeleteOperationRequestThe request object containing all of the parameters for the API call. |
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 = "name3373707";
operationsClient.deleteOperation(name);
}
| Name | Description |
| name | StringThe name of the operation resource to be deleted. |
deleteOperationCallable()
public final UnaryCallable<DeleteOperationRequest,Empty> deleteOperationCallable()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()) {
DeleteOperationRequest request =
DeleteOperationRequest.newBuilder().setName("name3373707").build();
ApiFuture<Empty> future = operationsClient.deleteOperationCallable().futureCall(request);
// Do something.
future.get();
}
| Type | Description |
| UnaryCallable<DeleteOperationRequest,com.google.protobuf.Empty> |
getOperation(GetOperationRequest request)
public final Operation getOperation(GetOperationRequest request)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()) {
GetOperationRequest request = GetOperationRequest.newBuilder().setName("name3373707").build();
Operation response = operationsClient.getOperation(request);
}
| Name | Description |
| request | GetOperationRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| Operation |
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 = "name3373707";
Operation response = operationsClient.getOperation(name);
}
| Name | Description |
| name | StringThe name of the operation resource. |
| 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()) {
GetOperationRequest request = GetOperationRequest.newBuilder().setName("name3373707").build();
ApiFuture<Operation> future = operationsClient.getOperationCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
| Type | Description |
| UnaryCallable<GetOperationRequest,Operation> |
getSettings()
public final OperationsSettings getSettings()| Type | Description |
| OperationsSettings |
getStub()
public OperationsStub getStub()| Type | Description |
| OperationsStub |
isShutdown()
public boolean isShutdown()Returns true if this background resource has been shut down.
| 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.
| 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 allows API services to override the binding to use different
resource name schemes, such as users/*/operations. To override the binding, API services
can add a binding such as "/v1/{name=users/*}/operations" to their service configuration.
For backwards compatibility, the default name includes the operations collection id, however
overriding users must ensure the name binding is the parent resource, without the operations
collection id.
Sample code:
try (OperationsClient operationsClient = OperationsClient.create()) {
ListOperationsRequest request =
ListOperationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Operation element : operationsClient.listOperations(request).iterateAll()) {
// doThingsWith(element);
}
}
| Name | Description |
| request | ListOperationsRequestThe request object containing all of the parameters for the API call. |
| 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 allows API services to override the binding to use different
resource name schemes, such as users/*/operations. To override the binding, API services
can add a binding such as "/v1/{name=users/*}/operations" to their service configuration.
For backwards compatibility, the default name includes the operations collection id, however
overriding users must ensure the name binding is the parent resource, without the operations
collection id.
Sample code:
try (OperationsClient operationsClient = OperationsClient.create()) {
String name = "name3373707";
String filter = "filter-1274492040";
for (Operation element : operationsClient.listOperations(name, filter).iterateAll()) {
// doThingsWith(element);
}
}
| Name | Description |
| name | StringThe name of the operation's parent resource. |
| filter | StringThe standard list filter. |
| 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 allows API services to override the binding to use different
resource name schemes, such as users/*/operations. To override the binding, API services
can add a binding such as "/v1/{name=users/*}/operations" to their service configuration.
For backwards compatibility, the default name includes the operations collection id, however
overriding users must ensure the name binding is the parent resource, without the operations
collection id.
Sample code:
try (OperationsClient operationsClient = OperationsClient.create()) {
ListOperationsRequest request =
ListOperationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListOperationsResponse response = operationsClient.listOperationsCallable().call(request);
for (Operation element : response.getResponsesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| 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 allows API services to override the binding to use different
resource name schemes, such as users/*/operations. To override the binding, API services
can add a binding such as "/v1/{name=users/*}/operations" to their service configuration.
For backwards compatibility, the default name includes the operations collection id, however
overriding users must ensure the name binding is the parent resource, without the operations
collection id.
Sample code:
try (OperationsClient operationsClient = OperationsClient.create()) {
ListOperationsRequest request =
ListOperationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Operation> future =
operationsClient.listOperationsPagedCallable().futureCall(request);
// Do something.
for (Operation element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
| 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.