RouteOptions.Builder (services-directions-models API)

java.lang.Object
- com.mapbox.api.directions.v5.models.RouteOptions.Builder

Enclosing class:

RouteOptions
```
public abstract static class RouteOptions.Builder
extends java.lang.Object
```
This builder can be used to set the values describing the RouteOptions.

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract RouteOptions.Builder`	`alleyBias(java.lang.Double alleyBias)` A scale from -1 to 1, where -1 biases the route against alleys and 1 biases the route toward alleys.
`abstract RouteOptions.Builder`	`alternatives(java.lang.Boolean alternatives)` Whether to try to return alternative routes (true) or not (false, default).
`abstract RouteOptions.Builder`	`annotations(java.lang.String annotations)` A comma-separated list of annotations.
`RouteOptions.Builder`	`annotationsList(java.util.List<java.lang.String> annotations)` A list of annotations.
`abstract RouteOptions.Builder`	`approaches(java.lang.String approaches)` A semicolon-separated list indicating from which side of the road to approach a waypoint.
`RouteOptions.Builder`	`approachesList(java.util.List<java.lang.String> approaches)` Indicates from which side of the road to approach a waypoint.
`abstract RouteOptions.Builder`	`arriveBy(java.lang.String arriveBy)` The desired arrival time, formatted as a timestamp in ISO-8601 format in the local time at the route destination.
`abstract RouteOptions.Builder`	`avoidManeuverRadius(java.lang.Double avoidManeuverRadius)` A radius around a starting point where the routes' provider tries to avoid any significant maneuvers.
`abstract RouteOptions.Builder`	`bannerInstructions(java.lang.Boolean bannerInstructions)` Whether to return banner objects associated with the route steps (true) or not (false, default if null).
`abstract RouteOptions.Builder`	`baseUrl(java.lang.String baseUrl)` Base URL for the request.
`abstract RouteOptions.Builder`	`bearings(java.lang.String bearings)` Influences the direction in which a route starts from a waypoint.
`RouteOptions.Builder`	`bearingsList(java.util.List<Bearing> bearings)` Influences the direction in which a route starts from a waypoint.
`abstract RouteOptions`	`build()` Builds the object.
`abstract RouteOptions.Builder`	`computeTollCost(java.lang.Boolean computeTollCost)`
`abstract RouteOptions.Builder`	`continueStraight(java.lang.Boolean continueStraight)` The allowed direction of travel when departing intermediate waypoints.
`abstract RouteOptions.Builder`	`coordinates(java.lang.String coordinates)` A semicolon-separated list of {longitude},{latitude} coordinate pairs to visit in order.
`RouteOptions.Builder`	`coordinatesList(java.util.List<com.mapbox.geojson.Point> coordinates)` A list of Points to visit in order.
`abstract RouteOptions.Builder`	`departAt(java.lang.String departAt)` The departure time, formatted as a timestamp in ISO-8601 format in the local time at the route origin.
`abstract RouteOptions.Builder`	`enableRefresh(java.lang.Boolean enableRefresh)` Whether the routes should be refreshable via the directions refresh API.
`abstract RouteOptions.Builder`	`exclude(java.lang.String exclude)` Exclude certain road types or points from routing.
`RouteOptions.Builder`	`excludeList(java.util.List<java.lang.String> exclude)` Exclude certain road types or points from routing.
`RouteOptions.Builder`	`excludeObject(Exclude exclude)` Exclude certain road types or points from routing.
`abstract RouteOptions.Builder`	`geometries(java.lang.String geometries)` The format of the returned geometry.
`abstract RouteOptions.Builder`	`include(java.lang.String include)` Include certain road types in routing.
`RouteOptions.Builder`	`includeList(java.util.List<java.lang.String> include)` Include certain road types in routing.
`abstract RouteOptions.Builder`	`language(java.lang.String language)` The language of returned turn-by-turn text instructions.
`abstract RouteOptions.Builder`	`layers(java.lang.String layers)` Influences layer of road from where route starts from a waypoint.
`RouteOptions.Builder`	`layersList(java.util.List<java.lang.Integer> layers)` Influences layer of road from where route starts from a waypoint.
`abstract RouteOptions.Builder`	`maxHeight(java.lang.Double maxHeight)` The max vehicle height in meters.
`abstract RouteOptions.Builder`	`maxWeight(java.lang.Double maxWeight)` The max vehicle weight, in metric tons (1000 kg).
`abstract RouteOptions.Builder`	`maxWidth(java.lang.Double maxWidth)` The max vehicle width in meters.
`abstract RouteOptions.Builder`	`metadata(java.lang.Boolean metadata)` Whether the response should contain metadata holding versioning information.
`abstract RouteOptions.Builder`	`overview(java.lang.String overview)` Displays the requested type of overview geometry.
`abstract RouteOptions.Builder`	`paymentMethods(java.lang.String paymentMethods)`
`RouteOptions.Builder`	`paymentMethodsList(java.util.List<java.lang.String> paymentMethods)`
`abstract RouteOptions.Builder`	`profile(java.lang.String profile)` The routing profile to use.
`abstract RouteOptions.Builder`	`radiuses(java.lang.String radiuses)` The maximum distance a coordinate can be moved to snap to the road network in meters.
`RouteOptions.Builder`	`radiusesList(java.util.List<java.lang.Double> radiuses)` The maximum distance a coordinate can be moved to snap to the road network in meters.
`abstract RouteOptions.Builder`	`roundaboutExits(java.lang.Boolean roundaboutExits)` Whether to emit instructions at roundabout exits (true) or not (false, default if null).
`abstract RouteOptions.Builder`	`snappingIncludeClosures(java.lang.String snappingClosures)` A semicolon-separated list of booleans affecting snapping of waypoint locations to road segments.
`RouteOptions.Builder`	`snappingIncludeClosuresList(java.util.List<java.lang.Boolean> snappingClosures)` A list of booleans affecting snapping of waypoint locations to road segments.
`abstract RouteOptions.Builder`	`snappingIncludeStaticClosures(java.lang.String snappingStaticClosures)` A semicolon-separated list of booleans affecting snapping of waypoint locations to road segments.
`RouteOptions.Builder`	`snappingIncludeStaticClosuresList(java.util.List<java.lang.Boolean> snappingStaticClosures)` A list of booleans affecting snapping of waypoint locations to road segments.
`abstract RouteOptions.Builder`	`steps(java.lang.Boolean steps)` Whether to return steps and turn-by-turn instructions (true) or not (false if null, default).
`abstract RouteOptions.Builder`	`suppressVoiceInstructionLocalNames(java.lang.Boolean suppressVoiceInstructionLocalNames)`
`T`	`unrecognizedJsonProperties(java.util.Map<java.lang.String,com.google.gson.JsonElement> unrecognizedProperties)` Use this method to add parameters which are not present in the model yet but are supported on the Directions API side in the response.
`RouteOptions.Builder`	`unrecognizedProperties(java.util.Map<java.lang.String,java.lang.String> unrecognizedProperties)` Use this method to add request parameters, which are not present in the model yet but are supported on the Directions API, to a URL generated by `RouteOptions#toUrl`.
`abstract RouteOptions.Builder`	`user(java.lang.String user)` The user parameter of the request, defaults to "mapbox".
`abstract RouteOptions.Builder`	`voiceInstructions(java.lang.Boolean voiceInstructions)` Whether to return SSML marked-up text for voice guidance along the route (true) or not (false, default if null).
`abstract RouteOptions.Builder`	`voiceUnits(java.lang.String voiceUnits)` A type of units to return in the text for voice instructions.
`abstract RouteOptions.Builder`	`walkingSpeed(java.lang.Double walkingSpeed)` The walking speed in meters per second with a minimum of 0.14 m/s (or 0.5 km/h) and a maximum of 6.94 m/s (or 25.0 km/h).
`abstract RouteOptions.Builder`	`walkwayBias(java.lang.Double walkwayBias)` A bias which determines whether the route should prefer or avoid the use of roads or paths that are set aside for pedestrian-only use (walkways).
`abstract RouteOptions.Builder`	`waypointIndices(java.lang.String waypointIndices)` A semicolon-separated list indicating which input coordinates should be treated as waypoints.
`RouteOptions.Builder`	`waypointIndicesList(java.util.List<java.lang.Integer> indices)` A list indicating which input coordinates should be treated as waypoints.
`abstract RouteOptions.Builder`	`waypointNames(java.lang.String waypointNames)` A semicolon-separated list of custom names for entries in the list of `RouteOptions.coordinates()`, used for the arrival instruction in banners and voice instructions.
`RouteOptions.Builder`	`waypointNamesList(java.util.List<java.lang.String> waypointNames)` A list of custom names for entries in the list of `RouteOptions.coordinatesList()`, used for the arrival instruction in banners and voice instructions.
`abstract RouteOptions.Builder`	`waypointsPerRoute(java.lang.Boolean waypointsPerRoute)` If true, the waypoints array is returned within the route object, else its returned at the root of the response body.
`abstract RouteOptions.Builder`	`waypointTargets(java.lang.String waypointTargets)` A semicolon-separated list of coordinate pairs used to specify drop-off locations that are distinct from the locations specified in coordinates.
`RouteOptions.Builder`	`waypointTargetsList(java.util.List<com.mapbox.geojson.Point> waypointTargets)` A list of points used to specify drop-off locations that are distinct from the locations specified in coordinates.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - baseUrl
```
@NonNull
public abstract RouteOptions.Builder baseUrl(@NonNull
                                                      java.lang.String baseUrl)
```
    Base URL for the request.
    
    Parameters:
    
    baseUrl - string value representing the base URL
    
    Returns:
    
    this builder for chaining options together
  - user
