Struct google_api_proto::maps::fleetengine::delivery::v1::Task

pub struct Task {

    pub name: String,
    pub type: i32,
    pub state: i32,
    pub task_outcome: i32,
    pub task_outcome_time: Option<Timestamp>,
    pub task_outcome_location: Option<LocationInfo>,
    pub task_outcome_location_source: i32,
    pub tracking_id: String,
    pub delivery_vehicle_id: String,
    pub planned_location: Option<LocationInfo>,
    pub task_duration: Option<Duration>,
    pub target_time_window: Option<TimeWindow>,
    pub journey_sharing_info: Option<JourneySharingInfo>,
    pub task_tracking_view_config: Option<TaskTrackingViewConfig>,
    pub attributes: Vec<TaskAttribute>,
}

A Task in the Delivery API represents a single action to track. In general, there is a distinction between shipment-related Tasks and break Tasks. A shipment can have multiple Tasks associated with it. For example, there could be one Task for the pickup, and one for the drop-off or transfer. Also, different Tasks for a given shipment can be handled by different vehicles. For example, one vehicle could handle the pickup, driving the shipment to the hub, while another vehicle drives the same shipment from the hub to the drop-off location.

Note: gRPC and REST APIs use different field naming conventions. For example, the Task.journey_sharing_info field in the gRPC API and the Task.journeySharingInfo field in the REST API refer to the same field.

Fields

name: String

Must be in the format providers/{provider}/tasks/{task}.

type: i32

Required. Immutable. Defines the type of the Task. For example, a break or shipment.

state: i32

Required. The current execution state of the Task.

task_outcome: i32

The outcome of the Task.

task_outcome_time: Option<Timestamp>

The timestamp that indicates when the Task’s outcome was set by the provider.

task_outcome_location: Option<LocationInfo>

The location where the Task’s outcome was set. This value is updated as part of UpdateTask. If this value isn’t explicitly updated by the provider, then Fleet Engine populates it by default with the last known vehicle location (the raw location).

task_outcome_location_source: i32

Indicates where the value of the task_outcome_location came from.

tracking_id: String

Immutable. This field facilitates the storing of an ID so you can avoid using a complicated mapping. You cannot set tracking_id for Tasks of type UNAVAILABLE and SCHEDULED_STOP. These IDs are subject to the following restrictions:

• Must be a valid Unicode string.
• Limited to a maximum length of 64 characters.
• Normalized according to [Unicode Normalization Form C] (http://www.unicode.org/reports/tr15/).
• May not contain any of the following ASCII characters: ‘/’, ‘:’, ‘?’, ‘,’, or ‘#’.

delivery_vehicle_id: String

Output only. The ID of the vehicle that is executing this Task. Delivery Vehicle IDs are subject to the following restrictions:

• Must be a valid Unicode string.
• Limited to a maximum length of 64 characters.
• Normalized according to [Unicode Normalization Form C] (http://www.unicode.org/reports/tr15/).
• May not contain any of the following ASCII characters: ‘/’, ‘:’, ‘?’, ‘,’, or ‘#’.

planned_location: Option<LocationInfo>

Immutable. The location where the Task will be completed. Optional for UNAVAILABLE Tasks, but required for all other Tasks.

task_duration: Option<Duration>

Required. Immutable. The time needed to execute a Task at this location.

target_time_window: Option<TimeWindow>

The time window during which the task should be completed.

journey_sharing_info: Option<JourneySharingInfo>

Output only. Journey sharing-specific fields. Not populated when state is CLOSED.

task_tracking_view_config: Option<TaskTrackingViewConfig>

The configuration for task tracking that specifies which data elements are visible to the end users under what circumstances.

attributes: Vec<TaskAttribute>

A list of custom Task attributes. Each attribute must have a unique key.

Implementations

impl Task

pub fn type(&self) -> Type

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

pub fn set_type(&mut self, value: Type)

Sets type to the provided enum value.

pub fn state(&self) -> State

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

pub fn set_state(&mut self, value: State)

Sets state to the provided enum value.

pub fn task_outcome(&self) -> TaskOutcome

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

pub fn set_task_outcome(&mut self, value: TaskOutcome)

Sets task_outcome to the provided enum value.

pub fn task_outcome_location_source(&self) -> TaskOutcomeLocationSource

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

pub fn set_task_outcome_location_source( &mut self, value: TaskOutcomeLocationSource )

Sets task_outcome_location_source 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 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 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: &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 Task