Method: operations.list

Lists operations that match the specified filter in the request. Authorization requires the following Google IAM permission:

  • genomics.operations.list

HTTP request

GET https://genomics.googleapis.com/v1/{name}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

The name of the operation's parent resource.

Query parameters

Parameters
filter

string

A string for filtering Operations. In v2alpha1, the following filter fields are supported:

  • createTime: The time this job was created
  • events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred.
  • error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code.
  • labels.key or labels."key with space" where key is a label key.
  • done: If the pipeline is running, this value is false. Once the pipeline finishes, the value is true.

In v1 and v1alpha2, the following filter fields are supported:

  • projectId: Required. Corresponds to OperationMetadata.projectId.
  • createTime: The time this job was created, in seconds from the epoch. Can use >= and/or <= operators.
  • status: Can be RUNNING, SUCCESS, FAILURE, or CANCELED. Only one status may be specified.
  • labels.key where key is a label key.

Examples:

  • projectId = my-project AND createTime >= 1432140000
  • projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING
  • projectId = my-project AND labels.color = *
  • projectId = my-project AND labels.color = red

pageSize

number

The maximum number of results to return. The maximum value is 256.

pageToken

string

The standard list page token.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of ListOperationsResponse.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/genomics

For more information, see the Authentication Overview.

このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...