```
@NonNull
public abstract RouteOptions.Builder user(@NonNull
                                                   java.lang.String user)
```
    The user parameter of the request, defaults to "mapbox".
    
    Parameters:
    
    user - string with the user
    
    Returns:
    
    this builder for chaining options together
  - profile
```
@NonNull
public abstract RouteOptions.Builder profile(@NonNull
                                                      java.lang.String profile)
```
    The routing profile to use. Possible values are DirectionsCriteria.PROFILE_DRIVING_TRAFFIC, DirectionsCriteria.PROFILE_DRIVING, DirectionsCriteria.PROFILE_WALKING, or DirectionsCriteria.PROFILE_CYCLING.
    
    Parameters:
    
    profile - string value representing the profile defined in DirectionsCriteria.ProfileCriteria
    
    Returns:
    
    this builder for chaining options together
  - coordinates
```
@NonNull
public abstract RouteOptions.Builder coordinates(@NonNull
                                                          java.lang.String coordinates)
```
    A semicolon-separated list of {longitude},{latitude} coordinate pairs to visit in order. There can be between two and 25 coordinates for most requests, or up to three coordinates for DirectionsCriteria.PROFILE_DRIVING_TRAFFIC requests. Contact Mapbox Support if you'd like to extend this limit.
    Note that these coordinates are different than the DirectionsWaypoints found in the DirectionsResponse which are snapped to a road.
    
    Parameters:
    
    coordinates - a list of Points which represent the route origin, destination, and optionally waypoints
    
    Returns:
    
    this builder for chaining options together
  - coordinatesList
```
@NonNull
public RouteOptions.Builder coordinatesList(@NonNull
                                                     java.util.List<com.mapbox.geojson.Point> coordinates)
```
    A list of Points to visit in order. There can be between two and 25 coordinates for most requests, or up to 3 coordinates for DirectionsCriteria.PROFILE_DRIVING_TRAFFIC requests. Contact Mapbox Support if you'd like to extend this limit.
    Note that these coordinates are different than the DirectionsWaypoints found in the DirectionsResponse which are snapped to a road.
    
    Parameters:
    
    coordinates - a list of Points which represent the route origin, destination, and optionally waypoints
    
    Returns:
    
    this builder for chaining options together
  - alternatives
