Struct google_cloudtasks2_beta2::LeaseTasksRequest

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

Request message for leasing tasks using LeaseTasks.

Activities

This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).

• locations queues tasks lease projects (request)

Fields

filter: Option<String>

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

When filter is set to tag=<my-tag> then the response will contain only tasks whose 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 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 and the task's tag will be displayed as empty in Cloud Tasks.

max_tasks: Option<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 is 32 MB. If the sum of all task sizes requested reaches this limit, fewer tasks than requested are returned.

response_view: Option<String>

The response_view specifies which subset of the Task will be returned.

By default response_view is 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 requires cloudtasks.tasks.fullView Google IAM permission on the Task resource.

lease_duration: Option<String>

After the worker has successfully finished the work associated with the task, the worker must call via AcknowledgeTask before the schedule_time. Otherwise the task will be returned to a later 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.

Trait Implementations

impl Default for LeaseTasksRequest

fn default() -> LeaseTasksRequest

Returns the "default value" for a type.

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 RequestValue for LeaseTasksRequest