Struct google_api_proto::google::maps::routes::v1::ComputeCustomRoutesRequest

pub struct ComputeCustomRoutesRequest {
    pub origin: Option<Waypoint>,
    pub destination: Option<Waypoint>,
    pub intermediates: Vec<Waypoint>,
    pub travel_mode: i32,
    pub routing_preference: i32,
    pub polyline_quality: i32,
    pub polyline_encoding: i32,
    pub departure_time: Option<Timestamp>,
    pub route_modifiers: Option<RouteModifiers>,
    pub route_objective: Option<RouteObjective>,
    pub language_code: String,
    pub units: i32,
}

ComputeCustomRoutes request message.

Fields

origin: Option<Waypoint>

Required. Origin waypoint.

destination: Option<Waypoint>

Required. Destination waypoint.

intermediates: Vec<Waypoint>

Optional. A set of waypoints along the route (excluding terminal points), for either stopping at or passing by. Up to 25 intermediate waypoints are supported.

travel_mode: i32

Optional. Specifies the mode of transportation. Only DRIVE is supported now.

routing_preference: i32

Optional. Specifies how to compute the route. The server attempts to use the selected routing preference to compute the route. If the routing preference results in an error or an extra long latency, then an error is returned. In the future, we might implement a fallback mechanism to use a different option when the preferred option does not give a valid result. You can specify this option only when the travel_mode is DRIVE or TWO_WHEELER, otherwise the request fails.

polyline_quality: i32

Optional. Specifies your preference for the quality of the polyline.

polyline_encoding: i32

Optional. Specifies the preferred encoding for the polyline.

departure_time: Option<Timestamp>

Optional. The departure time. If you don’t set this value, then this value defaults to the time that you made the request. If you set this value to a time that has already occurred, then the request fails.

route_modifiers: Option<RouteModifiers>

Optional. A set of conditions to satisfy that affect the way routes are calculated.

route_objective: Option<RouteObjective>

Required. A route objective to optimize for.

language_code: String

Optional. The BCP-47 language code, such as “en-US” or “sr-Latn”. For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. See Language Support for the list of supported languages. When you don’t provide this value, the display language is inferred from the location of the route request.

units: i32

Optional. Specifies the units of measure for the display fields. This includes the instruction field in NavigationInstruction. The units of measure used for the route, leg, step distance, and duration are not affected by this value. If you don’t provide this value, then the display units are inferred from the location of the request.

Implementations

impl ComputeCustomRoutesRequest

pub fn travel_mode(&self) -> RouteTravelMode

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

pub fn set_travel_mode(&mut self, value: RouteTravelMode)

Sets travel_mode to the provided enum value.

pub fn routing_preference(&self) -> RoutingPreference

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

pub fn set_routing_preference(&mut self, value: RoutingPreference)

Sets routing_preference to the provided enum value.

pub fn polyline_quality(&self) -> PolylineQuality

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

pub fn set_polyline_quality(&mut self, value: PolylineQuality)

Sets polyline_quality to the provided enum value.

pub fn units(&self) -> Units

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

pub fn set_units(&mut self, value: Units)

Sets units to the provided enum value.

pub fn polyline_encoding(&self) -> PolylineEncoding

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

pub fn set_polyline_encoding(&mut self, value: PolylineEncoding)

Sets polyline_encoding to the provided enum value.

Trait Implementations

impl Clone for ComputeCustomRoutesRequest

fn clone(&self) -> ComputeCustomRoutesRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ComputeCustomRoutesRequest

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

Formats the value using the given formatter.

impl Default for ComputeCustomRoutesRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for ComputeCustomRoutesRequest

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 ComputeCustomRoutesRequest

fn eq(&self, other: &ComputeCustomRoutesRequest) -> 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 ComputeCustomRoutesRequest