Class Operations.OperationsBase
Base class for server-side implementations of Operations
Inheritance
Inherited Members
Namespace: Google.LongRunning
Assembly: Google.LongRunning.dll
Syntax
[BindServiceMethod(typeof(Operations), "BindService")]
public abstract class OperationsBaseMethods
CancelOperation(CancelOperationRequest, ServerCallContext)
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.
Declaration
public virtual Task<Empty> CancelOperation(CancelOperationRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| CancelOperationRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Empty> | The response to send back to the client (wrapped by a task). |
DeleteOperation(DeleteOperationRequest, ServerCallContext)
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.
Declaration
public virtual Task<Empty> DeleteOperation(DeleteOperationRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| DeleteOperationRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Empty> | The response to send back to the client (wrapped by a task). |
GetOperation(GetOperationRequest, ServerCallContext)
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.
Declaration
public virtual Task<Operation> GetOperation(GetOperationRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| GetOperationRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Operation> | The response to send back to the client (wrapped by a task). |
ListOperations(ListOperationsRequest, ServerCallContext)
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.
Declaration
public virtual Task<ListOperationsResponse> ListOperations(ListOperationsRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| ListOperationsRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ListOperationsResponse> | The response to send back to the client (wrapped by a task). |
WaitOperation(WaitOperationRequest, ServerCallContext)
Waits for the specified long-running operation until it 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.
Declaration
public virtual Task<Operation> WaitOperation(WaitOperationRequest request, ServerCallContext context)Parameters
| Type | Name | Description |
|---|---|---|
| WaitOperationRequest | request | The request received from the client. |
| ServerCallContext | context | The context of the server-side call handler being invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Operation> | The response to send back to the client (wrapped by a task). |