Workflows V1 API - Class Google::Cloud::Workflows::V1::ListWorkflowsRequest (v2.3.0)

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

Request for the ListWorkflows method.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
Returns
  • (::String) — Filter to restrict results to specific workflows. For details, see AIP-160.

    For example, if you are using the Google APIs Explorer:

    state="SUCCEEDED"

    or

    createTime>"2023-08-01" AND state="FAILED"

#filter=

def filter=(value) -> ::String
Parameter
  • value (::String) — Filter to restrict results to specific workflows. For details, see AIP-160.

    For example, if you are using the Google APIs Explorer:

    state="SUCCEEDED"

    or

    createTime>"2023-08-01" AND state="FAILED"

Returns
  • (::String) — Filter to restrict results to specific workflows. For details, see AIP-160.

    For example, if you are using the Google APIs Explorer:

    state="SUCCEEDED"

    or

    createTime>"2023-08-01" AND state="FAILED"

#order_by

def order_by() -> ::String
Returns
  • (::String) — Comma-separated list of fields that specify the order of the results. Default sorting order for a field is ascending. To specify descending order for a field, append a "desc" suffix. If not specified, the results are returned in an unspecified order.

#order_by=

def order_by=(value) -> ::String
Parameter
  • value (::String) — Comma-separated list of fields that specify the order of the results. Default sorting order for a field is ascending. To specify descending order for a field, append a "desc" suffix. If not specified, the results are returned in an unspecified order.
Returns
  • (::String) — Comma-separated list of fields that specify the order of the results. Default sorting order for a field is ascending. To specify descending order for a field, append a "desc" suffix. If not specified, the results are returned in an unspecified order.

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — Maximum number of workflows to return per call. The service might return fewer than this value even if not at the end of the collection. If a value is not specified, a default value of 500 is used. The maximum permitted value is 1000 and values greater than 1000 are coerced down to 1000.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — Maximum number of workflows to return per call. The service might return fewer than this value even if not at the end of the collection. If a value is not specified, a default value of 500 is used. The maximum permitted value is 1000 and values greater than 1000 are coerced down to 1000.
Returns
  • (::Integer) — Maximum number of workflows to return per call. The service might return fewer than this value even if not at the end of the collection. If a value is not specified, a default value of 500 is used. The maximum permitted value is 1000 and values greater than 1000 are coerced down to 1000.

#page_token

def page_token() -> ::String
Returns
  • (::String) — A page token, received from a previous ListWorkflows call. Provide this to retrieve the subsequent page.

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

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::String) — A page token, received from a previous ListWorkflows call. Provide this to retrieve the subsequent page.

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

Returns
  • (::String) — A page token, received from a previous ListWorkflows call. Provide this to retrieve the subsequent page.

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

#parent

def parent() -> ::String
Returns
  • (::String) — Required. Project and location from which the workflows should be listed. Format: projects/{project}/locations/{location}

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. Project and location from which the workflows should be listed. Format: projects/{project}/locations/{location}
Returns
  • (::String) — Required. Project and location from which the workflows should be listed. Format: projects/{project}/locations/{location}