REST Resource: projects.locations.operations

Resource: Operation

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

JSON representation
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // Union field result can be only one of the following:
  "error": {
    object(Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // End of list of possible types for union field result.
}
Fields
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 have the format of operations/some/unique/name.

metadata

object

{

createTime: The time the operation was created.

endTime: The time the operation finished running.

target: Server-defined resource path for the target of the operation.

verb: Name of the verb executed by the operation.

statusDetail: Human-readable status of the operation, if any.

cancelRequested: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

apiVersion: API version used to start the operation.

}

done

boolean

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 is set. result can be only one of the following:
error

object(Status)

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

response

object

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.

Methods

cancel

Starts asynchronous cancellation on a long-running operation.

delete

Deletes a long-running operation.

get

Gets the latest state of a long-running operation.

list

Lists operations that match the specified filter in the request.
Was this page helpful? Let us know how we did:

Send feedback about...

Google Cloud Memorystore for Redis