com.google.maps.routing.v2.RouteOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-maps-routing-v2 Show documentation
Show all versions of proto-google-maps-routing-v2 Show documentation
Proto library for google-maps-routing
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/maps/routing/v2/route.proto
// Protobuf Java Version: 3.25.5
package com.google.maps.routing.v2;
public interface RouteOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.maps.routing.v2.Route)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Labels for the `Route` that are useful to identify specific properties
* of the route to compare against others.
*
*
* repeated .google.maps.routing.v2.RouteLabel route_labels = 13;
*
* @return A list containing the routeLabels.
*/
java.util.List getRouteLabelsList();
/**
*
*
*
* Labels for the `Route` that are useful to identify specific properties
* of the route to compare against others.
*
*
* repeated .google.maps.routing.v2.RouteLabel route_labels = 13;
*
* @return The count of routeLabels.
*/
int getRouteLabelsCount();
/**
*
*
*
* Labels for the `Route` that are useful to identify specific properties
* of the route to compare against others.
*
*
* repeated .google.maps.routing.v2.RouteLabel route_labels = 13;
*
* @param index The index of the element to return.
* @return The routeLabels at the given index.
*/
com.google.maps.routing.v2.RouteLabel getRouteLabels(int index);
/**
*
*
*
* Labels for the `Route` that are useful to identify specific properties
* of the route to compare against others.
*
*
* repeated .google.maps.routing.v2.RouteLabel route_labels = 13;
*
* @return A list containing the enum numeric values on the wire for routeLabels.
*/
java.util.List getRouteLabelsValueList();
/**
*
*
*
* Labels for the `Route` that are useful to identify specific properties
* of the route to compare against others.
*
*
* repeated .google.maps.routing.v2.RouteLabel route_labels = 13;
*
* @param index The index of the value to return.
* @return The enum numeric value on the wire of routeLabels at the given index.
*/
int getRouteLabelsValue(int index);
/**
*
*
*
* A collection of legs (path segments between waypoints) that make up the
* route. Each leg corresponds to the trip between two non-`via`
* [`Waypoints`][google.maps.routing.v2.Waypoint]. For example, a route with
* no intermediate waypoints has only one leg. A route that includes one
* non-`via` intermediate waypoint has two legs. A route that includes one
* `via` intermediate waypoint has one leg. The order of the legs matches the
* order of waypoints from `origin` to `intermediates` to `destination`.
*
*
* repeated .google.maps.routing.v2.RouteLeg legs = 1;
*/
java.util.List getLegsList();
/**
*
*
*
* A collection of legs (path segments between waypoints) that make up the
* route. Each leg corresponds to the trip between two non-`via`
* [`Waypoints`][google.maps.routing.v2.Waypoint]. For example, a route with
* no intermediate waypoints has only one leg. A route that includes one
* non-`via` intermediate waypoint has two legs. A route that includes one
* `via` intermediate waypoint has one leg. The order of the legs matches the
* order of waypoints from `origin` to `intermediates` to `destination`.
*
*
* repeated .google.maps.routing.v2.RouteLeg legs = 1;
*/
com.google.maps.routing.v2.RouteLeg getLegs(int index);
/**
*
*
*
* A collection of legs (path segments between waypoints) that make up the
* route. Each leg corresponds to the trip between two non-`via`
* [`Waypoints`][google.maps.routing.v2.Waypoint]. For example, a route with
* no intermediate waypoints has only one leg. A route that includes one
* non-`via` intermediate waypoint has two legs. A route that includes one
* `via` intermediate waypoint has one leg. The order of the legs matches the
* order of waypoints from `origin` to `intermediates` to `destination`.
*
*
* repeated .google.maps.routing.v2.RouteLeg legs = 1;
*/
int getLegsCount();
/**
*
*
*
* A collection of legs (path segments between waypoints) that make up the
* route. Each leg corresponds to the trip between two non-`via`
* [`Waypoints`][google.maps.routing.v2.Waypoint]. For example, a route with
* no intermediate waypoints has only one leg. A route that includes one
* non-`via` intermediate waypoint has two legs. A route that includes one
* `via` intermediate waypoint has one leg. The order of the legs matches the
* order of waypoints from `origin` to `intermediates` to `destination`.
*
*
* repeated .google.maps.routing.v2.RouteLeg legs = 1;
*/
java.util.List getLegsOrBuilderList();
/**
*
*
*
* A collection of legs (path segments between waypoints) that make up the
* route. Each leg corresponds to the trip between two non-`via`
* [`Waypoints`][google.maps.routing.v2.Waypoint]. For example, a route with
* no intermediate waypoints has only one leg. A route that includes one
* non-`via` intermediate waypoint has two legs. A route that includes one
* `via` intermediate waypoint has one leg. The order of the legs matches the
* order of waypoints from `origin` to `intermediates` to `destination`.
*
*
* repeated .google.maps.routing.v2.RouteLeg legs = 1;
*/
com.google.maps.routing.v2.RouteLegOrBuilder getLegsOrBuilder(int index);
/**
*
*
*
* The travel distance of the route, in meters.
*
*
* int32 distance_meters = 2;
*
* @return The distanceMeters.
*/
int getDistanceMeters();
/**
*
*
*
* The length of time needed to navigate the route. If you set the
* `routing_preference` to `TRAFFIC_UNAWARE`, then this value is the same as
* `static_duration`. If you set the `routing_preference` to either
* `TRAFFIC_AWARE` or `TRAFFIC_AWARE_OPTIMAL`, then this value is calculated
* taking traffic conditions into account.
*
*
* .google.protobuf.Duration duration = 3;
*
* @return Whether the duration field is set.
*/
boolean hasDuration();
/**
*
*
*
* The length of time needed to navigate the route. If you set the
* `routing_preference` to `TRAFFIC_UNAWARE`, then this value is the same as
* `static_duration`. If you set the `routing_preference` to either
* `TRAFFIC_AWARE` or `TRAFFIC_AWARE_OPTIMAL`, then this value is calculated
* taking traffic conditions into account.
*
*
* .google.protobuf.Duration duration = 3;
*
* @return The duration.
*/
com.google.protobuf.Duration getDuration();
/**
*
*
*
* The length of time needed to navigate the route. If you set the
* `routing_preference` to `TRAFFIC_UNAWARE`, then this value is the same as
* `static_duration`. If you set the `routing_preference` to either
* `TRAFFIC_AWARE` or `TRAFFIC_AWARE_OPTIMAL`, then this value is calculated
* taking traffic conditions into account.
*
*
* .google.protobuf.Duration duration = 3;
*/
com.google.protobuf.DurationOrBuilder getDurationOrBuilder();
/**
*
*
*
* The duration of travel through the route without taking traffic
* conditions into consideration.
*
*
* .google.protobuf.Duration static_duration = 4;
*
* @return Whether the staticDuration field is set.
*/
boolean hasStaticDuration();
/**
*
*
*
* The duration of travel through the route without taking traffic
* conditions into consideration.
*
*
* .google.protobuf.Duration static_duration = 4;
*
* @return The staticDuration.
*/
com.google.protobuf.Duration getStaticDuration();
/**
*
*
*
* The duration of travel through the route without taking traffic
* conditions into consideration.
*
*
* .google.protobuf.Duration static_duration = 4;
*/
com.google.protobuf.DurationOrBuilder getStaticDurationOrBuilder();
/**
*
*
*
* The overall route polyline. This polyline is the combined polyline of
* all `legs`.
*
*
* .google.maps.routing.v2.Polyline polyline = 5;
*
* @return Whether the polyline field is set.
*/
boolean hasPolyline();
/**
*
*
*
* The overall route polyline. This polyline is the combined polyline of
* all `legs`.
*
*
* .google.maps.routing.v2.Polyline polyline = 5;
*
* @return The polyline.
*/
com.google.maps.routing.v2.Polyline getPolyline();
/**
*
*
*
* The overall route polyline. This polyline is the combined polyline of
* all `legs`.
*
*
* .google.maps.routing.v2.Polyline polyline = 5;
*/
com.google.maps.routing.v2.PolylineOrBuilder getPolylineOrBuilder();
/**
*
*
*
* A description of the route.
*
*
* string description = 6;
*
* @return The description.
*/
java.lang.String getDescription();
/**
*
*
*
* A description of the route.
*
*
* string description = 6;
*
* @return The bytes for description.
*/
com.google.protobuf.ByteString getDescriptionBytes();
/**
*
*
*
* An array of warnings to show when displaying the route.
*
*
* repeated string warnings = 7;
*
* @return A list containing the warnings.
*/
java.util.List getWarningsList();
/**
*
*
*
* An array of warnings to show when displaying the route.
*
*
* repeated string warnings = 7;
*
* @return The count of warnings.
*/
int getWarningsCount();
/**
*
*
*
* An array of warnings to show when displaying the route.
*
*
* repeated string warnings = 7;
*
* @param index The index of the element to return.
* @return The warnings at the given index.
*/
java.lang.String getWarnings(int index);
/**
*
*
*
* An array of warnings to show when displaying the route.
*
*
* repeated string warnings = 7;
*
* @param index The index of the value to return.
* @return The bytes of the warnings at the given index.
*/
com.google.protobuf.ByteString getWarningsBytes(int index);
/**
*
*
*
* The viewport bounding box of the polyline.
*
*
* .google.geo.type.Viewport viewport = 8;
*
* @return Whether the viewport field is set.
*/
boolean hasViewport();
/**
*
*
*
* The viewport bounding box of the polyline.
*
*
* .google.geo.type.Viewport viewport = 8;
*
* @return The viewport.
*/
com.google.geo.type.Viewport getViewport();
/**
*
*
*
* The viewport bounding box of the polyline.
*
*
* .google.geo.type.Viewport viewport = 8;
*/
com.google.geo.type.ViewportOrBuilder getViewportOrBuilder();
/**
*
*
*
* Additional information about the route.
*
*
* .google.maps.routing.v2.RouteTravelAdvisory travel_advisory = 9;
*
* @return Whether the travelAdvisory field is set.
*/
boolean hasTravelAdvisory();
/**
*
*
*
* Additional information about the route.
*
*
* .google.maps.routing.v2.RouteTravelAdvisory travel_advisory = 9;
*
* @return The travelAdvisory.
*/
com.google.maps.routing.v2.RouteTravelAdvisory getTravelAdvisory();
/**
*
*
*
* Additional information about the route.
*
*
* .google.maps.routing.v2.RouteTravelAdvisory travel_advisory = 9;
*/
com.google.maps.routing.v2.RouteTravelAdvisoryOrBuilder getTravelAdvisoryOrBuilder();
/**
*
*
*
* If you set
* [`optimize_waypoint_order`][google.maps.routing.v2.ComputeRoutesRequest.optimize_waypoint_order]
* to true, this field contains the optimized ordering of intermediate
* waypoints. Otherwise, this field is empty.
* For example, if you give an input of Origin: LA; Intermediate waypoints:
* Dallas, Bangor, Phoenix; Destination: New York; and the optimized
* intermediate waypoint order is Phoenix, Dallas, Bangor, then this field
* contains the values [2, 0, 1]. The index starts with 0 for the first
* intermediate waypoint provided in the input.
*
*
* repeated int32 optimized_intermediate_waypoint_index = 10;
*
* @return A list containing the optimizedIntermediateWaypointIndex.
*/
java.util.List getOptimizedIntermediateWaypointIndexList();
/**
*
*
*
* If you set
* [`optimize_waypoint_order`][google.maps.routing.v2.ComputeRoutesRequest.optimize_waypoint_order]
* to true, this field contains the optimized ordering of intermediate
* waypoints. Otherwise, this field is empty.
* For example, if you give an input of Origin: LA; Intermediate waypoints:
* Dallas, Bangor, Phoenix; Destination: New York; and the optimized
* intermediate waypoint order is Phoenix, Dallas, Bangor, then this field
* contains the values [2, 0, 1]. The index starts with 0 for the first
* intermediate waypoint provided in the input.
*
*
* repeated int32 optimized_intermediate_waypoint_index = 10;
*
* @return The count of optimizedIntermediateWaypointIndex.
*/
int getOptimizedIntermediateWaypointIndexCount();
/**
*
*
*
* If you set
* [`optimize_waypoint_order`][google.maps.routing.v2.ComputeRoutesRequest.optimize_waypoint_order]
* to true, this field contains the optimized ordering of intermediate
* waypoints. Otherwise, this field is empty.
* For example, if you give an input of Origin: LA; Intermediate waypoints:
* Dallas, Bangor, Phoenix; Destination: New York; and the optimized
* intermediate waypoint order is Phoenix, Dallas, Bangor, then this field
* contains the values [2, 0, 1]. The index starts with 0 for the first
* intermediate waypoint provided in the input.
*
*
* repeated int32 optimized_intermediate_waypoint_index = 10;
*
* @param index The index of the element to return.
* @return The optimizedIntermediateWaypointIndex at the given index.
*/
int getOptimizedIntermediateWaypointIndex(int index);
/**
*
*
*
* Text representations of properties of the `Route`.
*
*
* .google.maps.routing.v2.Route.RouteLocalizedValues localized_values = 11;
*
* @return Whether the localizedValues field is set.
*/
boolean hasLocalizedValues();
/**
*
*
*
* Text representations of properties of the `Route`.
*
*
* .google.maps.routing.v2.Route.RouteLocalizedValues localized_values = 11;
*
* @return The localizedValues.
*/
com.google.maps.routing.v2.Route.RouteLocalizedValues getLocalizedValues();
/**
*
*
*
* Text representations of properties of the `Route`.
*
*
* .google.maps.routing.v2.Route.RouteLocalizedValues localized_values = 11;
*/
com.google.maps.routing.v2.Route.RouteLocalizedValuesOrBuilder getLocalizedValuesOrBuilder();
/**
*
*
*
* An opaque token that can be passed to [Navigation
* SDK](https://developers.google.com/maps/documentation/navigation) to
* reconstruct the route during navigation, and, in the event of rerouting,
* honor the original intention when the route was created. Treat this token
* as an opaque blob. Don't compare its value across requests as its value
* may change even if the service returns the exact same route.
*
* NOTE: `Route.route_token` is only available for requests that have set
* `ComputeRoutesRequest.routing_preference` to `TRAFFIC_AWARE` or
* `TRAFFIC_AWARE_OPTIMAL`. `Route.route_token` is not supported for requests
* that have Via waypoints.
*
*
* string route_token = 12;
*
* @return The routeToken.
*/
java.lang.String getRouteToken();
/**
*
*
*
* An opaque token that can be passed to [Navigation
* SDK](https://developers.google.com/maps/documentation/navigation) to
* reconstruct the route during navigation, and, in the event of rerouting,
* honor the original intention when the route was created. Treat this token
* as an opaque blob. Don't compare its value across requests as its value
* may change even if the service returns the exact same route.
*
* NOTE: `Route.route_token` is only available for requests that have set
* `ComputeRoutesRequest.routing_preference` to `TRAFFIC_AWARE` or
* `TRAFFIC_AWARE_OPTIMAL`. `Route.route_token` is not supported for requests
* that have Via waypoints.
*
*
* string route_token = 12;
*
* @return The bytes for routeToken.
*/
com.google.protobuf.ByteString getRouteTokenBytes();
/**
*
*
*
* Contains information about details along the polyline.
*
*
* .google.maps.routing.v2.PolylineDetails polyline_details = 14;
*
* @return Whether the polylineDetails field is set.
*/
boolean hasPolylineDetails();
/**
*
*
*
* Contains information about details along the polyline.
*
*
* .google.maps.routing.v2.PolylineDetails polyline_details = 14;
*
* @return The polylineDetails.
*/
com.google.maps.routing.v2.PolylineDetails getPolylineDetails();
/**
*
*
*
* Contains information about details along the polyline.
*
*
* .google.maps.routing.v2.PolylineDetails polyline_details = 14;
*/
com.google.maps.routing.v2.PolylineDetailsOrBuilder getPolylineDetailsOrBuilder();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy