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 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 ListOperations (ListOperationsRequest, ListOperationsResponse)

  operations.proto:65

  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.

  message ListOperationsRequest

  operations.proto:165

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

  • string name = 4

    The name of the operation's parent resource.

  • 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:180

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

  • repeated Operation operations = 1

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

  • string next_page_token = 2

    The standard List next-page token.

• rpc GetOperation (GetOperationRequest, Operation)

  operations.proto:74

  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.

  message GetOperationRequest

  operations.proto:159

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

  • string name = 1

    The name of the operation resource.

• rpc DeleteOperation (DeleteOperationRequest, protobuf.Empty)

  operations.proto:84

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

  message DeleteOperationRequest

  operations.proto:195

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

  • string name = 1

    The name of the operation resource to be deleted.

• rpc CancelOperation (CancelOperationRequest, protobuf.Empty)

  operations.proto:100

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

  message CancelOperationRequest

  operations.proto:189

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

  • string name = 1

    The name of the operation resource to be cancelled.

• rpc WaitOperation (WaitOperationRequest, Operation)

  operations.proto:116

  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.

  message WaitOperationRequest

  operations.proto:201

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

  • string name = 1

    The name of the operation resource to wait on.

  • optional protobuf.Duration timeout = 2

    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.

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

Used as response type in: api.servicemanagement.v1.ServiceManager.CreateService, api.servicemanagement.v1.ServiceManager.CreateServiceRollout, api.servicemanagement.v1.ServiceManager.DeleteService, api.servicemanagement.v1.ServiceManager.DisableService, api.servicemanagement.v1.ServiceManager.EnableService, api.servicemanagement.v1.ServiceManager.SubmitConfigSource, api.servicemanagement.v1.ServiceManager.UndeleteService, Operations.GetOperation, Operations.WaitOperation

Used as field type in: ListOperationsResponse

• string name = 1

  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 have the format of `operations/some/unique/name`.

• optional protobuf.Any metadata = 2

  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.

• bool done = 3

  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

  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` is set.

  • rpc.Status error = 4

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

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

A message representing the message types used by a long-running operation. Example: rpc LongRunningRecognize(LongRunningRecognizeRequest) returns (google.longrunning.Operation) { option (google.longrunning.operation_info) = { response_type: "LongRunningRecognizeResponse" metadata_type: "LongRunningRecognizeMetadata" }; }

• string response_type = 1

  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.

• string metadata_type = 2

  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.