Struct googapis::google::maps::routes::v1alpha::routes_alpha_client::RoutesAlphaClient

pub struct RoutesAlphaClient<T> { /* fields omitted */ }

The Routes Preferred API.

Implementations

impl<T> RoutesAlphaClient<T> where
    T: GrpcService<BoxBody>,
    T::ResponseBody: Body + Send + 'static,
    T::Error: Into<StdError>,
    <T::ResponseBody as Body>::Error: Into<StdError> + Send, 

pub fn new(inner: T) -> Self

pub fn with_interceptor<F>(
    inner: T,
    interceptor: F
) -> RoutesAlphaClient<InterceptedService<T, F>> where
    F: Interceptor,
    T: Service<Request<BoxBody>, Response = Response<<T as GrpcService<BoxBody>>::ResponseBody>>,
    <T as Service<Request<BoxBody>>>::Error: Into<StdError> + Send + Sync, 

pub fn send_gzip(self) -> Self

Compress requests with gzip.

This requires the server to support it otherwise it might respond with an error.

pub fn accept_gzip(self) -> Self

Enable decompressing responses with gzip.

pub async fn compute_routes(
    &mut self,
    request: impl IntoRequest<ComputeRoutesRequest>
) -> Result<Response<ComputeRoutesResponse>, Status>

Returns the primary route along with optional alternate routes, given a set of terminal and intermediate waypoints.

NOTE: This method requires that you specify a response field mask in the input. You can provide the response field mask by using the URL parameter $fields or fields, or by using the HTTP/gRPC header X-Goog-FieldMask (see the available URL parameters and headers. The value is a comma separated list of field paths. See this detailed documentation about how to construct the field paths.

For example, in this method:

• Field mask of all available fields (for manual inspection): X-Goog-FieldMask: *
• Field mask of Route-level duration, distance, and polyline (an example production setup): X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.polyline.encodedPolyline

Google discourages the use of the wildcard (*) response field mask, or specifying the field mask at the top level (routes), because:

• Selecting only the fields that you need helps our server save computation cycles, allowing us to return the result to you with a lower latency.
• Selecting only the fields that you need in your production job ensures stable latency performance. We might add more response fields in the future, and those new fields might require extra computation time. If you select all fields, or if you select all fields at the top level, then you might experience performance degradation because any new field we add will be automatically included in the response.
• Selecting only the fields that you need results in a smaller response size, and thus higher network throughput.

pub async fn compute_route_matrix(
    &mut self,
    request: impl IntoRequest<ComputeRouteMatrixRequest>
) -> Result<Response<Streaming<RouteMatrixElement>>, Status>

Takes in a list of origins and destinations and returns a stream containing route information for each combination of origin and destination.

NOTE: This method requires that you specify a response field mask in the input. You can provide the response field mask by using the URL parameter $fields or fields, or by using the HTTP/gRPC header X-Goog-FieldMask (see the available URL parameters and headers. The value is a comma separated list of field paths. See this detailed documentation about how to construct the field paths.

For example, in this method:

• Field mask of all available fields (for manual inspection): X-Goog-FieldMask: *
• Field mask of route durations, distances, element status, condition, and element indices (an example production setup): X-Goog-FieldMask: originIndex,destinationIndex,status,condition,distanceMeters,duration

It is critical that you include status in your field mask as otherwise all messages will appear to be OK. Google discourages the use of the wildcard (*) response field mask, because:

• Selecting only the fields that you need helps our server save computation cycles, allowing us to return the result to you with a lower latency.
• Selecting only the fields that you need in your production job ensures stable latency performance. We might add more response fields in the future, and those new fields might require extra computation time. If you select all fields, or if you select all fields at the top level, then you might experience performance degradation because any new field we add will be automatically included in the response.
• Selecting only the fields that you need results in a smaller response size, and thus higher network throughput.

pub async fn compute_custom_routes(
    &mut self,
    request: impl IntoRequest<ComputeCustomRoutesRequest>
) -> Result<Response<ComputeCustomRoutesResponse>, Status>

Given a set of terminal and intermediate waypoints, and a route objective, computes the best route for the route objective. Also returns fastest route and shortest route as reference routes.

NOTE: This method requires that you specify a response field mask in the input. You can provide the response field mask by using the URL parameter $fields or fields, or by using the HTTP/gRPC header X-Goog-FieldMask (see the available URL parameters and headers. The value is a comma separated list of field paths. See this detailed documentation about how to construct the field paths.

For example, in this method:

• Field mask of all available fields (for manual inspection): X-Goog-FieldMask: *
• Field mask of route distances, durations, token and toll info: X-Goog-FieldMask: routes.route.distanceMeters,routes.route.duration,routes.token,routes.route.travelAdvisory.tollInfo

Google discourages the use of the wildcard (*) response field mask, or specifying the field mask at the top level (routes), because:

• Selecting only the fields that you need helps our server save computation cycles, allowing us to return the result to you with a lower latency.
• Selecting only the fields that you need in your production job ensures stable latency performance. We might add more response fields in the future, and those new fields might require extra computation time. If you select all fields, or if you select all fields at the top level, then you might experience performance degradation because any new field we add will be automatically included in the response.
• Selecting only the fields that you need results in a smaller response size, and thus higher network throughput.

Trait Implementations

impl<T: Clone> Clone for RoutesAlphaClient<T>

fn clone(&self) -> RoutesAlphaClient<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for RoutesAlphaClient<T>

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

Formats the value using the given formatter.