Package google.longrunning

Index

Operations

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

CancelOperation

rpc CancelOperation(CancelOperationRequest) returns (Empty)

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation. Authorization requires the following Google IAM permission:

  • lifesciences.operations.cancel
Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
GetOperation

rpc GetOperation(GetOperationRequest) returns (Operation)

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. Authorization requires the following Google IAM permission:

  • lifesciences.operations.get
Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
ListOperations

rpc ListOperations(ListOperationsRequest) returns (ListOperationsResponse)

Lists operations that match the specified filter in the request. Authorization requires the following Google IAM permission:

  • lifesciences.operations.list
Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
WaitOperation

rpc WaitOperation(WaitOperationRequest) returns (Operation)

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.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

CancelOperationRequest

The request message for Operations.CancelOperation.

Fields
name

string

The name of the operation resource to be cancelled.

GetOperationRequest

The request message for Operations.GetOperation.

Fields
name

string

The name of the operation resource.

ListOperationsRequest

The request message for Operations.ListOperations.

Fields
name

string

The name of the operation's parent resource.
filter

string

A string for filtering Operations. The following filter fields are supported:

  • createTime: The time this job was created
  • events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred.
  • error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code.
  • labels.key or labels."key with space" where key is a label key.
  • done: If the pipeline is running, this value is false. Once the pipeline finishes, the value is true.
page_size

int32

The maximum number of results to return. The maximum value is 256.
page_token

string

The standard list page token.

ListOperationsResponse

The response message for Operations.ListOperations.

Fields
operations[]

Operation

A list of operations that matches the specified filter in the request.
next_page_token

string

The standard List next-page token.

Operation

This resource represents a long-running operation that is the result of a network API call.

Fields
name

string

The server-assigned name for the operation. This may be passed to the other operation methods to retrieve information about the operation's status.
metadata

Any

An Metadata object. This will always be returned with the Operation.
done

bool

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
Union field result. The operation result, which can be either an error or a valid response. If done == false, neither error nor response is set. If done == true, exactly one of error or response may be set. Some services might not provide the result. result can be only one of the following:
error

Status

The error result of the operation in case of failure or cancellation.
response

Any

An Empty object.

WaitOperationRequest

The request message for Operations.WaitOperation.

Fields
name

string

The name of the operation resource to wait on.
timeout

Duration

The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.