Interface ListExecutionsRequestOrBuilder (2.54.0) 

public interface ListExecutionsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract String getFilter()

Optional. Filters applied to the [Executions.ListExecutions] results. The following fields are supported for filtering: executionID, state, startTime, endTime, duration, workflowRevisionID, stepName, and label.

string filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

Optional. Filters applied to the [Executions.ListExecutions] results. The following fields are supported for filtering: executionID, state, startTime, endTime, duration, workflowRevisionID, stepName, and label.

string filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for filter.

getOrderBy()

public abstract String getOrderBy()

Optional. The ordering applied to the [Executions.ListExecutions] results. By default the ordering is based on descending start time. The following fields are supported for order by: executionID, startTime, endTime, duration, state, and workflowRevisionID.

string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The orderBy.

getOrderByBytes()

public abstract ByteString getOrderByBytes()

Optional. The ordering applied to the [Executions.ListExecutions] results. By default the ordering is based on descending start time. The following fields are supported for order by: executionID, startTime, endTime, duration, state, and workflowRevisionID.

string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public abstract int getPageSize()

Maximum number of executions to return per call. Max supported value depends on the selected Execution view: it's 1000 for BASIC and 100 for FULL. The default value used if the field is not specified is 100, regardless of the selected view. Values greater than the max value will be coerced down to it.

int32 page_size = 2;

Returns
Type Description
int

The pageSize.

getPageToken()

public abstract String getPageToken()

A page token, received from a previous ListExecutions call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListExecutions must match the call that provided the page token.

Note that pagination is applied to dynamic data. The list of executions returned can change between page requests.

string page_token = 3;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

A page token, received from a previous ListExecutions call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListExecutions must match the call that provided the page token.

Note that pagination is applied to dynamic data. The list of executions returned can change between page requests.

string page_token = 3;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public abstract String getParent()

Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public abstract ByteString getParentBytes()

Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getView()

public abstract ExecutionView getView()

Optional. A view defining which fields should be filled in the returned executions. The API will default to the BASIC view.

.google.cloud.workflows.executions.v1.ExecutionView view = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ExecutionView

The view.

getViewValue()

public abstract int getViewValue()

Optional. A view defining which fields should be filled in the returned executions. The API will default to the BASIC view.

.google.cloud.workflows.executions.v1.ExecutionView view = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for view.