com.google.longrunning

Class OperationsGrpc.OperationsBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<OperationsGrpc.OperationsBlockingStub>

com.google.longrunning.OperationsGrpc.OperationsBlockingStub

Enclosing class:

OperationsGrpc

public static final class OperationsGrpc.OperationsBlockingStub
extends io.grpc.stub.AbstractStub<OperationsGrpc.OperationsBlockingStub>

 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 using `google.watcher.v1.Watcher` interface to watch
 the response, 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.
 

Method Summary

Modifier and Type	Method and Description
protected OperationsGrpc.OperationsBlockingStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
com.google.protobuf.Empty	cancelOperation(CancelOperationRequest request) Starts asynchronous cancellation on a long-running operation.
com.google.protobuf.Empty	deleteOperation(DeleteOperationRequest request) Deletes a long-running operation.
Operation	getOperation(GetOperationRequest request) Gets the latest state of a long-running operation.
ListOperationsResponse	listOperations(ListOperationsRequest request) Lists operations that match the specified filter in the request.

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withDeadlineNanoTime, withInterceptors, withOption

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

build

protected OperationsGrpc.OperationsBlockingStub build(io.grpc.Channel channel,
                                                      io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<OperationsGrpc.OperationsBlockingStub>

getOperation

public Operation getOperation(GetOperationRequest request)

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

listOperations

public ListOperationsResponse listOperations(ListOperationsRequest request)

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

cancelOperation

public com.google.protobuf.Empty 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 may use
 [Operations.GetOperation] or other methods to check whether the
 cancellation succeeded or the operation completed despite cancellation.
 

deleteOperation

public com.google.protobuf.Empty deleteOperation(DeleteOperationRequest request)

 Deletes a long-running operation.  It indicates the client is no longer
 interested in the operation result. It does not cancel the operation.