Package com.google.maps.routing.v2

Interface ComputeRoutesRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ComputeRoutesRequest, ComputeRoutesRequest.Builder
    public interface ComputeRoutesRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • hasOrigin

        boolean hasOrigin()
         Required. Origin waypoint.
        .google.maps.routing.v2.Waypoint origin = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        Whether the origin field is set.

      • getOrigin

        Waypoint getOrigin()
         Required. Origin waypoint.
        .google.maps.routing.v2.Waypoint origin = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The origin.

      • getOriginOrBuilder

        WaypointOrBuilder getOriginOrBuilder()
         Required. Origin waypoint.
        .google.maps.routing.v2.Waypoint origin = 1 [(.google.api.field_behavior) = REQUIRED];

      • hasDestination

        boolean hasDestination()
         Required. Destination waypoint.
        .google.maps.routing.v2.Waypoint destination = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        Whether the destination field is set.

      • getDestination

        Waypoint getDestination()
         Required. Destination waypoint.
        .google.maps.routing.v2.Waypoint destination = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The destination.

      • getDestinationOrBuilder

        WaypointOrBuilder getDestinationOrBuilder()
         Required. Destination waypoint.
        .google.maps.routing.v2.Waypoint destination = 2 [(.google.api.field_behavior) = REQUIRED];

      • getIntermediatesList

        List<Waypoint> getIntermediatesList()
         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.
        repeated .google.maps.routing.v2.Waypoint intermediates = 3 [(.google.api.field_behavior) = OPTIONAL];

      • getIntermediates

        Waypoint getIntermediates​(int index)
         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.
        repeated .google.maps.routing.v2.Waypoint intermediates = 3 [(.google.api.field_behavior) = OPTIONAL];

      • getIntermediatesCount

        int getIntermediatesCount()
         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.
        repeated .google.maps.routing.v2.Waypoint intermediates = 3 [(.google.api.field_behavior) = OPTIONAL];

      • getIntermediatesOrBuilderList

        List<? extends WaypointOrBuilder> getIntermediatesOrBuilderList()
         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.
        repeated .google.maps.routing.v2.Waypoint intermediates = 3 [(.google.api.field_behavior) = OPTIONAL];

      • getIntermediatesOrBuilder

        WaypointOrBuilder getIntermediatesOrBuilder​(int index)
         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.
        repeated .google.maps.routing.v2.Waypoint intermediates = 3 [(.google.api.field_behavior) = OPTIONAL];

      • getTravelModeValue

        int getTravelModeValue()
         Optional. Specifies the mode of transportation.
        .google.maps.routing.v2.RouteTravelMode travel_mode = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The enum numeric value on the wire for travelMode.

      • getTravelMode

        RouteTravelMode getTravelMode()
         Optional. Specifies the mode of transportation.
        .google.maps.routing.v2.RouteTravelMode travel_mode = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The travelMode.

      • getRoutingPreferenceValue

        int getRoutingPreferenceValue()
         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. You can specify this option only when the
 `travel_mode` is `DRIVE` or `TWO_WHEELER`, otherwise the request fails.
        .google.maps.routing.v2.RoutingPreference routing_preference = 5 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The enum numeric value on the wire for routingPreference.

      • getRoutingPreference

        RoutingPreference getRoutingPreference()
         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. You can specify this option only when the
 `travel_mode` is `DRIVE` or `TWO_WHEELER`, otherwise the request fails.
        .google.maps.routing.v2.RoutingPreference routing_preference = 5 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The routingPreference.

      • getPolylineQualityValue

        int getPolylineQualityValue()
         Optional. Specifies your preference for the quality of the polyline.
        .google.maps.routing.v2.PolylineQuality polyline_quality = 6 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The enum numeric value on the wire for polylineQuality.

      • getPolylineQuality

        PolylineQuality getPolylineQuality()
         Optional. Specifies your preference for the quality of the polyline.
        .google.maps.routing.v2.PolylineQuality polyline_quality = 6 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The polylineQuality.

      • getPolylineEncodingValue

        int getPolylineEncodingValue()
         Optional. Specifies the preferred encoding for the polyline.
        .google.maps.routing.v2.PolylineEncoding polyline_encoding = 12 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The enum numeric value on the wire for polylineEncoding.

      • getPolylineEncoding

        PolylineEncoding getPolylineEncoding()
         Optional. Specifies the preferred encoding for the polyline.
        .google.maps.routing.v2.PolylineEncoding polyline_encoding = 12 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The polylineEncoding.

      • hasDepartureTime

        boolean hasDepartureTime()
         Optional. The departure time. If you don't set this value, then this value
 defaults to the time that you made the request.
 NOTE: You can only specify a `departure_time` in the past when
 [RouteTravelMode][google.maps.routing.v2.RouteTravelMode] is set to
 `TRANSIT`.
        .google.protobuf.Timestamp departure_time = 7 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the departureTime field is set.

      • getDepartureTime

        com.google.protobuf.Timestamp getDepartureTime()
         Optional. The departure time. If you don't set this value, then this value
 defaults to the time that you made the request.
 NOTE: You can only specify a `departure_time` in the past when
 [RouteTravelMode][google.maps.routing.v2.RouteTravelMode] is set to
 `TRANSIT`.
        .google.protobuf.Timestamp departure_time = 7 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The departureTime.

      • getDepartureTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getDepartureTimeOrBuilder()
         Optional. The departure time. If you don't set this value, then this value
 defaults to the time that you made the request.
 NOTE: You can only specify a `departure_time` in the past when
 [RouteTravelMode][google.maps.routing.v2.RouteTravelMode] is set to
 `TRANSIT`.
        .google.protobuf.Timestamp departure_time = 7 [(.google.api.field_behavior) = OPTIONAL];

      • hasArrivalTime

        boolean hasArrivalTime()
         Optional. The arrival time.
 NOTE: Can only be set when
 [RouteTravelMode][google.maps.routing.v2.RouteTravelMode] is set to
 `TRANSIT`. You can specify either departure_time or arrival_time, but not
 both.
        .google.protobuf.Timestamp arrival_time = 19 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the arrivalTime field is set.

      • getArrivalTime

        com.google.protobuf.Timestamp getArrivalTime()
         Optional. The arrival time.
 NOTE: Can only be set when
 [RouteTravelMode][google.maps.routing.v2.RouteTravelMode] is set to
 `TRANSIT`. You can specify either departure_time or arrival_time, but not
 both.
        .google.protobuf.Timestamp arrival_time = 19 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The arrivalTime.

      • getArrivalTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getArrivalTimeOrBuilder()
         Optional. The arrival time.
 NOTE: Can only be set when
 [RouteTravelMode][google.maps.routing.v2.RouteTravelMode] is set to
 `TRANSIT`. You can specify either departure_time or arrival_time, but not
 both.
        .google.protobuf.Timestamp arrival_time = 19 [(.google.api.field_behavior) = OPTIONAL];

      • getComputeAlternativeRoutes

        boolean getComputeAlternativeRoutes()
         Optional. Specifies whether to calculate alternate routes in addition to
 the route. No alternative routes are returned for requests that have
 intermediate waypoints.
        bool compute_alternative_routes = 8 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The computeAlternativeRoutes.

      • hasRouteModifiers

        boolean hasRouteModifiers()
         Optional. A set of conditions to satisfy that affect the way routes are
 calculated.
        .google.maps.routing.v2.RouteModifiers route_modifiers = 9 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the routeModifiers field is set.

      • getRouteModifiers

        RouteModifiers getRouteModifiers()
         Optional. A set of conditions to satisfy that affect the way routes are
 calculated.
        .google.maps.routing.v2.RouteModifiers route_modifiers = 9 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The routeModifiers.

      • getRouteModifiersOrBuilder

        RouteModifiersOrBuilder getRouteModifiersOrBuilder()
         Optional. A set of conditions to satisfy that affect the way routes are
 calculated.
        .google.maps.routing.v2.RouteModifiers route_modifiers = 9 [(.google.api.field_behavior) = OPTIONAL];

      • getLanguageCode

        String getLanguageCode()
         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](https://developers.google.com/maps/faq#languagesupport)
 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.
        string language_code = 10 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The languageCode.

      • getLanguageCodeBytes

        com.google.protobuf.ByteString getLanguageCodeBytes()
         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](https://developers.google.com/maps/faq#languagesupport)
 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.
        string language_code = 10 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for languageCode.

      • getRegionCode

        String getRegionCode()
         Optional. The region code, specified as a ccTLD ("top-level domain")
 two-character value. For more information see
 https://en.wikipedia.org/wiki/List_of_Internet_top-level_domains#Country_code_top-level_domains
        string region_code = 16 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The regionCode.

      • getRegionCodeBytes

        com.google.protobuf.ByteString getRegionCodeBytes()
         Optional. The region code, specified as a ccTLD ("top-level domain")
 two-character value. For more information see
 https://en.wikipedia.org/wiki/List_of_Internet_top-level_domains#Country_code_top-level_domains
        string region_code = 16 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for regionCode.

      • getUnitsValue

        int getUnitsValue()
         Optional. Specifies the units of measure for the display fields. These
 fields include the `instruction` field in
 [NavigationInstruction][google.maps.routing.v2.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 first origin.
        .google.maps.routing.v2.Units units = 11 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The enum numeric value on the wire for units.

      • getUnits

        Units getUnits()
         Optional. Specifies the units of measure for the display fields. These
 fields include the `instruction` field in
 [NavigationInstruction][google.maps.routing.v2.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 first origin.
        .google.maps.routing.v2.Units units = 11 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The units.

      • getOptimizeWaypointOrder

        boolean getOptimizeWaypointOrder()
         Optional. If set to true, the service attempts to minimize the overall cost
 of the route by re-ordering the specified intermediate waypoints. The
 request fails if any of the intermediate waypoints is a `via` waypoint. Use
 `ComputeRoutesResponse.Routes.optimized_intermediate_waypoint_index` to
 find the new ordering.
 If `ComputeRoutesResponseroutes.optimized_intermediate_waypoint_index` is
 not requested in the `X-Goog-FieldMask` header, the request fails.
 If `optimize_waypoint_order` is set to false,
 `ComputeRoutesResponse.optimized_intermediate_waypoint_index` will be
 empty.
        bool optimize_waypoint_order = 13 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The optimizeWaypointOrder.

      • getRequestedReferenceRoutesList

        List<ComputeRoutesRequest.ReferenceRoute> getRequestedReferenceRoutesList()
         Optional. Specifies what reference routes to calculate as part of the
 request in addition to the default route. A reference route is a route with
 a different route calculation objective than the default route. For example
 a `FUEL_EFFICIENT` reference route calculation takes into account various
 parameters that would generate an optimal fuel efficient route.
        repeated .google.maps.routing.v2.ComputeRoutesRequest.ReferenceRoute requested_reference_routes = 14 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        A list containing the requestedReferenceRoutes.

      • getRequestedReferenceRoutesCount

        int getRequestedReferenceRoutesCount()
         Optional. Specifies what reference routes to calculate as part of the
 request in addition to the default route. A reference route is a route with
 a different route calculation objective than the default route. For example
 a `FUEL_EFFICIENT` reference route calculation takes into account various
 parameters that would generate an optimal fuel efficient route.
        repeated .google.maps.routing.v2.ComputeRoutesRequest.ReferenceRoute requested_reference_routes = 14 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The count of requestedReferenceRoutes.

      • getRequestedReferenceRoutes

        ComputeRoutesRequest.ReferenceRoute getRequestedReferenceRoutes​(int index)
         Optional. Specifies what reference routes to calculate as part of the
 request in addition to the default route. A reference route is a route with
 a different route calculation objective than the default route. For example
 a `FUEL_EFFICIENT` reference route calculation takes into account various
 parameters that would generate an optimal fuel efficient route.
        repeated .google.maps.routing.v2.ComputeRoutesRequest.ReferenceRoute requested_reference_routes = 14 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        index - The index of the element to return.
        Returns:
        The requestedReferenceRoutes at the given index.

      • getRequestedReferenceRoutesValueList

        List<Integer> getRequestedReferenceRoutesValueList()
         Optional. Specifies what reference routes to calculate as part of the
 request in addition to the default route. A reference route is a route with
 a different route calculation objective than the default route. For example
 a `FUEL_EFFICIENT` reference route calculation takes into account various
 parameters that would generate an optimal fuel efficient route.
        repeated .google.maps.routing.v2.ComputeRoutesRequest.ReferenceRoute requested_reference_routes = 14 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        A list containing the enum numeric values on the wire for requestedReferenceRoutes.

      • getRequestedReferenceRoutesValue

        int getRequestedReferenceRoutesValue​(int index)
         Optional. Specifies what reference routes to calculate as part of the
 request in addition to the default route. A reference route is a route with
 a different route calculation objective than the default route. For example
 a `FUEL_EFFICIENT` reference route calculation takes into account various
 parameters that would generate an optimal fuel efficient route.
        repeated .google.maps.routing.v2.ComputeRoutesRequest.ReferenceRoute requested_reference_routes = 14 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of requestedReferenceRoutes at the given index.

      • getExtraComputationsList

        List<ComputeRoutesRequest.ExtraComputation> getExtraComputationsList()
         Optional. A list of extra computations which may be used to complete the
 request. Note: These extra computations may return extra fields on the
 response. These extra fields must also be specified in the field mask to be
 returned in the response.
        repeated .google.maps.routing.v2.ComputeRoutesRequest.ExtraComputation extra_computations = 15 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        A list containing the extraComputations.

      • getExtraComputationsCount

        int getExtraComputationsCount()
         Optional. A list of extra computations which may be used to complete the
 request. Note: These extra computations may return extra fields on the
 response. These extra fields must also be specified in the field mask to be
 returned in the response.
        repeated .google.maps.routing.v2.ComputeRoutesRequest.ExtraComputation extra_computations = 15 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The count of extraComputations.

      • getExtraComputations

        ComputeRoutesRequest.ExtraComputation getExtraComputations​(int index)
         Optional. A list of extra computations which may be used to complete the
 request. Note: These extra computations may return extra fields on the
 response. These extra fields must also be specified in the field mask to be
 returned in the response.
        repeated .google.maps.routing.v2.ComputeRoutesRequest.ExtraComputation extra_computations = 15 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        index - The index of the element to return.
        Returns:
        The extraComputations at the given index.

      • getExtraComputationsValueList

        List<Integer> getExtraComputationsValueList()
         Optional. A list of extra computations which may be used to complete the
 request. Note: These extra computations may return extra fields on the
 response. These extra fields must also be specified in the field mask to be
 returned in the response.
        repeated .google.maps.routing.v2.ComputeRoutesRequest.ExtraComputation extra_computations = 15 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        A list containing the enum numeric values on the wire for extraComputations.

      • getExtraComputationsValue

        int getExtraComputationsValue​(int index)
         Optional. A list of extra computations which may be used to complete the
 request. Note: These extra computations may return extra fields on the
 response. These extra fields must also be specified in the field mask to be
 returned in the response.
        repeated .google.maps.routing.v2.ComputeRoutesRequest.ExtraComputation extra_computations = 15 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of extraComputations at the given index.

      • getTrafficModelValue

        int getTrafficModelValue()
         Optional. Specifies the assumptions to use when calculating time in
 traffic. This setting affects the value returned in the duration field in
 the [Route][google.maps.routing.v2.Route] and
 [RouteLeg][google.maps.routing.v2.RouteLeg] which contains the predicted
 time in traffic based on historical averages.
 `TrafficModel` is only available for requests that have set
 [RoutingPreference][google.maps.routing.v2.RoutingPreference] to
 `TRAFFIC_AWARE_OPTIMAL` and
 [RouteTravelMode][google.maps.routing.v2.RouteTravelMode] to `DRIVE`.
 Defaults to `BEST_GUESS` if traffic is requested and `TrafficModel` is not
 specified.
        .google.maps.routing.v2.TrafficModel traffic_model = 18 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The enum numeric value on the wire for trafficModel.

      • getTrafficModel

        TrafficModel getTrafficModel()
         Optional. Specifies the assumptions to use when calculating time in
 traffic. This setting affects the value returned in the duration field in
 the [Route][google.maps.routing.v2.Route] and
 [RouteLeg][google.maps.routing.v2.RouteLeg] which contains the predicted
 time in traffic based on historical averages.
 `TrafficModel` is only available for requests that have set
 [RoutingPreference][google.maps.routing.v2.RoutingPreference] to
 `TRAFFIC_AWARE_OPTIMAL` and
 [RouteTravelMode][google.maps.routing.v2.RouteTravelMode] to `DRIVE`.
 Defaults to `BEST_GUESS` if traffic is requested and `TrafficModel` is not
 specified.
        .google.maps.routing.v2.TrafficModel traffic_model = 18 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The trafficModel.

      • hasTransitPreferences

        boolean hasTransitPreferences()
         Optional. Specifies preferences that influence the route returned for
 `TRANSIT` routes. NOTE: You can only specify a `transit_preferences` when
 [RouteTravelMode][google.maps.routing.v2.RouteTravelMode] is set to
 `TRANSIT`.
        .google.maps.routing.v2.TransitPreferences transit_preferences = 20 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the transitPreferences field is set.

      • getTransitPreferences

        TransitPreferences getTransitPreferences()
         Optional. Specifies preferences that influence the route returned for
 `TRANSIT` routes. NOTE: You can only specify a `transit_preferences` when
 [RouteTravelMode][google.maps.routing.v2.RouteTravelMode] is set to
 `TRANSIT`.
        .google.maps.routing.v2.TransitPreferences transit_preferences = 20 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The transitPreferences.

      • getTransitPreferencesOrBuilder

        TransitPreferencesOrBuilder getTransitPreferencesOrBuilder()
         Optional. Specifies preferences that influence the route returned for
 `TRANSIT` routes. NOTE: You can only specify a `transit_preferences` when
 [RouteTravelMode][google.maps.routing.v2.RouteTravelMode] is set to
 `TRANSIT`.
        .google.maps.routing.v2.TransitPreferences transit_preferences = 20 [(.google.api.field_behavior) = OPTIONAL];