Class: Google::Cloud::Workflows::V1::ListWorkflowsRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/workflows/v1/workflows.rb

Overview

Request for the ListWorkflows method.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

Returns 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"



260
261
262
263
 
# File 'proto_docs/google/cloud/workflows/v1/workflows.rb', line 260

class ListWorkflowsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#order_by ⇒ ::String

Returns 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.



260
261
262
263
 
# File 'proto_docs/google/cloud/workflows/v1/workflows.rb', line 260

class ListWorkflowsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_size ⇒ ::Integer

Returns 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.



260
261
262
263
 
# File 'proto_docs/google/cloud/workflows/v1/workflows.rb', line 260

class ListWorkflowsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

Returns 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.



260
261
262
263
 
# File 'proto_docs/google/cloud/workflows/v1/workflows.rb', line 260

class ListWorkflowsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

Returns 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}



260
261
262
263
 
# File 'proto_docs/google/cloud/workflows/v1/workflows.rb', line 260

class ListWorkflowsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end