Workflows Service, gRPC: WorkflowService.ListOperations

Field

Description

workflow_id

string

Required field. ID of the Workflow to list operations for.

page_size

int64

The maximum number of results per page that should be returned. If the number of available
results is larger than pageSize, the service returns a ListOperationsResponse.next_page_token
that can be used to get the next page of results in subsequent list requests.

Default value: 100.

page_token

string

Page token. To get the next page of results, set pageToken to the
ListOperationsResponse.next_page_token returned by a previous list request.

filter

string

A filter expression that filters resources listed in the response.

The expression must specify:

1. The field name. Currently filtering can be applied to the operation.Operation.done, operation.Operation.created_by field.
2. An = operator.
3. The value in double quotes ("). Must be 3-63 characters long and match the regular expression [a-z][-a-z0-9]{1,61}[a-z0-9].
   Examples of a filter: done=false, created_by='John.Doe'.

Field

Description

operations[]

Operation

List of operations for the specified Workflow.

next_page_token

string

Token for getting the next page of the list. If the number of results is greater than
the specified ListOperationsRequest.page_size, use next_page_token as the value
for the ListOperationsRequest.page_token parameter in the next list request.

Each subsequent page will have its own next_page_token to continue paging through the results.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

ID of the user or service account who initiated the operation.

modified_at

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

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.

metadata

google.protobuf.Any

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

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

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

google.protobuf.Any

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 the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.