REST Resource: 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. For example: operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw

metadata

object

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

An object containing fields of an arbitrary type. An additional field "@type" contains a URI identifying the type. Example: { "id": 1234, "@type": "types.example.com/standard/id" }.

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

If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For pipelines and exports, an Empty response is returned.

An object containing fields of an arbitrary type. An additional field "@type" contains a URI identifying the type. Example: { "id": 1234, "@type": "types.example.com/standard/id" }.

Methods

cancel

Starts asynchronous cancellation on 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...

Cloud Genomics