← Back to packages

Package google.longrunning

Service Operations

Message CancelOperationRequest

Message DeleteOperationRequest

Message GetOperationRequest

Message ListOperationsRequest

Message ListOperationsResponse

Message Operation

Message OperationInfo

Message WaitOperationRequest

Services

service Operations google/longrunning/operations.proto

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

rpc ListOperations
Request: google.longrunning.ListOperationsRequest
Response: google.longrunning.ListOperationsResponse

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

rpc GetOperation
Request: google.longrunning.GetOperationRequest
Response: google.longrunning.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.

rpc DeleteOperation
Request: google.longrunning.DeleteOperationRequest
Response: google.protobuf.Empty

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.

rpc CancelOperation
Request: google.longrunning.CancelOperationRequest
Response: google.protobuf.Empty

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.

rpc WaitOperation
Request: google.longrunning.WaitOperationRequest
Response: google.longrunning.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.

Messages

message CancelOperationRequest google/longrunning/operations.proto

The request message for [Operations.CancelOperation][google.longrunning.Operations.CancelOperation].

Field Type Description
1 name string

The name of the operation resource to be cancelled.

message DeleteOperationRequest google/longrunning/operations.proto

The request message for [Operations.DeleteOperation][google.longrunning.Operations.DeleteOperation].

Field Type Description
1 name string

The name of the operation resource to be deleted.

message GetOperationRequest google/longrunning/operations.proto

The request message for [Operations.GetOperation][google.longrunning.Operations.GetOperation].

Field Type Description
1 name string

The name of the operation resource.

message ListOperationsRequest google/longrunning/operations.proto

The request message for [Operations.ListOperations][google.longrunning.Operations.ListOperations].

Field Type Description
1 filter string

The standard list filter.
2 page_size int32

The standard list page size.
3 page_token string

The standard list page token.
4 name string

The name of the operation's parent resource.

message ListOperationsResponse google/longrunning/operations.proto

The response message for [Operations.ListOperations][google.longrunning.Operations.ListOperations].

Field Type Description
1 operations repeated google.longrunning.Operation

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

The standard List next-page token.

message Operation google/longrunning/operations.proto

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

Field Type Description
1 name string

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
2 metadata google.protobuf.Any

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
3 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.
oneof result
4 error google.rpc.Status

The error result of the operation in case of failure or cancellation.
5 response google.protobuf.Any

The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.

message OperationInfo google/longrunning/operations.proto

A message representing the message types used by a long-running operation.

Example:

rpc Export(ExportRequest) returns (google.longrunning.Operation) {
  option (google.longrunning.operation_info) = {
    response_type: "ExportResponse"
    metadata_type: "ExportMetadata"
  };
}
Field Type Description
1 response_type string

Required. The message name of the primary return type for this long-running operation. This type will be used to deserialize the LRO's response.

If the response is in a different package from the rpc, a fully-qualified message name must be used (e.g. google.protobuf.Struct).

Note: Altering this value constitutes a breaking change.
2 metadata_type string

Required. The message name of the metadata type for this long-running operation.

If the response is in a different package from the rpc, a fully-qualified message name must be used (e.g. google.protobuf.Struct).

Note: Altering this value constitutes a breaking change.

message WaitOperationRequest google/longrunning/operations.proto

The request message for [Operations.WaitOperation][google.longrunning.Operations.WaitOperation].

Field Type Description
1 name string

The name of the operation resource to wait on.
2 timeout google.protobuf.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.