Class: Google::Cloud::Tasks::V2beta3::ListQueuesRequest

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

Overview

Request message for ListQueues.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

Returns filter can be used to specify a subset of queues. Any Queue field can be used as a filter and several operators as supported. For example: <=, <, >=, >, !=, =, :. The filter syntax is the same as described in Stackdriver's Advanced Logs Filters.

Sample filter "state: PAUSED".

Note that using filters might cause fewer queues than the requested page_size to be returned.

Returns:

  • (::String) —

    filter can be used to specify a subset of queues. Any Queue field can be used as a filter and several operators as supported. For example: <=, <, >=, >, !=, =, :. The filter syntax is the same as described in Stackdriver's Advanced Logs Filters.

    Sample filter "state: PAUSED".

    Note that using filters might cause fewer queues than the requested page_size to be returned.



69
70
71
72
 
# File 'proto_docs/google/cloud/tasks/v2beta3/cloudtasks.rb', line 69

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

#page_size ⇒ ::Integer

Returns Requested page size.

The maximum page size is 9800. If unspecified, the page size will be the maximum. Fewer queues than requested might be returned, even if more queues exist; use the next_page_token in the response to determine if more queues exist.

Returns:

  • (::Integer) —

    Requested page size.

    The maximum page size is 9800. If unspecified, the page size will be the maximum. Fewer queues than requested might be returned, even if more queues exist; use the next_page_token in the response to determine if more queues exist.



69
70
71
72
 
# File 'proto_docs/google/cloud/tasks/v2beta3/cloudtasks.rb', line 69

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

#page_token ⇒ ::String

A token identifying the page of results to return.

To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListQueues method. It is an error to switch the value of the filter while iterating through pages.

Returns:

  • (::String) —

    A token identifying the page of results to return.

    To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListQueues method. It is an error to switch the value of the filter while iterating through pages.



69
70
71
72
 
# File 'proto_docs/google/cloud/tasks/v2beta3/cloudtasks.rb', line 69

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

#parent ⇒ ::String

Returns Required. The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID.

Returns:

  • (::String) —

    Required. The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID



69
70
71
72
 
# File 'proto_docs/google/cloud/tasks/v2beta3/cloudtasks.rb', line 69

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

#read_mask ⇒ ::Google::Protobuf::FieldMask

Optional. Read mask is used for a more granular control over what the API returns. If the mask is not present all fields will be returned except [Queue.stats]. [Queue.stats] will be returned only if it was explicitly specified in the mask.

Returns:

  • (::Google::Protobuf::FieldMask) —

    Optional. Read mask is used for a more granular control over what the API returns. If the mask is not present all fields will be returned except [Queue.stats]. [Queue.stats] will be returned only if it was explicitly specified in the mask.



69
70
71
72
 
# File 'proto_docs/google/cloud/tasks/v2beta3/cloudtasks.rb', line 69

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