package google.longrunning

Get desktop application:
View/edit binary Protocol Buffers messages

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.

• rpc GetOperation (GetOperationRequest, Operation)

  operations.proto:43

  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.

  message GetOperationRequest

  operations.proto:105

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

  • string name = 1

    The name of the operation resource.

• rpc ListOperations (ListOperationsRequest, ListOperationsResponse)

  operations.proto:50

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

  message ListOperationsRequest

  operations.proto:111

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

  • string name = 4

    The name of the operation collection.

  • string filter = 1

    The standard List filter.

  • int32 page_size = 2

    The standard List page size.

  • string page_token = 3

    The standard List page token.

  message ListOperationsResponse

  operations.proto:126

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

  • repeated Operation operations = 1

    A list of operations that match the specified filter in the request.

  • string next_page_token = 2

    The standard List next-page token.

• rpc CancelOperation (CancelOperationRequest, protobuf.Empty)

  operations.proto:60

  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.

  message CancelOperationRequest

  operations.proto:135

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

  • string name = 1

    The name of the operation resource to be cancelled.

• rpc DeleteOperation (DeleteOperationRequest, protobuf.Empty)

  operations.proto:66

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

  message DeleteOperationRequest

  operations.proto:141

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

  • string name = 1

    The name of the operation resource to be deleted.

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

Used as response type in: cloud.speech.v1beta1.Speech.AsyncRecognize, Operations.GetOperation

Used as field type in: ListOperationsResponse

• string name = 1

  The name of the operation resource, which is only unique within the same service that originally returns it.

• optional protobuf.Any metadata = 2

  Some service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services may not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

• bool done = 3

  If the value is false, it means the operation is still in progress. If true, the operation is completed and the `result` is available.

• oneof result

  • rpc.Status error = 4

    The error result of the operation in case of failure.

  • protobuf.Any response = 5

    The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response will be `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 will be `TakeSnapshotResponse`.