Struct google_api_proto::google::cloud::tasks::v2beta2::ListQueuesRequest

pub struct ListQueuesRequest {
    pub parent: String,
    pub filter: String,
    pub page_size: i32,
    pub page_token: String,
    pub read_mask: Option<FieldMask>,
}

Request message for [ListQueues][google.cloud.tasks.v2beta2.CloudTasks.ListQueues].

Fields

parent: String

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

filter: String

filter can be used to specify a subset of queues. Any [Queue][google.cloud.tasks.v2beta2.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: i32

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][google.cloud.tasks.v2beta2.ListQueuesResponse.next_page_token] in the response to determine if more queues exist.

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][google.cloud.tasks.v2beta2.ListQueuesResponse.next_page_token] returned from the previous call to [ListQueues][google.cloud.tasks.v2beta2.CloudTasks.ListQueues] method. It is an error to switch the value of the [filter][google.cloud.tasks.v2beta2.ListQueuesRequest.filter] while iterating through pages.

read_mask: Option<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.

Trait Implementations

impl Clone for ListQueuesRequest

fn clone(&self) -> ListQueuesRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListQueuesRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ListQueuesRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for ListQueuesRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ListQueuesRequest

fn eq(&self, other: &ListQueuesRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ListQueuesRequest