Class OperationsGrpc.OperationsBlockingStub (2.11.0)

Stay organized with collections Save and categorize content based on your preferences.
public static final class OperationsGrpc.OperationsBlockingStub extends AbstractBlockingStub<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 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.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > OperationsGrpc.OperationsBlockingStub

Methods

build(Channel channel, CallOptions callOptions)

protected OperationsGrpc.OperationsBlockingStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
OperationsGrpc.OperationsBlockingStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

cancelOperation(CancelOperationRequest request)

public 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 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.

Parameter
NameDescription
requestCancelOperationRequest
Returns
TypeDescription
Empty

deleteOperation(DeleteOperationRequest request)

public Empty 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.

Parameter
NameDescription
requestDeleteOperationRequest
Returns
TypeDescription
Empty

getOperation(GetOperationRequest request)

public 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.

Parameter
NameDescription
requestGetOperationRequest
Returns
TypeDescription
Operation

listOperations(ListOperationsRequest request)

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

Parameter
NameDescription
requestListOperationsRequest
Returns
TypeDescription
ListOperationsResponse

waitOperation(WaitOperationRequest request)

public 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.

Parameter
NameDescription
requestWaitOperationRequest
Returns
TypeDescription
Operation