Class ComputeRoutesRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.maps.routing.v2.ComputeRoutesRequest
All Implemented Interfaces:
ComputeRoutesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated public final class ComputeRoutesRequest extends com.google.protobuf.GeneratedMessage implements ComputeRoutesRequestOrBuilder
 ComputeRoutes request message.
 
Protobuf type google.maps.routing.v2.ComputeRoutesRequest
See Also:
  • Field Details

    • ORIGIN_FIELD_NUMBER

      public static final int ORIGIN_FIELD_NUMBER
      See Also:
    • DESTINATION_FIELD_NUMBER

      public static final int DESTINATION_FIELD_NUMBER
      See Also:
    • INTERMEDIATES_FIELD_NUMBER

      public static final int INTERMEDIATES_FIELD_NUMBER
      See Also:
    • TRAVEL_MODE_FIELD_NUMBER

      public static final int TRAVEL_MODE_FIELD_NUMBER
      See Also:
    • ROUTING_PREFERENCE_FIELD_NUMBER

      public static final int ROUTING_PREFERENCE_FIELD_NUMBER
      See Also:
    • POLYLINE_QUALITY_FIELD_NUMBER

      public static final int POLYLINE_QUALITY_FIELD_NUMBER
      See Also:
    • POLYLINE_ENCODING_FIELD_NUMBER

      public static final int POLYLINE_ENCODING_FIELD_NUMBER
      See Also:
    • DEPARTURE_TIME_FIELD_NUMBER

      public static final int DEPARTURE_TIME_FIELD_NUMBER
      See Also:
    • ARRIVAL_TIME_FIELD_NUMBER

      public static final int ARRIVAL_TIME_FIELD_NUMBER
      See Also:
    • COMPUTE_ALTERNATIVE_ROUTES_FIELD_NUMBER

      public static final int COMPUTE_ALTERNATIVE_ROUTES_FIELD_NUMBER
      See Also:
    • ROUTE_MODIFIERS_FIELD_NUMBER

      public static final int ROUTE_MODIFIERS_FIELD_NUMBER
      See Also:
    • LANGUAGE_CODE_FIELD_NUMBER

      public static final int LANGUAGE_CODE_FIELD_NUMBER
      See Also:
    • REGION_CODE_FIELD_NUMBER

      public static final int REGION_CODE_FIELD_NUMBER
      See Also:
    • UNITS_FIELD_NUMBER

      public static final int UNITS_FIELD_NUMBER
      See Also:
    • OPTIMIZE_WAYPOINT_ORDER_FIELD_NUMBER

      public static final int OPTIMIZE_WAYPOINT_ORDER_FIELD_NUMBER
      See Also:
    • REQUESTED_REFERENCE_ROUTES_FIELD_NUMBER

      public static final int REQUESTED_REFERENCE_ROUTES_FIELD_NUMBER
      See Also:
    • EXTRA_COMPUTATIONS_FIELD_NUMBER

      public static final int EXTRA_COMPUTATIONS_FIELD_NUMBER
      See Also:
    • TRAFFIC_MODEL_FIELD_NUMBER

      public static final int TRAFFIC_MODEL_FIELD_NUMBER
      See Also:
    • TRANSIT_PREFERENCES_FIELD_NUMBER

      public static final int TRANSIT_PREFERENCES_FIELD_NUMBER
      See Also:
  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • hasOrigin

      public boolean hasOrigin()
       Required. Origin waypoint.
       
      .google.maps.routing.v2.Waypoint origin = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasOrigin in interface ComputeRoutesRequestOrBuilder
      Returns:
      Whether the origin field is set.
    • getOrigin

      public Waypoint getOrigin()
       Required. Origin waypoint.
       
      .google.maps.routing.v2.Waypoint origin = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getOrigin in interface ComputeRoutesRequestOrBuilder
      Returns:
      The origin.
    • getOriginOrBuilder

      public WaypointOrBuilder getOriginOrBuilder()
       Required. Origin waypoint.
       
      .google.maps.routing.v2.Waypoint origin = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getOriginOrBuilder in interface ComputeRoutesRequestOrBuilder
    • hasDestination

      public boolean hasDestination()
       Required. Destination waypoint.
       
      .google.maps.routing.v2.Waypoint destination = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasDestination in interface ComputeRoutesRequestOrBuilder
      Returns:
      Whether the destination field is set.
    • getDestination

      public Waypoint getDestination()
       Required. Destination waypoint.
       
      .google.maps.routing.v2.Waypoint destination = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDestination in interface ComputeRoutesRequestOrBuilder
      Returns:
      The destination.
    • getDestinationOrBuilder

      public WaypointOrBuilder getDestinationOrBuilder()
       Required. Destination waypoint.
       
      .google.maps.routing.v2.Waypoint destination = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDestinationOrBuilder in interface ComputeRoutesRequestOrBuilder
    • getIntermediatesList

      public 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];
      Specified by:
      getIntermediatesList in interface ComputeRoutesRequestOrBuilder
    • getIntermediatesOrBuilderList

      public 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];
      Specified by:
      getIntermediatesOrBuilderList in interface ComputeRoutesRequestOrBuilder
    • getIntermediatesCount

      public 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];
      Specified by:
      getIntermediatesCount in interface ComputeRoutesRequestOrBuilder
    • getIntermediates

      public 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];
      Specified by:
      getIntermediates in interface ComputeRoutesRequestOrBuilder
    • getIntermediatesOrBuilder

      public 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];
      Specified by:
      getIntermediatesOrBuilder in interface ComputeRoutesRequestOrBuilder
    • getTravelModeValue

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

      public RouteTravelMode getTravelMode()
       Optional. Specifies the mode of transportation.
       
      .google.maps.routing.v2.RouteTravelMode travel_mode = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTravelMode in interface ComputeRoutesRequestOrBuilder
      Returns:
      The travelMode.
    • getRoutingPreferenceValue

      public 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];
      Specified by:
      getRoutingPreferenceValue in interface ComputeRoutesRequestOrBuilder
      Returns:
      The enum numeric value on the wire for routingPreference.
    • getRoutingPreference

      public 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];
      Specified by:
      getRoutingPreference in interface ComputeRoutesRequestOrBuilder
      Returns:
      The routingPreference.
    • getPolylineQualityValue

      public 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];
      Specified by:
      getPolylineQualityValue in interface ComputeRoutesRequestOrBuilder
      Returns:
      The enum numeric value on the wire for polylineQuality.
    • getPolylineQuality

      public 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];
      Specified by:
      getPolylineQuality in interface ComputeRoutesRequestOrBuilder
      Returns:
      The polylineQuality.
    • getPolylineEncodingValue

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

      public PolylineEncoding getPolylineEncoding()
       Optional. Specifies the preferred encoding for the polyline.
       
      .google.maps.routing.v2.PolylineEncoding polyline_encoding = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPolylineEncoding in interface ComputeRoutesRequestOrBuilder
      Returns:
      The polylineEncoding.
    • hasDepartureTime

      public 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`. Transit trips are available for up to 7 days in the past or 100
       days in the future.
       
      .google.protobuf.Timestamp departure_time = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasDepartureTime in interface ComputeRoutesRequestOrBuilder
      Returns:
      Whether the departureTime field is set.
    • getDepartureTime

      public 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`. Transit trips are available for up to 7 days in the past or 100
       days in the future.
       
      .google.protobuf.Timestamp departure_time = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDepartureTime in interface ComputeRoutesRequestOrBuilder
      Returns:
      The departureTime.
    • getDepartureTimeOrBuilder

      public 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`. Transit trips are available for up to 7 days in the past or 100
       days in the future.
       
      .google.protobuf.Timestamp departure_time = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDepartureTimeOrBuilder in interface ComputeRoutesRequestOrBuilder
    • hasArrivalTime

      public boolean hasArrivalTime()
       Optional. The arrival time.
       NOTE: This field is ignored when requests specify a
       [RouteTravelMode][google.maps.routing.v2.RouteTravelMode] other than
       `TRANSIT`. You can specify either `departure_time` or `arrival_time`, but
       not both. Transit trips are available for up to 7 days in the past or 100
       days in the future.
       
      .google.protobuf.Timestamp arrival_time = 19 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasArrivalTime in interface ComputeRoutesRequestOrBuilder
      Returns:
      Whether the arrivalTime field is set.
    • getArrivalTime

      public com.google.protobuf.Timestamp getArrivalTime()
       Optional. The arrival time.
       NOTE: This field is ignored when requests specify a
       [RouteTravelMode][google.maps.routing.v2.RouteTravelMode] other than
       `TRANSIT`. You can specify either `departure_time` or `arrival_time`, but
       not both. Transit trips are available for up to 7 days in the past or 100
       days in the future.
       
      .google.protobuf.Timestamp arrival_time = 19 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getArrivalTime in interface ComputeRoutesRequestOrBuilder
      Returns:
      The arrivalTime.
    • getArrivalTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getArrivalTimeOrBuilder()
       Optional. The arrival time.
       NOTE: This field is ignored when requests specify a
       [RouteTravelMode][google.maps.routing.v2.RouteTravelMode] other than
       `TRANSIT`. You can specify either `departure_time` or `arrival_time`, but
       not both. Transit trips are available for up to 7 days in the past or 100
       days in the future.
       
      .google.protobuf.Timestamp arrival_time = 19 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getArrivalTimeOrBuilder in interface ComputeRoutesRequestOrBuilder
    • getComputeAlternativeRoutes

      public 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];
      Specified by:
      getComputeAlternativeRoutes in interface ComputeRoutesRequestOrBuilder
      Returns:
      The computeAlternativeRoutes.
    • hasRouteModifiers

      public 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];
      Specified by:
      hasRouteModifiers in interface ComputeRoutesRequestOrBuilder
      Returns:
      Whether the routeModifiers field is set.
    • getRouteModifiers

      public 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];
      Specified by:
      getRouteModifiers in interface ComputeRoutesRequestOrBuilder
      Returns:
      The routeModifiers.
    • getRouteModifiersOrBuilder

      public 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];
      Specified by:
      getRouteModifiersOrBuilder in interface ComputeRoutesRequestOrBuilder
    • getLanguageCode

      public String getLanguageCode()
       Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more
       information, see [Unicode Locale
       Identifier](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];
      Specified by:
      getLanguageCode in interface ComputeRoutesRequestOrBuilder
      Returns:
      The languageCode.
    • getLanguageCodeBytes

      public com.google.protobuf.ByteString getLanguageCodeBytes()
       Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more
       information, see [Unicode Locale
       Identifier](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];
      Specified by:
      getLanguageCodeBytes in interface ComputeRoutesRequestOrBuilder
      Returns:
      The bytes for languageCode.
    • getRegionCode

      public String getRegionCode()
       Optional. The region code, specified as a ccTLD ("top-level domain")
       two-character value. For more information see [Country code top-level
       domains](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];
      Specified by:
      getRegionCode in interface ComputeRoutesRequestOrBuilder
      Returns:
      The regionCode.
    • getRegionCodeBytes

      public com.google.protobuf.ByteString getRegionCodeBytes()
       Optional. The region code, specified as a ccTLD ("top-level domain")
       two-character value. For more information see [Country code top-level
       domains](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];
      Specified by:
      getRegionCodeBytes in interface ComputeRoutesRequestOrBuilder
      Returns:
      The bytes for regionCode.
    • getUnitsValue

      public 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];
      Specified by:
      getUnitsValue in interface ComputeRoutesRequestOrBuilder
      Returns:
      The enum numeric value on the wire for units.
    • getUnits

      public 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];
      Specified by:
      getUnits in interface ComputeRoutesRequestOrBuilder
      Returns:
      The units.
    • getOptimizeWaypointOrder

      public 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];
      Specified by:
      getOptimizeWaypointOrder in interface ComputeRoutesRequestOrBuilder
      Returns:
      The optimizeWaypointOrder.
    • getRequestedReferenceRoutesList

      public 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. When using
       this feature, look for
       [`route_labels`][google.maps.routing.v2.Route.route_labels] on the
       resulting routes.
       
      repeated .google.maps.routing.v2.ComputeRoutesRequest.ReferenceRoute requested_reference_routes = 14 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRequestedReferenceRoutesList in interface ComputeRoutesRequestOrBuilder
      Returns:
      A list containing the requestedReferenceRoutes.
    • getRequestedReferenceRoutesCount

      public 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. When using
       this feature, look for
       [`route_labels`][google.maps.routing.v2.Route.route_labels] on the
       resulting routes.
       
      repeated .google.maps.routing.v2.ComputeRoutesRequest.ReferenceRoute requested_reference_routes = 14 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRequestedReferenceRoutesCount in interface ComputeRoutesRequestOrBuilder
      Returns:
      The count of requestedReferenceRoutes.
    • getRequestedReferenceRoutes

      public 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. When using
       this feature, look for
       [`route_labels`][google.maps.routing.v2.Route.route_labels] on the
       resulting routes.
       
      repeated .google.maps.routing.v2.ComputeRoutesRequest.ReferenceRoute requested_reference_routes = 14 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRequestedReferenceRoutes in interface ComputeRoutesRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The requestedReferenceRoutes at the given index.
    • getRequestedReferenceRoutesValueList

      public 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. When using
       this feature, look for
       [`route_labels`][google.maps.routing.v2.Route.route_labels] on the
       resulting routes.
       
      repeated .google.maps.routing.v2.ComputeRoutesRequest.ReferenceRoute requested_reference_routes = 14 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRequestedReferenceRoutesValueList in interface ComputeRoutesRequestOrBuilder
      Returns:
      A list containing the enum numeric values on the wire for requestedReferenceRoutes.
    • getRequestedReferenceRoutesValue

      public 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. When using
       this feature, look for
       [`route_labels`][google.maps.routing.v2.Route.route_labels] on the
       resulting routes.
       
      repeated .google.maps.routing.v2.ComputeRoutesRequest.ReferenceRoute requested_reference_routes = 14 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRequestedReferenceRoutesValue in interface ComputeRoutesRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of requestedReferenceRoutes at the given index.
    • getExtraComputationsList

      public 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];
      Specified by:
      getExtraComputationsList in interface ComputeRoutesRequestOrBuilder
      Returns:
      A list containing the extraComputations.
    • getExtraComputationsCount

      public 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];
      Specified by:
      getExtraComputationsCount in interface ComputeRoutesRequestOrBuilder
      Returns:
      The count of extraComputations.
    • getExtraComputations

      public 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];
      Specified by:
      getExtraComputations in interface ComputeRoutesRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The extraComputations at the given index.
    • getExtraComputationsValueList

      public 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];
      Specified by:
      getExtraComputationsValueList in interface ComputeRoutesRequestOrBuilder
      Returns:
      A list containing the enum numeric values on the wire for extraComputations.
    • getExtraComputationsValue

      public 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];
      Specified by:
      getExtraComputationsValue in interface ComputeRoutesRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of extraComputations at the given index.
    • getTrafficModelValue

      public 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];
      Specified by:
      getTrafficModelValue in interface ComputeRoutesRequestOrBuilder
      Returns:
      The enum numeric value on the wire for trafficModel.
    • getTrafficModel

      public 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];
      Specified by:
      getTrafficModel in interface ComputeRoutesRequestOrBuilder
      Returns:
      The trafficModel.
    • hasTransitPreferences

      public 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];
      Specified by:
      hasTransitPreferences in interface ComputeRoutesRequestOrBuilder
      Returns:
      Whether the transitPreferences field is set.
    • getTransitPreferences

      public 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];
      Specified by:
      getTransitPreferences in interface ComputeRoutesRequestOrBuilder
      Returns:
      The transitPreferences.
    • getTransitPreferencesOrBuilder

      public 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];
      Specified by:
      getTransitPreferencesOrBuilder in interface ComputeRoutesRequestOrBuilder
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage
    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage
    • parseFrom

      public static ComputeRoutesRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ComputeRoutesRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ComputeRoutesRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ComputeRoutesRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ComputeRoutesRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ComputeRoutesRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ComputeRoutesRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static ComputeRoutesRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static ComputeRoutesRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static ComputeRoutesRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static ComputeRoutesRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static ComputeRoutesRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

      public ComputeRoutesRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static ComputeRoutesRequest.Builder newBuilder()
    • newBuilder

      public static ComputeRoutesRequest.Builder newBuilder(ComputeRoutesRequest prototype)
    • toBuilder

      public ComputeRoutesRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected ComputeRoutesRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static ComputeRoutesRequest getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<ComputeRoutesRequest> parser()
    • getParserForType

      public com.google.protobuf.Parser<ComputeRoutesRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage
    • getDefaultInstanceForType

      public ComputeRoutesRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder