Struct AggregatedMetrics 

#[non_exhaustive]
pub struct AggregatedMetrics {
    pub performed_shipment_count: i32,
    pub travel_duration: Option<Duration>,
    pub wait_duration: Option<Duration>,
    pub delay_duration: Option<Duration>,
    pub break_duration: Option<Duration>,
    pub visit_duration: Option<Duration>,
    pub total_duration: Option<Duration>,
    pub travel_distance_meters: f64,
    pub max_loads: HashMap<String, VehicleLoad>,
    pub costs: HashMap<String, f64>,
    pub total_cost: f64,
    /* private fields */
}

Aggregated metrics for ShipmentRoute (resp. for OptimizeToursResponse over all Transition and/or Visit (resp. over all ShipmentRoute) elements.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

performed_shipment_count: i32

Number of shipments performed. Note that a pickup and delivery pair only counts once.

travel_duration: Option<Duration>

Total travel duration for a route or a solution.

wait_duration: Option<Duration>

Total wait duration for a route or a solution.

delay_duration: Option<Duration>

Total delay duration for a route or a solution.

break_duration: Option<Duration>

Total break duration for a route or a solution.

visit_duration: Option<Duration>

Total visit duration for a route or a solution.

total_duration: Option<Duration>

The total duration should be equal to the sum of all durations above. For routes, it also corresponds to: ShipmentRoute.vehicle_end_time - ShipmentRoute.vehicle_start_time

travel_distance_meters: f64

Total travel distance for a route or a solution.

max_loads: HashMap<String, VehicleLoad>

Maximum load achieved over the entire route (resp. solution), for each of the quantities on this route (resp. solution), computed as the maximum over all Transition.vehicle_loads (resp. ShipmentRoute.metrics.max_loads.

costs: HashMap<String, f64>

👎Deprecated

Deprecated: Use ShipmentRoute.route_costs and OptimizeToursResponse.Metrics.costs instead.

total_cost: f64

👎Deprecated

Deprecated: Use ShipmentRoute.route_total_cost and OptimizeToursResponse.Metrics.total_cost instead.

Implementations

impl AggregatedMetrics

pub fn new() -> Self

Creates a new default instance.

pub fn set_performed_shipment_count<T: Into<i32>>(self, v: T) -> Self

Sets the value of performed_shipment_count.

Example

let x = AggregatedMetrics::new().set_performed_shipment_count(42);

pub fn set_travel_duration<T>(self, v: T) -> Self

where T: Into<Duration>,

Sets the value of travel_duration.

Example

use wkt::Duration;
let x = AggregatedMetrics::new().set_travel_duration(Duration::default()/* use setters */);

pub fn set_or_clear_travel_duration<T>(self, v: Option<T>) -> Self

where T: Into<Duration>,

Sets or clears the value of travel_duration.

Example

use wkt::Duration;
let x = AggregatedMetrics::new().set_or_clear_travel_duration(Some(Duration::default()/* use setters */));
let x = AggregatedMetrics::new().set_or_clear_travel_duration(None::<Duration>);

pub fn set_wait_duration<T>(self, v: T) -> Self

where T: Into<Duration>,

Sets the value of wait_duration.

Example

use wkt::Duration;
let x = AggregatedMetrics::new().set_wait_duration(Duration::default()/* use setters */);

pub fn set_or_clear_wait_duration<T>(self, v: Option<T>) -> Self

where T: Into<Duration>,

Sets or clears the value of wait_duration.

Example

use wkt::Duration;
let x = AggregatedMetrics::new().set_or_clear_wait_duration(Some(Duration::default()/* use setters */));
let x = AggregatedMetrics::new().set_or_clear_wait_duration(None::<Duration>);

pub fn set_delay_duration<T>(self, v: T) -> Self

where T: Into<Duration>,

Sets the value of delay_duration.

Example

use wkt::Duration;
let x = AggregatedMetrics::new().set_delay_duration(Duration::default()/* use setters */);

pub fn set_or_clear_delay_duration<T>(self, v: Option<T>) -> Self

where T: Into<Duration>,

Sets or clears the value of delay_duration.

Example

use wkt::Duration;
let x = AggregatedMetrics::new().set_or_clear_delay_duration(Some(Duration::default()/* use setters */));
let x = AggregatedMetrics::new().set_or_clear_delay_duration(None::<Duration>);

pub fn set_break_duration<T>(self, v: T) -> Self

where T: Into<Duration>,

Sets the value of break_duration.

Example

use wkt::Duration;
let x = AggregatedMetrics::new().set_break_duration(Duration::default()/* use setters */);

pub fn set_or_clear_break_duration<T>(self, v: Option<T>) -> Self

where T: Into<Duration>,

Sets or clears the value of break_duration.

Example

use wkt::Duration;
let x = AggregatedMetrics::new().set_or_clear_break_duration(Some(Duration::default()/* use setters */));
let x = AggregatedMetrics::new().set_or_clear_break_duration(None::<Duration>);

pub fn set_visit_duration<T>(self, v: T) -> Self

where T: Into<Duration>,

Sets the value of visit_duration.

Example

use wkt::Duration;
let x = AggregatedMetrics::new().set_visit_duration(Duration::default()/* use setters */);

pub fn set_or_clear_visit_duration<T>(self, v: Option<T>) -> Self

where T: Into<Duration>,

Sets or clears the value of visit_duration.

Example

use wkt::Duration;
let x = AggregatedMetrics::new().set_or_clear_visit_duration(Some(Duration::default()/* use setters */));
let x = AggregatedMetrics::new().set_or_clear_visit_duration(None::<Duration>);

pub fn set_total_duration<T>(self, v: T) -> Self

where T: Into<Duration>,

Sets the value of total_duration.

Example

use wkt::Duration;
let x = AggregatedMetrics::new().set_total_duration(Duration::default()/* use setters */);

pub fn set_or_clear_total_duration<T>(self, v: Option<T>) -> Self

where T: Into<Duration>,

Sets or clears the value of total_duration.

Example

use wkt::Duration;
let x = AggregatedMetrics::new().set_or_clear_total_duration(Some(Duration::default()/* use setters */));
let x = AggregatedMetrics::new().set_or_clear_total_duration(None::<Duration>);

pub fn set_travel_distance_meters<T: Into<f64>>(self, v: T) -> Self

Sets the value of travel_distance_meters.

Example

let x = AggregatedMetrics::new().set_travel_distance_meters(42.0);

pub fn set_max_loads<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<VehicleLoad>,

Sets the value of max_loads.

Example

use google_cloud_optimization_v1::model::shipment_route::VehicleLoad;
let x = AggregatedMetrics::new().set_max_loads([
    ("key0", VehicleLoad::default()/* use setters */),
    ("key1", VehicleLoad::default()/* use (different) setters */),
]);

pub fn set_costs<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<f64>,

👎Deprecated

Sets the value of costs.

Example

let x = AggregatedMetrics::new().set_costs([
    ("key0", 123.5),
    ("key1", 456.5),
]);

pub fn set_total_cost<T: Into<f64>>(self, v: T) -> Self

👎Deprecated

Sets the value of total_cost.

Example

let x = AggregatedMetrics::new().set_total_cost(42.0);

Trait Implementations

impl Clone for AggregatedMetrics

fn clone(&self) -> AggregatedMetrics

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AggregatedMetrics

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

Formats the value using the given formatter.

impl Default for AggregatedMetrics

fn default() -> AggregatedMetrics

Returns the “default value” for a type.

impl Message for AggregatedMetrics

fn typename() -> &'static str

The typename of this message.

impl PartialEq for AggregatedMetrics

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for AggregatedMetrics