```
@NonNull
public abstract RouteOptions.Builder alternatives(@Nullable
                                                           java.lang.Boolean alternatives)
```
    Whether to try to return alternative routes (true) or not (false, default). An alternative route is a route that is significantly different than the fastest route, but also still reasonably fast. Such a route does not exist in all circumstances. Up to two alternatives may be returned. This is available for DirectionsCriteria.PROFILE_DRIVING_TRAFFIC, DirectionsCriteria.PROFILE_DRIVING, DirectionsCriteria.PROFILE_CYCLING.
    The order of the routes in the response is not sorted by duration, but by weight. The first route in the list is not the most preferable because of the duration, but also based on the type of maneuvers.
    If null is provided, the Directions API defaults to false.
    
    Parameters:
    
    alternatives - boolean object representing the setting for alternatives
    
    Returns:
    
    this builder for chaining options together
  - language
```
@NonNull
public abstract RouteOptions.Builder language(@Nullable
                                                       java.lang.String language)
```
    The language of returned turn-by-turn text instructions. Defaults to "en" (English) if null. Must be used in conjunction with RouteOptions.steps()=true.
    Refer to supported languages list for details.
    
    Parameters:
    
    language - the language as a string used during the request
    
    Returns:
    
    this builder for chaining options together
  - radiuses
```
@NonNull
public abstract RouteOptions.Builder radiuses(@Nullable
                                                       java.lang.String radiuses)
```
    The maximum distance a coordinate can be moved to snap to the road network in meters. There must be as many radiuses as there are coordinates in the request, each separated by ";". Values can be any number greater than 0 or the string "unlimited".
    A NoSegment error is returned if no routable road is found within the radius.
    
    Parameters:
    
    radiuses - a string representing the radiuses separated by ";".
    
    Returns:
    
    this builder for chaining options together
  - radiusesList
```
@NonNull
public RouteOptions.Builder radiusesList(@Nullable
                                                  java.util.List<java.lang.Double> radiuses)
```
    The maximum distance a coordinate can be moved to snap to the road network in meters. There must be as many radiuses as there are coordinates in the request. Values can be any number greater than 0 or Double.POSITIVE_INFINITY for unlimited.
    A NoSegment error is returned if no routable road is found within the radius.
    
    Parameters:
    
    radiuses - a list of radiuses
    
    Returns:
    
    this builder for chaining options together
  - bearings
```
@NonNull
public abstract RouteOptions.Builder bearings(@Nullable
                                                       java.lang.String bearings)
```
    Influences the direction in which a route starts from a waypoint. Used to filter the road segment the waypoint will be placed on by direction. This is useful for making sure the new routes of rerouted vehicles continue traveling in their current direction. A request that does this would provide bearing and radius values for the first waypoint and leave the remaining values empty. Returns two comma-separated values per waypoint: an angle clockwise from true north between 0 and 360, and the range of degrees by which the angle can deviate (recommended value is 45° or 90°), formatted as {angle, degrees}. If provided, the list of bearings must be the same length as the list of coordinates. However, you can skip a coordinate and show its position in the list with the ; separator.
    
    Parameters:
    
    bearings - a string representing the bearings with the ; separator. Angle and degrees for every bearing value are comma-separated.
    
    Returns:
    
    this builder for chaining options together
  - bearingsList
```
@NonNull
public RouteOptions.Builder bearingsList(@Nullable
                                                  java.util.List<Bearing> bearings)
```
    Influences the direction in which a route starts from a waypoint. Used to filter the road segment the waypoint will be placed on by direction. This is useful for making sure the new routes of rerouted vehicles continue traveling in their current direction. A request that does this would provide bearing and radius values for the first waypoint and leave the remaining values empty. Returns a list of values, each value is a list of Bearing objects.
    If provided, the list of bearings must be the same length as the list of coordinates. However, you can skip a coordinate and show its position in the list with null.
    
    Parameters:
    
    bearings - a List of list of doubles representing the bearings used in the original request. The first value in the list is the angle, the second one is the degrees.
    
    Returns:
    
    this builder for chaining options together
  - avoidManeuverRadius
```
@NonNull
public abstract RouteOptions.Builder avoidManeuverRadius(@Nullable
                                                                  java.lang.Double avoidManeuverRadius)
```
    A radius around a starting point where the routes' provider tries to avoid any significant maneuvers. Use this option when the vehicle is traveling at a significant speed to avoid dangerous maneuvers when re-routing. If a route is not found using the specified value, it will be ignored. Note that if a large radius is used, the routers' provider may ignore an important turn and return a long straight path before the first maneuver.
    Note: the param cannot be used with departAt(String) and arriveBy(String), since these modes are used for reference requests, not for real-time routing.
    
    Parameters:
    
    avoidManeuverRadius - avoid maneuver radius, in meters. Possible range is [0, 1000].
    
    Returns:
    
    this builder for chaining options together
  - layers
```
@NonNull
public abstract RouteOptions.Builder layers(@Nullable
                                                     java.lang.String layers)
```
    Influences layer of road from where route starts from a waypoint. Useful in ambiguous cases when there are multiple roads at the same point and only layer allows to differentiate them.
    If provided, the list of layers must be the same length as the list of coordinates.
    
    Parameters:
    
    layers - a string representing the layers with the ; separator.
    
    Returns:
    
    this builder for chaining options together
  - layersList
```
@NonNull
public RouteOptions.Builder layersList(@Nullable
                                                java.util.List<java.lang.Integer> layers)
```
    Influences layer of road from where route starts from a waypoint. Useful in ambiguous cases when there are multiple roads at the same point and only layer allows to differentiate them.
    If provided, the list of layers must be the same length as the list of coordinates.
    
    Parameters:
    
    layers - a list of layers. For unknown layer use `null`.
    
    Returns:
    
    this builder for chaining options together
  - continueStraight
```
@NonNull
public abstract RouteOptions.Builder continueStraight(@Nullable
                                                               java.lang.Boolean continueStraight)
```
    The allowed direction of travel when departing intermediate waypoints. If true, the route will continue in the same direction of travel. If false, the route may continue in the opposite direction of travel. Defaults to true for DirectionsCriteria.PROFILE_DRIVING and false for DirectionsCriteria.PROFILE_WALKING and DirectionsCriteria.PROFILE_CYCLING.
    
    Parameters:
    
    continueStraight - a boolean value representing whether or not continueStraight was enabled or during the initial request
    
    Returns:
    
    this builder for chaining options together
  - roundaboutExits
