DirectionsCriteria (services 4.2.0-SNAPSHOT API)

java.lang.Object
- com.mapbox.api.directions.v5.DirectionsCriteria

```
public final class DirectionsCriteria
extends java.lang.Object
```
Constants and properties used to customize the directions request.

Since:

1.0.0

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DirectionsCriteria.AnnotationCriteria` Retention policy for the various direction annotations.
`static interface`	`DirectionsCriteria.ApproachesCriteria` Retention policy for the approaches parameter in the MapMatching and Directions API.
`static interface`	`DirectionsCriteria.DestinationCriteria` Retention policy for the destination parameter in the Optimization API.
`static interface`	`DirectionsCriteria.ExcludeCriteria` Retention policy for the various direction exclusions.
`static interface`	`DirectionsCriteria.GeometriesCriteria` Retention policy for the various direction geometries.
`static interface`	`DirectionsCriteria.OverviewCriteria` Retention policy for the various direction overviews.
`static interface`	`DirectionsCriteria.ProfileCriteria` Retention policy for the various direction profiles.
`static interface`	`DirectionsCriteria.SourceCriteria` Retention policy for the source parameter in the Optimization API.
`static interface`	`DirectionsCriteria.VoiceUnitCriteria` Retention policy for the various units of measurements.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ANNOTATION_CONGESTION` The congestion, provided as a String, between each pair of coordinates.
`static java.lang.String`	`ANNOTATION_DISTANCE` The distance, in meters, between each pair of coordinates.
`static java.lang.String`	`ANNOTATION_DURATION` The duration, in seconds, between each pair of coordinates.
`static java.lang.String`	`ANNOTATION_MAXSPEED` The posted speed limit, between each pair of coordinates.
`static java.lang.String`	`ANNOTATION_SPEED` The speed, in km/h, between each pair of coordinates.
`static java.lang.String`	`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.
`static java.lang.String`	`APPROACH_UNRESTRICTED` The routes can approach waypoints from either side of the road.
`static java.lang.String`	`DESTINATION_ANY` Returned route ends at any of the provided coordinate in the list.
`static java.lang.String`	`DESTINATION_LAST` Returned route ends at the last provided coordinate in the list.
`static java.lang.String`	`EXCLUDE_FERRY` Exclude all ferries along the returned directions route.
`static java.lang.String`	`EXCLUDE_MOTORWAY` Exclude all motorways along the returned directions route.
`static java.lang.String`	`EXCLUDE_RESTRICTED` Exclude all roads with access restrictions along the returned directions route.
`static java.lang.String`	`EXCLUDE_TOLL` Exclude all tolls along the returned directions route.
`static java.lang.String`	`EXCLUDE_TUNNEL` Exclude all tunnels along the returned directions route.
`static java.lang.String`	`GEOMETRY_POLYLINE` Format to return route geometry will be an encoded polyline.
`static java.lang.String`	`GEOMETRY_POLYLINE6` Format to return route geometry will be an encoded polyline with precision 6.
`static java.lang.String`	`IMPERIAL` Change the units to imperial for voice and visual information.
`static java.lang.String`	`METRIC` Change the units to metric for voice and visual information.
`static java.lang.String`	`OVERVIEW_FALSE` No overview geometry.
`static java.lang.String`	`OVERVIEW_FULL` The most detailed geometry available.
`static java.lang.String`	`OVERVIEW_SIMPLIFIED` A simplified version of the `OVERVIEW_FULL` geometry.
`static java.lang.String`	`PROFILE_CYCLING` For bicycle routing.
`static java.lang.String`	`PROFILE_DEFAULT_USER` Mapbox default username.
`static java.lang.String`	`PROFILE_DRIVING` For car and motorcycle routing.
`static java.lang.String`	`PROFILE_DRIVING_TRAFFIC` For car and motorcycle routing.
`static java.lang.String`	`PROFILE_WALKING` For pedestrian and hiking routing.
`static java.lang.String`	`SOURCE_ANY` Returned route starts at any of the provided coordinate in the list.
`static java.lang.String`	`SOURCE_FIRST` Returned route starts at the first provided coordinate in the list.

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

- Field Detail
  - PROFILE_DEFAULT_USER
```
public static final java.lang.String PROFILE_DEFAULT_USER
```
    Mapbox default username.
    
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - PROFILE_DRIVING_TRAFFIC
```
public static final java.lang.String PROFILE_DRIVING_TRAFFIC
```
    For car and motorcycle routing. This profile factors in current and historic traffic conditions to avoid slowdowns.
    
    Since:
    
    2.0.0
    
    See Also:
    
    Constant Field Values
  - PROFILE_DRIVING
```
public static final java.lang.String PROFILE_DRIVING
```
    For car and motorcycle routing. This profile shows the fastest routes by preferring high-speed roads like highways.
    
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - PROFILE_WALKING
```
public static final java.lang.String PROFILE_WALKING
```
    For pedestrian and hiking routing. This profile shows the shortest path by using sidewalks and trails.
    
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - PROFILE_CYCLING
```
public static final java.lang.String PROFILE_CYCLING
```
    For bicycle routing. This profile shows routes that are short and safe for cyclist, avoiding highways and preferring streets with bike lanes.
    
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - GEOMETRY_POLYLINE
```
public static final java.lang.String GEOMETRY_POLYLINE
```
    Format to return route geometry will be an encoded polyline.
    
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - GEOMETRY_POLYLINE6
```
public static final java.lang.String GEOMETRY_POLYLINE6
```
    Format to return route geometry will be an encoded polyline with precision 6.
    
    Since:
    
    2.0.0
    
    See Also:
    
    Constant Field Values
  - OVERVIEW_SIMPLIFIED
```
public static final java.lang.String OVERVIEW_SIMPLIFIED
```
    A simplified version of the OVERVIEW_FULL geometry. If not specified simplified is the default.
    
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - OVERVIEW_FULL
```
public static final java.lang.String OVERVIEW_FULL
```
    The most detailed geometry available.
    
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - OVERVIEW_FALSE
```
public static final java.lang.String OVERVIEW_FALSE
```
    No overview geometry.
    
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - ANNOTATION_DURATION
```
public static final java.lang.String ANNOTATION_DURATION
```
    The duration, in seconds, between each pair of coordinates.
    
    Since:
    
    2.1.0
    
    See Also:
    
    Constant Field Values
  - ANNOTATION_DISTANCE
```
public static final java.lang.String ANNOTATION_DISTANCE
```
    The distance, in meters, between each pair of coordinates.
    
    Since:
    
    2.1.0
    
    See Also:
    
    Constant Field Values
  - ANNOTATION_SPEED
```
public static final java.lang.String ANNOTATION_SPEED
```
    The speed, in km/h, between each pair of coordinates.
    
    Since:
    
    2.1.0
    
    See Also:
    
    Constant Field Values
  - ANNOTATION_CONGESTION
```
public static final java.lang.String ANNOTATION_CONGESTION
```
    The congestion, provided as a String, between each pair of coordinates.
    
    Since:
    
    2.2.0
    
    See Also:
    
    Constant Field Values
  - ANNOTATION_MAXSPEED
```
public static final java.lang.String ANNOTATION_MAXSPEED
```
    The posted speed limit, between each pair of coordinates.
    
    Since:
    
    2.1.0
    
    See Also:
    
    Constant Field Values
  - EXCLUDE_TOLL
```
public static final java.lang.String EXCLUDE_TOLL
```
    Exclude all tolls along the returned directions route.
    
    Since:
    
    3.0.0
    
    See Also:
    
    Constant Field Values
  - EXCLUDE_MOTORWAY
```
public static final java.lang.String EXCLUDE_MOTORWAY
```
    Exclude all motorways along the returned directions route.
    
    Since:
    
    3.0.0
    
    See Also:
    
    Constant Field Values
  - EXCLUDE_FERRY
```
public static final java.lang.String EXCLUDE_FERRY
```
    Exclude all ferries along the returned directions route.
    
    Since:
    
    3.0.0
    
    See Also:
    
    Constant Field Values
  - EXCLUDE_TUNNEL
```
public static final java.lang.String EXCLUDE_TUNNEL
```
    Exclude all tunnels along the returned directions route.
    
    Since:
    
    3.0.0
    
    See Also:
    
    Constant Field Values
  - EXCLUDE_RESTRICTED
```
public static final java.lang.String EXCLUDE_RESTRICTED
```
    Exclude all roads with access restrictions along the returned directions route.
    
    Since:
    
    3.0.0
    
    See Also:
    
    Constant Field Values
  - IMPERIAL
```
public static final java.lang.String IMPERIAL
```
    Change the units to imperial for voice and visual information. Note that this won't change other results such as raw distance measurements which will always be returned in meters.
    
    Since:
    
    3.0.0
    
    See Also:
    
    Constant Field Values
  - METRIC
```
public static final java.lang.String METRIC
```
    Change the units to metric for voice and visual information. Note that this won't change other results such as raw distance measurements which will always be returned in meters.
    
    Since:
    
    3.0.0
    
    See Also:
    
    Constant Field Values
  - SOURCE_FIRST
```
public static final java.lang.String SOURCE_FIRST
```
    Returned route starts at the first provided coordinate in the list. Used specifically for the Optimization API.
    
    Since:
    
    2.1.0
    
    See Also:
    
    Constant Field Values
  - SOURCE_ANY
```
public static final java.lang.String SOURCE_ANY
```
    Returned route starts at any of the provided coordinate in the list. Used specifically for the Optimization API.
    
    Since:
    
    2.1.0
    
    See Also:
    
    Constant Field Values
  - DESTINATION_ANY
```
public static final java.lang.String DESTINATION_ANY
```
    Returned route ends at any of the provided coordinate in the list. Used specifically for the Optimization API.
    
    Since:
    
    3.0.0
    
    See Also:
    
    Constant Field Values
  - DESTINATION_LAST
```
public static final java.lang.String DESTINATION_LAST
```
    Returned route ends at the last provided coordinate in the list. Used specifically for the Optimization API.
    
    Since:
    
    3.0.0
    
    See Also:
    
    Constant Field Values
  - APPROACH_UNRESTRICTED
```
public static final java.lang.String APPROACH_UNRESTRICTED
```
    The routes can approach waypoints from either side of the road.
    Used in MapMatching and Directions API.
    
    Since:
    
    3.2.0
    
    See Also:
    
    Constant Field Values
  - APPROACH_CURB
```
public static final java.lang.String 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.
    Used in MapMatching and Directions API.
    
    Since:
    
    3.2.0
    
    See Also:
    
    Constant Field Values

Class DirectionsCriteria

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROFILE_DEFAULT_USER

PROFILE_DRIVING_TRAFFIC

PROFILE_DRIVING

PROFILE_WALKING

PROFILE_CYCLING

GEOMETRY_POLYLINE

GEOMETRY_POLYLINE6

OVERVIEW_SIMPLIFIED

OVERVIEW_FULL

OVERVIEW_FALSE

ANNOTATION_DURATION

ANNOTATION_DISTANCE

ANNOTATION_SPEED

ANNOTATION_CONGESTION

ANNOTATION_MAXSPEED

EXCLUDE_TOLL

EXCLUDE_MOTORWAY

EXCLUDE_FERRY

EXCLUDE_TUNNEL

EXCLUDE_RESTRICTED

IMPERIAL

METRIC

SOURCE_FIRST

SOURCE_ANY

DESTINATION_ANY

DESTINATION_LAST

APPROACH_UNRESTRICTED

APPROACH_CURB