Struct googapis::google::cloud::tasks::v2::ListTasksRequest

pub struct ListTasksRequest {
    pub parent: String,
    pub response_view: i32,
    pub page_size: i32,
    pub page_token: String,
}

Request message for listing tasks using [ListTasks][google.cloud.tasks.v2.CloudTasks.ListTasks].

Fields

parent: String

Required. The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

response_view: i32

The response_view specifies which subset of the [Task][google.cloud.tasks.v2.Task] will be returned.

By default response_view is [BASIC][google.cloud.tasks.v2.Task.View.BASIC]; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains.

Authorization for [FULL][google.cloud.tasks.v2.Task.View.FULL] requires cloudtasks.tasks.fullView Google IAM permission on the [Task][google.cloud.tasks.v2.Task] resource.

page_size: i32

Maximum page size.

Fewer tasks than requested might be returned, even if more tasks exist; use [next_page_token][google.cloud.tasks.v2.ListTasksResponse.next_page_token] in the response to determine if more tasks exist.

The maximum page size is 1000. If unspecified, the page size will be the maximum.

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.v2.ListTasksResponse.next_page_token] returned from the previous call to [ListTasks][google.cloud.tasks.v2.CloudTasks.ListTasks] method.

The page token is valid for only 2 hours.

Implementations

impl ListTasksRequest

pub fn response_view(&self) -> View

Returns the enum value of response_view, or the default if the field is set to an invalid enum value.

pub fn set_response_view(&mut self, value: View)

Sets response_view to the provided enum value.

Trait Implementations

impl Clone for ListTasksRequest

fn clone(&self) -> ListTasksRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListTasksRequest

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

Formats the value using the given formatter.

impl Default for ListTasksRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for ListTasksRequest

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

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<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

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

Encodes the message to a newly allocated buffer.

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

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

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

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

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

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

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

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

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

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

impl PartialEq<ListTasksRequest> for ListTasksRequest

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

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

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

This method tests for !=.

impl StructuralPartialEq for ListTasksRequest