```
@NonNull
public abstract RouteOptions.Builder roundaboutExits(@Nullable
                                                              java.lang.Boolean roundaboutExits)
```
    Whether to emit instructions at roundabout exits (true) or not (false, default if null). Without this parameter, roundabout maneuvers are given as a single instruction that includes both entering and exiting the roundabout. With roundabout_exits=true, this maneuver becomes two instructions, one for entering the roundabout and one for exiting it. Must be used in conjunction with RouteOptions.steps()=true.
    
    Parameters:
    
    roundaboutExits - a boolean value representing whether or not roundaboutExits is enabled or disabled
    
    Returns:
    
    this builder for chaining options together
  - geometries
```
@NonNull
public abstract RouteOptions.Builder geometries(@NonNull
                                                         java.lang.String geometries)
```
    The format of the returned geometry. Allowed values are: DirectionsCriteria.GEOMETRY_POLYLINE (a polyline with a precision of five decimal places), DirectionsCriteria.GEOMETRY_POLYLINE6 (default, a polyline with a precision of six decimal places).
    
    Parameters:
    
    geometries - String geometry type from DirectionsCriteria.GeometriesCriteria.
    
    Returns:
    
    this builder for chaining options together
  - overview
```
@NonNull
public abstract RouteOptions.Builder overview(@Nullable
                                                       java.lang.String overview)
```
    Displays the requested type of overview geometry. Can be DirectionsCriteria.OVERVIEW_FULL (the most detailed geometry available), DirectionsCriteria.OVERVIEW_SIMPLIFIED (default if null, a simplified version of the full geometry), or DirectionsCriteria.OVERVIEW_FALSE (no overview geometry).
    
    Parameters:
    
    overview - null or one of the options found in DirectionsCriteria.OverviewCriteria
    
    Returns:
    
    this builder for chaining options together
  - steps
```
@NonNull
public abstract RouteOptions.Builder steps(@Nullable
                                                    java.lang.Boolean steps)
```
    Whether to return steps and turn-by-turn instructions (true) or not (false if null, default). If steps is set to true, the following guidance-related parameters will be available: RouteOptions.bannerInstructions(), RouteOptions.language(), RouteOptions.roundaboutExits(), RouteOptions.voiceInstructions(), RouteOptions.voiceUnits(), RouteOptions.waypointNames(), RouteOptions.waypointNamesList(), RouteOptions.waypointTargets(), RouteOptions.waypointTargetsList(), RouteOptions.waypointIndices(), RouteOptions.waypointIndicesList(), RouteOptions.alleyBias()
    
    Parameters:
    
    steps - true if you'd like step information, false or null otherwise
    
    Returns:
    
    this builder for chaining options together
  - annotations
```
@NonNull
public abstract RouteOptions.Builder annotations(@Nullable
                                                          java.lang.String annotations)
```
    A comma-separated list of annotations. Defines whether to return additional metadata along the route. Possible values are: DirectionsCriteria.ANNOTATION_DISTANCE DirectionsCriteria.ANNOTATION_DURATION DirectionsCriteria.ANNOTATION_SPEED DirectionsCriteria.ANNOTATION_CONGESTION DirectionsCriteria.ANNOTATION_CONGESTION_NUMERIC DirectionsCriteria.ANNOTATION_MAXSPEED DirectionsCriteria.ANNOTATION_CLOSURE See the RouteLeg object for more details on what is included with annotations.
    Must be used in conjunction with DirectionsCriteria.OVERVIEW_FULL in RouteOptions.overview().
    
    Parameters:
    
    annotations - a string containing requested annotations
    
    Returns:
    
    this builder for chaining options together
  - annotationsList
```
@NonNull
public RouteOptions.Builder annotationsList(@Nullable
                                                     java.util.List<java.lang.String> annotations)
```
    A list of annotations. Defines whether to return additional metadata along the route. Possible values are: DirectionsCriteria.ANNOTATION_DISTANCE DirectionsCriteria.ANNOTATION_DURATION DirectionsCriteria.ANNOTATION_SPEED DirectionsCriteria.ANNOTATION_CONGESTION DirectionsCriteria.ANNOTATION_CONGESTION_NUMERIC DirectionsCriteria.ANNOTATION_MAXSPEED DirectionsCriteria.ANNOTATION_CLOSURE See the RouteLeg object for more details on what is included with annotations.
    Must be used in conjunction with DirectionsCriteria.OVERVIEW_FULL in RouteOptions.overview().
    
    Parameters:
    
    annotations - a list of annotations that were used during the request
    
    Returns:
    
    this builder for chaining options together
  - voiceInstructions
```
@NonNull
public abstract RouteOptions.Builder voiceInstructions(@Nullable
                                                                java.lang.Boolean voiceInstructions)
```
    Whether to return SSML marked-up text for voice guidance along the route (true) or not (false, default if null). Must be used in conjunction with RouteOptions.steps()=true.
    
    Parameters:
    
    voiceInstructions - true if the request included voice instructions
    
    Returns:
    
    this builder for chaining options together
  - bannerInstructions
```
@NonNull
public abstract RouteOptions.Builder bannerInstructions(@Nullable
                                                                 java.lang.Boolean bannerInstructions)
```
    Whether to return banner objects associated with the route steps (true) or not (false, default if null). Must be used in conjunction with RouteOptions.steps()=true.
    
    Parameters:
    
    bannerInstructions - true if the request includes banner instructions
    
    Returns:
    
    this builder for chaining options together
  - voiceUnits
```
@NonNull
public abstract RouteOptions.Builder voiceUnits(@Nullable
                                                         java.lang.String voiceUnits)
```
    A type of units to return in the text for voice instructions. Can be DirectionsCriteria.IMPERIAL (default) or DirectionsCriteria.METRIC. Must be used in conjunction with RouteOptions.steps()=true and RouteOptions.steps()=true and RouteOptions.voiceInstructions()=true.
    
    Parameters:
    
    voiceUnits - a string matching either imperial or metric
    
    Returns:
    
    this builder for chaining options together
  - exclude
