public abstract static class OperationsGrpc.OperationsImplBase
extends java.lang.Object
implements io.grpc.BindableService
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][google.longrunning.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.
Constructor and Description |
---|
OperationsImplBase() |
Modifier and Type | Method and Description |
---|---|
io.grpc.ServerServiceDefinition |
bindService() |
void |
cancelOperation(CancelOperationRequest request,
io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
Starts asynchronous cancellation on a long-running operation.
|
void |
deleteOperation(DeleteOperationRequest request,
io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
Deletes a long-running operation.
|
void |
getOperation(GetOperationRequest request,
io.grpc.stub.StreamObserver<Operation> responseObserver)
Gets the latest state of a long-running operation.
|
void |
listOperations(ListOperationsRequest request,
io.grpc.stub.StreamObserver<ListOperationsResponse> responseObserver)
Lists operations that match the specified filter in the request.
|
public void listOperations(ListOperationsRequest request, io.grpc.stub.StreamObserver<ListOperationsResponse> responseObserver)
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`.
public void getOperation(GetOperationRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver)
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.
public void deleteOperation(DeleteOperationRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
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`.
public void cancelOperation(CancelOperationRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
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][google.longrunning.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][google.longrunning.Operation.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`.
public final io.grpc.ServerServiceDefinition bindService()
bindService
in interface io.grpc.BindableService