Struct googapis::google::cloud::tasks::v2::Task

pub struct Task {
    pub name: String,
    pub schedule_time: Option<Timestamp>,
    pub create_time: Option<Timestamp>,
    pub dispatch_deadline: Option<Duration>,
    pub dispatch_count: i32,
    pub response_count: i32,
    pub first_attempt: Option<Attempt>,
    pub last_attempt: Option<Attempt>,
    pub view: i32,
    pub message_type: Option<MessageType>,
}

A unit of scheduled work.

Fields

name: String

Optionally caller-specified in [CreateTask][google.cloud.tasks.v2.CloudTasks.CreateTask].

The task name.

The task name must have the following format: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID

• PROJECT_ID can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projects
• LOCATION_ID is the canonical ID for the task’s location. The list of available locations can be obtained by calling [ListLocations][google.cloud.location.Locations.ListLocations]. For more information, see https://cloud.google.com/about/locations/.
• QUEUE_ID can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters.
• TASK_ID can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.

schedule_time: Option<Timestamp>

The time when the task is scheduled to be attempted or retried.

schedule_time will be truncated to the nearest microsecond.

create_time: Option<Timestamp>

Output only. The time that the task was created.

create_time will be truncated to the nearest second.

dispatch_deadline: Option<Duration>

The deadline for requests sent to the worker. If the worker does not respond by this deadline then the request is cancelled and the attempt is marked as a DEADLINE_EXCEEDED failure. Cloud Tasks will retry the task according to the [RetryConfig][google.cloud.tasks.v2.RetryConfig].

Note that when the request is cancelled, Cloud Tasks will stop listing for the response, but whether the worker stops processing depends on the worker. For example, if the worker is stuck, it may not react to cancelled requests.

The default and maximum values depend on the type of request:

• For [HTTP tasks][google.cloud.tasks.v2.HttpRequest], the default is 10 minutes. The deadline must be in the interval [15 seconds, 30 minutes].

• For [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest], 0 indicates that the request has the default deadline. The default deadline depends on the scaling type of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. Regardless of the task’s dispatch_deadline, the app handler will not run for longer than than the service’s timeout. We recommend setting the dispatch_deadline to at most a few seconds more than the app handler’s timeout. For more information see [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts).

dispatch_deadline will be truncated to the nearest millisecond. The deadline is an approximate deadline.

dispatch_count: i32

Output only. The number of attempts dispatched.

This count includes attempts which have been dispatched but haven’t received a response.

response_count: i32

Output only. The number of attempts which have received a response.

first_attempt: Option<Attempt>

Output only. The status of the task’s first attempt.

Only [dispatch_time][google.cloud.tasks.v2.Attempt.dispatch_time] will be set. The other [Attempt][google.cloud.tasks.v2.Attempt] information is not retained by Cloud Tasks.

last_attempt: Option<Attempt>

Output only. The status of the task’s last attempt.

view: i32

Output only. The view specifies which subset of the [Task][google.cloud.tasks.v2.Task] has been returned.

message_type: Option<MessageType>

Required. The message to send to the worker.

Implementations

impl Task

pub fn view(&self) -> View

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

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

Sets view to the provided enum value.

Trait Implementations

impl Clone for Task

fn clone(&self) -> Task

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Task

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

Formats the value using the given formatter.

impl Default for Task

fn default() -> Self

Returns the “default value” for a type.

impl Message for Task

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<Task> for Task

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

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

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

This method tests for !=.

impl StructuralPartialEq for Task