```
@NonNull
public abstract RouteOptions.Builder exclude(@Nullable
                                                      java.lang.String exclude)
```
    Exclude certain road types or points from routing. The default is to not exclude anything from the profile selected. The following exclude flags are available for each profile:
    DirectionsCriteria.PROFILE_DRIVING: One of DirectionsCriteria.EXCLUDE_TOLL, DirectionsCriteria.EXCLUDE_MOTORWAY, or DirectionsCriteria.EXCLUDE_FERRY.
    DirectionsCriteria.PROFILE_DRIVING_TRAFFIC: One of DirectionsCriteria.EXCLUDE_TOLL, DirectionsCriteria.EXCLUDE_MOTORWAY, or DirectionsCriteria.EXCLUDE_FERRY.
    DirectionsCriteria.PROFILE_WALKING: No excludes supported
    DirectionsCriteria.PROFILE_CYCLING: DirectionsCriteria.EXCLUDE_FERRY
    Use following format to exclude a point: point(longitude latitude)
    
    Parameters:
    
    exclude - a comma separated string. Each value matches one of the DirectionsCriteria.ExcludeCriteria exclusions or point format.
    
    Returns:
    
    this builder for chaining options together
  - excludeList
```
@NonNull
public RouteOptions.Builder excludeList(@Nullable
                                                 java.util.List<java.lang.String> exclude)
```
    Exclude certain road types or points from routing. The default is to not exclude anything from the profile selected. The following exclude flags are available for each profile:
    DirectionsCriteria.PROFILE_DRIVING: One of DirectionsCriteria.EXCLUDE_TOLL, DirectionsCriteria.EXCLUDE_MOTORWAY, or DirectionsCriteria.EXCLUDE_FERRY.
    DirectionsCriteria.PROFILE_DRIVING_TRAFFIC: One of DirectionsCriteria.EXCLUDE_TOLL, DirectionsCriteria.EXCLUDE_MOTORWAY, or DirectionsCriteria.EXCLUDE_FERRY.
    DirectionsCriteria.PROFILE_WALKING: No excludes supported
    DirectionsCriteria.PROFILE_CYCLING: DirectionsCriteria.EXCLUDE_FERRY
    Use following format to exclude a point: point(longitude latitude)
    
    Parameters:
    
    exclude - a list of exclude that were used during the request
    
    Returns:
    
    this builder for chaining options together
  - excludeObject
```
@NonNull
public RouteOptions.Builder excludeObject(@Nullable
                                                   Exclude exclude)
```
    Exclude certain road types or points from routing. The default is to not exclude anything from the profile selected.
    Exclude object may not provide all features that are currently present by Direction API. See Exclude for more details.
    
    Parameters:
    
    exclude - an object of excludes that are used during the request. Use Exclude.Builder to build exclude.
    
    Returns:
    
    this builder for chaining options together
  - include
```
@NonNull
public abstract RouteOptions.Builder include(@Nullable
                                                      java.lang.String include)
```
    Include certain road types in routing. By default, none of the road types listed below are included. The following include flags are available for each profile:
    DirectionsCriteria.PROFILE_DRIVING: One of DirectionsCriteria.INCLUDE_HOV2, DirectionsCriteria.INCLUDE_HOV3, or DirectionsCriteria.INCLUDE_HOT.
    DirectionsCriteria.PROFILE_DRIVING_TRAFFIC: One of DirectionsCriteria.INCLUDE_HOV2, DirectionsCriteria.INCLUDE_HOV3, or DirectionsCriteria.INCLUDE_HOT.
    DirectionsCriteria.PROFILE_WALKING: No includes supported
    DirectionsCriteria.PROFILE_CYCLING: No includes supported
    
    Parameters:
    
    include - a string matching one of the DirectionsCriteria.IncludeCriteria inclusions
    
    Returns:
    
    this builder for chaining options together
  - includeList
```
@NonNull
public RouteOptions.Builder includeList(@Nullable
                                                 java.util.List<java.lang.String> include)
```
    Include certain road types in routing. By default, none of the road types listed below are included. The following include flags are available for each profile:
    DirectionsCriteria.PROFILE_DRIVING: One of DirectionsCriteria.INCLUDE_HOV2, DirectionsCriteria.INCLUDE_HOV3, or DirectionsCriteria.INCLUDE_HOT.
    DirectionsCriteria.PROFILE_DRIVING_TRAFFIC: One of DirectionsCriteria.INCLUDE_HOV2, DirectionsCriteria.INCLUDE_HOV3, or DirectionsCriteria.INCLUDE_HOT.
    DirectionsCriteria.PROFILE_WALKING: No includes supported
    DirectionsCriteria.PROFILE_CYCLING: No includes supported
    
    Parameters:
    
    include - a list of include that were used during the request
    
    Returns:
    
    this builder for chaining options together
  - approaches
```
@NonNull
public abstract RouteOptions.Builder approaches(@Nullable
                                                         java.lang.String approaches)
```
    A semicolon-separated list indicating from which side of the road to approach a waypoint. Accepts DirectionsCriteria.APPROACH_UNRESTRICTED (default) or DirectionsCriteria.APPROACH_CURB. If set to DirectionsCriteria.APPROACH_UNRESTRICTED, the route can approach waypoints from either side of the road. If set to DirectionsCriteria.APPROACH_CURB, the route will be returned so that on arrival, the waypoint will be found on the side that corresponds with the driving_side of the region in which the returned route is located. If provided, the list of approaches must be the same length as the list of waypoints. However, you can skip a coordinate and show its position in the list with the ; separator. Since the first value will not be evaluated, begin the list with a semicolon. If the waypoint is within 1 meter of the road, this parameter is ignored.
    
    Parameters:
    
    approaches - a string representing approaches for each waypoint
    
    Returns:
    
    this builder for chaining options together
  - approachesList
