Workflows Executions V1 API - Class Google::Cloud::Workflows::Executions::V1::ListExecutionsRequest (v0.4.0)

Reference documentation and code samples for the Workflows Executions V1 API class Google::Cloud::Workflows::Executions::V1::ListExecutionsRequest.

Request for the [ListExecutions][] method.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
Returns
  • (::String) — Optional. Filters applied to the [Executions.ListExecutions] results. The following fields are supported for filtering: executionID, state, startTime, endTime, duration, workflowRevisionID, stepName, and label.

#filter=

def filter=(value) -> ::String
Parameter
  • value (::String) — Optional. Filters applied to the [Executions.ListExecutions] results. The following fields are supported for filtering: executionID, state, startTime, endTime, duration, workflowRevisionID, stepName, and label.
Returns
  • (::String) — Optional. Filters applied to the [Executions.ListExecutions] results. The following fields are supported for filtering: executionID, state, startTime, endTime, duration, workflowRevisionID, stepName, and label.

#order_by

def order_by() -> ::String
Returns
  • (::String) — 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.

#order_by=

def order_by=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — 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.

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — 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.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.
Returns
  • (::Integer) — 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.

#page_token

def page_token() -> ::String
Returns
  • (::String) — 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.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.

#parent

def parent() -> ::String
Returns
  • (::String) — Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}
Returns
  • (::String) — Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}

#view

def view() -> ::Google::Cloud::Workflows::Executions::V1::ExecutionView
Returns

#view=

def view=(value) -> ::Google::Cloud::Workflows::Executions::V1::ExecutionView
Parameter
Returns