ListOperationsRequest

The request message for Operations.ListOperations.

JSON representation
{
  "name": string,
  "filter": string,
  "pageSize": integer,
  "pageToken": string
}
Fields
name

string

Not used.

filter

string

A string for filtering Operations. The following filter fields are supported:

  • Type: Required. Only = operator is allowed. Can be:
    • BATCH_PROCESS_DOCUMENTS
    • CREATE_PROCESSOR
    • CREATE_PROCESSOR_VERSION
    • DELETE_PROCESSOR
    • DELETE_PROCESSOR_VERSION
    • DEPLOY_PROCESSOR_VERSION
    • DISABLE_PROCESSOR
    • ENABLE_PROCESSOR
    • HUMAN_REVIEW
    • SET_DEFAULT_PROCESSOR_VERSION
    • UNDEPLOY_PROCESSOR_VERSION
  • CreateTime: The time this job was created, in ISO 8601 format. Allowed operators are >=, >, <=, and <.
  • UpdateTime: The time this job was last updated, in ISO 8601 format. Allowed operators are >=, >, <=, and <.
  • ResourceName: The name of the resource. For example projects/123/locations/us. Allowed operators are : (prefix) and = (exact match).
  • State: Can be DONE, RUNNING, CANCELLED, or FAILED. Allowed operators are =, and !=.

Filter expression supports conjunction AND and disjunction OR logical operators as well as () grouping operator.

Examples:

  • Type=CREATE_PROCESSOR AND (ResourceName:projects/123/locations/us OR CreateTime>2022-08-07)
  • Type=HUMAN_REVIEW AND State=DONE
pageSize

integer

The maximum number of operations to return. If unspecified, defaults to 100. The maximum value is 100.

pageToken

string

The standard list page token.