```
@NonNull
public RouteOptions.Builder approachesList(@Nullable
                                                    java.util.List<java.lang.String> approaches)
```
    Indicates from which side of the road to approach a waypoint. Accepts DirectionsCriteria.APPROACH_UNRESTRICTED (default) or DirectionsCriteria.APPROACH_CURB . If set to DirectionsCriteria.APPROACH_UNRESTRICTED, the route can approach waypoints from either side of the road. If set to DirectionsCriteria.APPROACH_CURB, the route will be returned so that on arrival, the waypoint will be found on the side that corresponds with the driving_side of the region in which the returned route is located. If provided, the list of approaches must be the same length as the list of waypoints. However, you can skip a coordinate and show its position in the list with null. Since the first value will not be evaluated, you can begin the list with a null. If the waypoint is within 1 meter of the road, this parameter is ignored.
    
    Parameters:
    
    approaches - a list of strings representing approaches for each waypoint
    
    Returns:
    
    this builder for chaining options together
  - waypointIndices
```
@NonNull
public abstract RouteOptions.Builder waypointIndices(@Nullable
                                                              java.lang.String waypointIndices)
```
    A semicolon-separated list indicating which input coordinates should be treated as waypoints.
    Waypoints form the beginning and end of each leg in the returned route and correspond to the depart and arrive steps. If a list of waypoints is not provided, all coordinates are treated as waypoints. Each item in the list must be the zero-based index of an input coordinate, and the list must include 0 (the index of the first coordinate) and the index of the last coordinate. The waypoints parameter can be used to guide the path of the route without introducing additional legs and arrive/depart instructions.
    For example, if a coordinates list has 3 points, origin, some middle point, and destination, we can have below combinations:
    - waypointIndices are null, the route will have 2 legs
    - waypointIndices are "0;1;2", the route will have 2 legs
    - waypointIndices are "0;2", the route will have only one leg that goes via the middle point
    Must be used with RouteOptions.steps()=true.
    
    Parameters:
    
    waypointIndices - a string representing indices to be used as waypoints
    
    Returns:
    
    this builder for chaining options together
  - waypointIndicesList
```
@NonNull
public RouteOptions.Builder waypointIndicesList(@Nullable
                                                         java.util.List<java.lang.Integer> indices)
```
    A list indicating which input coordinates should be treated as waypoints.
    Waypoints form the beginning and end of each leg in the returned route and correspond to the depart and arrive steps. If a list of waypoints is not provided, all coordinates are treated as waypoints. Each item in the list must be the zero-based index of an input coordinate, and the list must include 0 (the index of the first coordinate) and the index of the last coordinate. The waypoints parameter can be used to guide the path of the route without introducing additional legs and arrive/depart instructions.
    For example, if a coordinates list has 3 points, origin, some middle point, and destination, we can have below combinations:
    - waypointIndices are null, the route will have 2 legs
    - waypointIndices are [0,1,2], the route will have 2 legs
    - waypointIndices are [0,2], the route will have only one leg that goes via the middle point
    Must be used with RouteOptions.steps()=true.
    
    Parameters:
    
    indices - a List of Integers representing indices to be used as waypoints
    
    Returns:
    
    this builder for chaining options together
  - waypointNames
```
@NonNull
public abstract RouteOptions.Builder waypointNames(@Nullable
                                                            java.lang.String waypointNames)
```
    A semicolon-separated list of custom names for entries in the list of RouteOptions.coordinates(), used for the arrival instruction in banners and voice instructions. Values can be any string, and the total number of all characters cannot exceed 500. If provided, the list of waypoint_names must be the same length as the list of coordinates. The first value in the list corresponds to the route origin, not the first destination. To leave the origin unnamed, begin the list with a semicolon. Must be used in conjunction with RouteOptions.steps()=true.
    
    Parameters:
    
    waypointNames - a string representing names for each waypoint
    
    Returns:
    
    this builder for chaining options together
  - waypointNamesList
```
@NonNull
public RouteOptions.Builder waypointNamesList(@Nullable
                                                       java.util.List<java.lang.String> waypointNames)
```
    A list of custom names for entries in the list of RouteOptions.coordinatesList(), used for the arrival instruction in banners and voice instructions. Values can be any string, and the total number of all characters cannot exceed 500. If provided, the list of names must be the same length as the list of coordinates. The first value in the list corresponds to the route origin, not the first destination.
    Must be used in conjunction with RouteOptions.steps()=true.
    
    Parameters:
    
    waypointNames - a list of strings representing names for each waypoint
    
    Returns:
    
    this builder for chaining options together
  - waypointTargets
```
@NonNull
public abstract RouteOptions.Builder waypointTargets(@Nullable
                                                              java.lang.String waypointTargets)
```
    A semicolon-separated list of coordinate pairs used to specify drop-off locations that are distinct from the locations specified in coordinates. If this parameter is provided, the Directions API will compute the side of the street, left or right, for each target based on the waypoint_targets and the driving direction. The maneuver.modifier, banner and voice instructions will be updated with the computed side of street. The number of waypoint targets must be the same as the number of coordinates, but you can skip a coordinate pair and show its position in the list with the ; separator. Since the first value will not be evaluated, begin the list with a semicolon.
    Must be used with RouteOptions.steps()=true.
    
    Parameters:
    
    waypointTargets - a list of Points representing coordinate pairs for drop-off locations
    
    Returns:
    
    this builder for chaining options together
  - waypointTargetsList
```
@NonNull
public RouteOptions.Builder waypointTargetsList(@Nullable
                                                         java.util.List<com.mapbox.geojson.Point> waypointTargets)
```
    A list of points used to specify drop-off locations that are distinct from the locations specified in coordinates. If this parameter is provided, the Directions API will compute the side of the street, left or right, for each target based on the waypoint_targets and the driving direction. The maneuver.modifier, banner and voice instructions will be updated with the computed side of street. The number of waypoint targets must be the same as the number of coordinates. You can skip a coordinate pair and show its position in the list with the "null". Since the first value will not be evaluated, you can begin the list with "null". Must be used with RouteOptions.steps()=true.
    
    Parameters:
    
    waypointTargets - a list of Points representing coordinate pairs for drop-off locations
    
    Returns:
    
    this builder for chaining options together
  - alleyBias
