Struct VisitRequest

pub struct VisitRequest {
    pub arrival_location: Option<LatLng>,
    pub arrival_waypoint: Option<Waypoint>,
    pub departure_location: Option<LatLng>,
    pub departure_waypoint: Option<Waypoint>,
    pub tags: Vec<String>,
    pub time_windows: Vec<TimeWindow>,
    pub duration: Option<Duration>,
    pub cost: f64,
    pub load_demands: HashMap<String, Load>,
    pub visit_types: Vec<String>,
    pub label: String,
}

Request for a visit which can be done by a vehicle: it has a geo-location (or two, see below), opening and closing times represented by time windows, and a service duration time (time spent by the vehicle once it has arrived to pickup or drop off goods).

Fields

arrival_location: Option<LatLng>

The geo-location where the vehicle arrives when performing this VisitRequest. If the shipment model has duration distance matrices, arrival_location must not be specified.

arrival_waypoint: Option<Waypoint>

The waypoint where the vehicle arrives when performing this VisitRequest. If the shipment model has duration distance matrices, arrival_waypoint must not be specified.

departure_location: Option<LatLng>

The geo-location where the vehicle departs after completing this VisitRequest. Can be omitted if it is the same as arrival_location. If the shipment model has duration distance matrices, departure_location must not be specified.

departure_waypoint: Option<Waypoint>

The waypoint where the vehicle departs after completing this VisitRequest. Can be omitted if it is the same as arrival_waypoint. If the shipment model has duration distance matrices, departure_waypoint must not be specified.

tags: Vec<String>

Specifies tags attached to the visit request. Empty or duplicate strings are not allowed.

time_windows: Vec<TimeWindow>

Time windows which constrain the arrival time at a visit. Note that a vehicle may depart outside of the arrival time window, i.e. arrival time + duration do not need to be inside a time window. This can result in waiting time if the vehicle arrives before [TimeWindow.start_time][google.maps.routeoptimization.v1.TimeWindow.start_time].

The absence of TimeWindow means that the vehicle can perform this visit at any time.

Time windows must be disjoint, i.e. no time window must overlap with or be adjacent to another, and they must be in increasing order.

cost_per_hour_after_soft_end_time and soft_end_time can only be set if there is a single time window.

duration: Option<Duration>

Duration of the visit, i.e. time spent by the vehicle between arrival and departure (to be added to the possible waiting time; see time_windows).

cost: f64

Cost to service this visit request on a vehicle route. This can be used to pay different costs for each alternative pickup or delivery of a shipment. This cost must be in the same unit as Shipment.penalty_cost and must not be negative.

load_demands: HashMap<String, Load>

Load demands of this visit request. This is just like [Shipment.load_demands][google.maps.routeoptimization.v1.Shipment.load_demands] field, except that it only applies to this [VisitRequest][google.maps.routeoptimization.v1.Shipment.VisitRequest] instead of the whole [Shipment][google.maps.routeoptimization.v1.Shipment]. The demands listed here are added to the demands listed in [Shipment.load_demands][google.maps.routeoptimization.v1.Shipment.load_demands].

visit_types: Vec<String>

Specifies the types of the visit. This may be used to allocate additional time required for a vehicle to complete this visit (see [Vehicle.extra_visit_duration_for_visit_type][google.maps.routeoptimization.v1.Vehicle.extra_visit_duration_for_visit_type]).

A type can only appear once.

label: String

Specifies a label for this VisitRequest. This label is reported in the response as visit_label in the corresponding [ShipmentRoute.Visit][google.maps.routeoptimization.v1.ShipmentRoute.Visit].

Trait Implementations

impl Clone for VisitRequest

fn clone(&self) -> VisitRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VisitRequest

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

Formats the value using the given formatter.

impl Default for VisitRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for VisitRequest

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

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

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

where Self: Default,

Decodes an instance of the message from a buffer.

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

where Self: Default,

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

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

where Self: Sized,

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

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

where Self: Sized,

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

impl PartialEq for VisitRequest

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for VisitRequest