Struct google_api_proto::google::cloud::tasks::v2beta2::LeaseTasksRequest

pub struct LeaseTasksRequest {
    pub parent: String,
    pub max_tasks: i32,
    pub lease_duration: Option<Duration>,
    pub response_view: i32,
    pub filter: String,
}

Request message for leasing tasks using [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks].

Fields

parent: String

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

max_tasks: i32

The maximum number of tasks to lease.

The system will make a best effort to return as close to as max_tasks as possible.

The largest that max_tasks can be is 1000.

The maximum total size of a [lease tasks response][google.cloud.tasks.v2beta2.LeaseTasksResponse] is 32 MB. If the sum of all task sizes requested reaches this limit, fewer tasks than requested are returned.

lease_duration: Option<Duration>

Required. The duration of the lease.

Each task returned in the [response][google.cloud.tasks.v2beta2.LeaseTasksResponse] will have its [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] set to the current time plus the lease_duration. The task is leased until its [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time]; thus, the task will not be returned to another [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] call before its [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time].

After the worker has successfully finished the work associated with the task, the worker must call via [AcknowledgeTask][google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask] before the [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time]. Otherwise the task will be returned to a later [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] call so that another worker can retry it.

The maximum lease duration is 1 week. lease_duration will be truncated to the nearest second.

response_view: i32

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

By default response_view is [BASIC][google.cloud.tasks.v2beta2.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.v2beta2.Task.View.FULL] requires cloudtasks.tasks.fullView Google IAM permission on the [Task][google.cloud.tasks.v2beta2.Task] resource.

filter: String

filter can be used to specify a subset of tasks to lease.

When filter is set to tag=<my-tag> then the [response][google.cloud.tasks.v2beta2.LeaseTasksResponse] will contain only tasks whose [tag][google.cloud.tasks.v2beta2.PullMessage.tag] is equal to <my-tag>. <my-tag> must be less than 500 characters.

When filter is set to tag_function=oldest_tag(), only tasks which have the same tag as the task with the oldest [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] will be returned.

Grammar Syntax:

• filter = "tag=" tag | "tag_function=" function

• tag = string

• function = "oldest_tag()"

The oldest_tag() function returns tasks which have the same tag as the oldest task (ordered by schedule time).

SDK compatibility: Although the SDK allows tags to be either string or bytes, only UTF-8 encoded tags can be used in Cloud Tasks. Tag which aren’t UTF-8 encoded can’t be used in the [filter][google.cloud.tasks.v2beta2.LeaseTasksRequest.filter] and the task’s [tag][google.cloud.tasks.v2beta2.PullMessage.tag] will be displayed as empty in Cloud Tasks.

Implementations

impl LeaseTasksRequest

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 LeaseTasksRequest

fn clone(&self) -> LeaseTasksRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LeaseTasksRequest

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

Formats the value using the given formatter.

impl Default for LeaseTasksRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for LeaseTasksRequest

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

where B: BufMut, 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<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

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

where B: Buf, Self: Default,

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

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

where B: Buf, Self: Sized,

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, Self: Sized,

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

impl PartialEq for LeaseTasksRequest

fn eq(&self, other: &LeaseTasksRequest) -> 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 LeaseTasksRequest