```
@NonNull
public abstract RouteOptions.Builder alleyBias(@Nullable
                                                        java.lang.Double alleyBias)
```
    A scale from -1 to 1, where -1 biases the route against alleys and 1 biases the route toward alleys. If null, default is 0, which is neutral.
    
    Parameters:
    
    alleyBias - bias towards alleys
    
    Returns:
    
    this builder
  - walkingSpeed
```
@NonNull
public abstract RouteOptions.Builder walkingSpeed(@Nullable
                                                           java.lang.Double walkingSpeed)
```
    The walking speed in meters per second with a minimum of 0.14 m/s (or 0.5 km/h) and a maximum of 6.94 m/s (or 25.0 km/h). If null, defaults to 1.42 m/s (5.1 km/h).
    Only available with the DirectionsCriteria.PROFILE_WALKING.
    
    Parameters:
    
    walkingSpeed - in meters per second
    
    Returns:
    
    this builder
  - walkwayBias
```
@NonNull
public abstract RouteOptions.Builder walkwayBias(@Nullable
                                                          java.lang.Double walkwayBias)
```
    A bias which determines whether the route should prefer or avoid the use of roads or paths that are set aside for pedestrian-only use (walkways). The allowed range of values is from -1 to 1, where -1 indicates indicates preference to avoid walkways, 1 indicates preference to favor walkways, and 0 indicates no preference (the default, if null).
    Only available with the DirectionsCriteria.PROFILE_WALKING.
    
    Parameters:
    
    walkwayBias - bias to prefer or avoid walkways
    
    Returns:
    
    this builder
  - snappingIncludeClosures
```
@NonNull
public abstract RouteOptions.Builder snappingIncludeClosures(@Nullable
                                                                      java.lang.String snappingClosures)
```
    A semicolon-separated list of booleans affecting snapping of waypoint locations to road segments. If true, road segments closed due to live-traffic closures will be considered for snapping. If false, they will not be considered for snapping. If provided, the number of snappingClosures must be the same as the number of coordinates. However, you can skip a coordinate and show its position in the list with the ; separator. If null, this parameter defaults to false.
    Only available with the DirectionsCriteria.PROFILE_DRIVING_TRAFFIC.
    
    Parameters:
    
    snappingClosures - a String representing a list of booleans
    
    Returns:
    
    this builder for chaining options together
  - snappingIncludeClosuresList
```
@NonNull
public RouteOptions.Builder snappingIncludeClosuresList(@Nullable
                                                                 java.util.List<java.lang.Boolean> snappingClosures)
```
    A list of booleans affecting snapping of waypoint locations to road segments. If true, road segments closed due to live-traffic closures will be considered for snapping. If false, they will not be considered for snapping. If provided, the number of snappingClosures must be the same as the number of coordinates. However, you can skip a coordinate and show its position in the list with the null. If the list is null, this parameter defaults to false.
    Only available with the DirectionsCriteria.PROFILE_DRIVING_TRAFFIC.
    
    Parameters:
    
    snappingClosures - a list of booleans
    
    Returns:
    
    this builder for chaining options together
  - snappingIncludeStaticClosures
```
@NonNull
public abstract RouteOptions.Builder snappingIncludeStaticClosures(@Nullable
                                                                            java.lang.String snappingStaticClosures)
```
    A semicolon-separated list of booleans affecting snapping of waypoint locations to road segments. If true, road segments statically closed, that is long-term, will be considered for snapping (for example, road under construction). If false, they will not be considered for snapping. If provided, the number of snappingIncludeStaticClosures must be the same as the number of waypoints. However, you can skip a coordinate and show its position in the list with the ; separator. If null, this parameter defaults to false.
    Only available with the DirectionsCriteria.PROFILE_DRIVING_TRAFFIC.
    
    Parameters:
    
    snappingStaticClosures - a String representing a list of booleans
    
    Returns:
    
    this builder for chaining options together
  - snappingIncludeStaticClosuresList
```
@NonNull
public RouteOptions.Builder snappingIncludeStaticClosuresList(@Nullable
                                                                       java.util.List<java.lang.Boolean> snappingStaticClosures)
```
    A list of booleans affecting snapping of waypoint locations to road segments. If true, road segments statically closed, that is long-term, will be considered for snapping (for example, road under construction). If false, they will not be considered for snapping. If provided, the number of snappingIncludeStaticClosures must be the same as the number of waypoints. However, you can skip a coordinate and show its position in the list with the null. If null, this parameter defaults to false.
    Only available with the DirectionsCriteria.PROFILE_DRIVING_TRAFFIC.
    
    Parameters:
    
    snappingStaticClosures - a list of booleans
    
    Returns:
    
    this builder for chaining options together
  - arriveBy
```
@NonNull
public abstract RouteOptions.Builder arriveBy(@Nullable
                                                       java.lang.String arriveBy)
```
    The desired arrival time, formatted as a timestamp in ISO-8601 format in the local time at the route destination. The travel time returned in duration is a prediction for travel time based on historical travel data. The route is calculated in a time-dependent manner. For example, a trip that takes two hours will consider changing historic traffic conditions across the two-hour window. The route takes timed turn restrictions and conditional access restrictions into account based on the requested arrival time.
    Only available with the DirectionsCriteria.PROFILE_DRIVING.
    
    Parameters:
    
    arriveBy - arrive time ISO8601, see FormatUtils.ISO_8601_PATTERN
    
    Returns:
    
    this builder for chaining options together
  - departAt
```
@NonNull
public abstract RouteOptions.Builder departAt(@Nullable
                                                       java.lang.String departAt)
```
    The departure time, formatted as a timestamp in ISO-8601 format in the local time at the route origin. The travel time returned in duration is a prediction for travel time based on historical travel data. The route is calculated in a time-dependent manner. For example, a trip that takes two hours will consider changing historic traffic conditions across the two-hour window, instead of only at the specified depart_at time. The route takes timed turn restrictions and conditional access restrictions into account based on the requested departure time.
    Only available with the DirectionsCriteria.PROFILE_DRIVING.
    
    Parameters:
    
    departAt - departure time ISO8601, see FormatUtils.ISO_8601_PATTERN
    
    Returns:
    
    this builder for chaining options together
  - maxHeight
