Cloud Tasks V2beta2 API - Class Google::Cloud::Tasks::V2beta2::ListQueuesRequest (v0.13.0)

Reference documentation and code samples for the Cloud Tasks V2beta2 API class Google::Cloud::Tasks::V2beta2::ListQueuesRequest.

Request message for ListQueues.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
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 "app_engine_http_target: *".

    Note that using filters might cause fewer queues than the requested_page size to be returned.

#filter=

def filter=(value) -> ::String
Parameter
  • value (::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 "app_engine_http_target: *".

    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 "app_engine_http_target: *".

    Note that using filters might cause fewer queues than the requested_page size to be returned.

#page_size

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

#page_size=

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

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.

#page_token

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

#page_token=

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

#parent

def parent() -> ::String
Returns
  • (::String) — Required. The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID

#parent=

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

#read_mask

def read_mask() -> ::Google::Protobuf::FieldMask
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.

#read_mask=

def read_mask=(value) -> ::Google::Protobuf::FieldMask
Parameter
  • value (::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.