```
@NonNull
public abstract RouteOptions.Builder maxHeight(@Nullable
                                                        java.lang.Double maxHeight)
```
    The max vehicle height in meters. If this parameter is provided, the Directions API will compute a route that includes only roads with a height limit greater than or equal to the max vehicle height. The default value is 1.6 meters.
    Available for DirectionsCriteria.PROFILE_DRIVING_TRAFFIC and DirectionsCriteria.PROFILE_DRIVING.
    
    Parameters:
    
    maxHeight - max vehicle height, in meters. Must be between 0 and 10.
    
    Returns:
    
    this builder
  - maxWidth
```
@NonNull
public abstract RouteOptions.Builder maxWidth(@Nullable
                                                       java.lang.Double maxWidth)
```
    The max vehicle width in meters. If this parameter is provided, the Directions API will compute a route that includes only roads with a width limit greater than or equal to the max vehicle width. The default value is 1.9 meters.
    Available for DirectionsCriteria.PROFILE_DRIVING_TRAFFIC and DirectionsCriteria.PROFILE_DRIVING.
    
    Parameters:
    
    maxWidth - max vehicle width, in meters. Must be between 0 and 10.
    
    Returns:
    
    this builder
  - maxWeight
```
@NonNull
public abstract RouteOptions.Builder maxWeight(@Nullable
                                                        java.lang.Double maxWeight)
```
    The max vehicle weight, in metric tons (1000 kg). If this parameter is provided, the Directions API will compute a route that includes only roads with a weight limit greater than or equal to the max vehicle weight. max_weight must be between 0 and 100 metric tons.
    The default value is 2.5 metric tons.
    
    Parameters:
    
    maxWeight - max vehicle weight, in tons. Must be between 0 and 100.
    
    Returns:
    
    this builder
  - enableRefresh
```
@NonNull
public abstract RouteOptions.Builder enableRefresh(@Nullable
                                                            java.lang.Boolean enableRefresh)
```
    Whether the routes should be refreshable via the directions refresh API.
    If false, the refresh requests will fail. Defaults to false if null.
    
    Parameters:
    
    enableRefresh - whether the routes should be refreshable
    
    Returns:
    
    this builder
  - computeTollCost
```
@NonNull
public abstract RouteOptions.Builder computeTollCost(@Nullable
                                                              java.lang.Boolean computeTollCost)
```
  - waypointsPerRoute
```
@NonNull
public abstract RouteOptions.Builder waypointsPerRoute(@Nullable
                                                                java.lang.Boolean waypointsPerRoute)
```
    If true, the waypoints array is returned within the route object, else its returned at the root of the response body. Defaults to false if unspecified. Setting `waypoints_per_route` to true is necessary when asking for an EV-optimized route with alternatives, since each alternative route may produce separate sets of waypoints (charging stations).
    
    Parameters:
    
    waypointsPerRoute - boolean representing the `waypoints_per_route` value
    
    Returns:
    
    this builder
  - metadata
```
@NonNull
public abstract RouteOptions.Builder metadata(@Nullable
                                                       java.lang.Boolean metadata)
```
    Whether the response should contain metadata holding versioning information.
    
    Parameters:
    
    metadata - whether the routes should be refreshable
    
    Returns:
    
    this builder
  - suppressVoiceInstructionLocalNames
```
@NonNull
public abstract RouteOptions.Builder suppressVoiceInstructionLocalNames(@Nullable
                                                                                 java.lang.Boolean suppressVoiceInstructionLocalNames)
```
  - unrecognizedProperties
```
@NonNull
public RouteOptions.Builder unrecognizedProperties(@Nullable
                                                            java.util.Map<java.lang.String,java.lang.String> unrecognizedProperties)
```
    Use this method to add request parameters, which are not present in the model yet but are supported on the Directions API, to a URL generated by `RouteOptions#toUrl`. Use it for experimental parameters.
    
    Parameters:
    
    unrecognizedProperties - parameters to add to request
  - paymentMethods
```
@NonNull
public abstract RouteOptions.Builder paymentMethods(@Nullable
                                                             java.lang.String paymentMethods)
```
  - paymentMethodsList
```
@NonNull
public RouteOptions.Builder paymentMethodsList(@Nullable
                                                        java.util.List<java.lang.String> paymentMethods)
```
  - build
```
@NonNull
public abstract RouteOptions build()
```
    Builds the object.
    
    Returns:
    
    a new instance of RouteOptions
  - unrecognizedJsonProperties
```
@NonNull
public T unrecognizedJsonProperties(@Nullable
                                             java.util.Map<java.lang.String,com.google.gson.JsonElement> unrecognizedProperties)
```
    Use this method to add parameters which are not present in the model yet but are supported on the Directions API side in the response. Use it for experimental parameters.
    
    Parameters:
    
    unrecognizedProperties - parameters to add to request

Class RouteOptions.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

baseUrl

user

profile

coordinates

coordinatesList

alternatives

language

radiuses

radiusesList

bearings

bearingsList

avoidManeuverRadius

layers

layersList

continueStraight

roundaboutExits

geometries

overview

steps

annotations

annotationsList

voiceInstructions

bannerInstructions

voiceUnits

exclude

excludeList

excludeObject

include

includeList

approaches

approachesList

waypointIndices

waypointIndicesList

waypointNames

waypointNamesList

waypointTargets

waypointTargetsList

alleyBias

walkingSpeed

walkwayBias

snappingIncludeClosures

snappingIncludeClosuresList

snappingIncludeStaticClosures

snappingIncludeStaticClosuresList

arriveBy

departAt

maxHeight

maxWidth

maxWeight

enableRefresh

computeTollCost

waypointsPerRoute

metadata

suppressVoiceInstructionLocalNames

unrecognizedProperties

paymentMethods

paymentMethodsList

build

unrecognizedJsonProperties