public final class DirectionsCriteria
extends java.lang.Object
| Modifier and Type | Class and Description |
|---|---|
static interface |
DirectionsCriteria.AmenityTypeCriteria
Supported amenity types.
|
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.IncludeCriteria
Retention policy for include key.
|
static interface |
DirectionsCriteria.NotificationsEvStationUnavailableReasonCriteria
Supported EV station unavailable reasons.
|
static interface |
DirectionsCriteria.NotificationsFlowCriteria
Supported
RouteOptions.notifications() parameter values. |
static interface |
DirectionsCriteria.NotificationsRefreshTypeCriteria
Supported notification refresh types.
|
static interface |
DirectionsCriteria.NotificationsSubtypeCriteria
Supported notification subtypes.
|
static interface |
DirectionsCriteria.NotificationsTypeCriteria
Supported notification types.
|
static interface |
DirectionsCriteria.OverviewCriteria
Retention policy for the various direction overviews.
|
static interface |
DirectionsCriteria.PaymentMethodsCriteria |
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.TrafficTendencyCriteria |
static interface |
DirectionsCriteria.VoiceUnitCriteria
Retention policy for the various units of measurements.
|
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
AMENITY_TYPE_ATM
ATM amenity type.
|
static java.lang.String |
AMENITY_TYPE_BABY_CARE
Baby care amenity type.
|
static java.lang.String |
AMENITY_TYPE_COFFEE
Coffee amenity type.
|
static java.lang.String |
AMENITY_TYPE_ELECTRIC_CHARGING_STATION
Electric charging station amenity type.
|
static java.lang.String |
AMENITY_TYPE_FACILITIES_FOR_DISABLED
Facilities for disabled amenity type.
|
static java.lang.String |
AMENITY_TYPE_FAX
FAX amenity type.
|
static java.lang.String |
AMENITY_TYPE_GAS_STATION
Gas station amenity type.
|
static java.lang.String |
AMENITY_TYPE_HOTEL
Hotel amenity type.
|
static java.lang.String |
AMENITY_TYPE_HOTSPRING
Hotspring amenity type.
|
static java.lang.String |
AMENITY_TYPE_INFO
Info amenity type.
|
static java.lang.String |
AMENITY_TYPE_PICNIC_SHELTER
Picnic shelter amenity type.
|
static java.lang.String |
AMENITY_TYPE_POST
Post amenity type.
|
static java.lang.String |
AMENITY_TYPE_RESTAURANT
Restaurant amenity type.
|
static java.lang.String |
AMENITY_TYPE_SHOP
Shop amenity type.
|
static java.lang.String |
AMENITY_TYPE_SHOWER
Shower amenity type.
|
static java.lang.String |
AMENITY_TYPE_SNACK
Snack amenity type.
|
static java.lang.String |
AMENITY_TYPE_TELEPHONE
Telephone amenity type.
|
static java.lang.String |
AMENITY_TYPE_TOILET
Toilet amenity type.
|
static java.lang.String |
ANNOTATION_CLOSURE
An array of closure objects describing live-traffic related closures
that occur along the route.
|
static java.lang.String |
ANNOTATION_CONGESTION
The level of congestion between each entry in the array of coordinate pairs
in the route leg.
|
static java.lang.String |
ANNOTATION_CONGESTION_NUMERIC
The numeric level of congestion between each entry in the array of coordinate pairs
in the route leg.
|
static java.lang.String |
ANNOTATION_CURRENT_SPEED
The current speed value conveys the instantaneous (at the time of the request) speed.
|
static java.lang.String |
ANNOTATION_DISTANCE
The distance between each pair of coordinates in meters.
|
static java.lang.String |
ANNOTATION_DURATION
The duration between each pair of coordinates in seconds.
|
static java.lang.String |
ANNOTATION_FREEFLOW_SPEED
The freeflow value conveys the typical speed at low traffic times of day
such as nights or early mornings.
|
static java.lang.String |
ANNOTATION_MAXSPEED
The maximum speed limit between the coordinates of a segment.
|
static java.lang.String |
ANNOTATION_SPEED
The speed between each pair of coordinates in meters per second.
|
static java.lang.String |
ANNOTATION_TRAFFIC_TENDENCY |
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 |
BASE_API_URL
Base URL for all API calls.
|
static java.lang.String |
BRITISH_IMPERIAL
Change the units to british imperial for voice and visual information.
|
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_CASH_ONLY_TOLLS
Exclude all cash only tolls along the returned directions route.
|
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 |
EXCLUDE_UNPAVED
Exclude all unpaved roads 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 |
INCLUDE_HOT
An hov road that is tolled if your vehicle doesn't meet the minimum occupant requirement.
|
static java.lang.String |
INCLUDE_HOV2
A road type that requires a minimum of two vehicle occupants.
|
static java.lang.String |
INCLUDE_HOV3
A road type that requires a minimum of three vehicle occupants.
|
static java.lang.String |
METRIC
Change the units to metric for voice and visual information.
|
static java.lang.String |
NOTIFICATION_EV_STATION_OCCUPIED
`Occupied` reason for unavailability of the charging station for the electric vehicle.
|
static java.lang.String |
NOTIFICATION_EV_STATION_OUT_OF_ORDER
Out of order reason for unavailability of the charging station for the electric vehicle.
|
static java.lang.String |
NOTIFICATION_FLOW_ALL
Include all notifications in the route response (see
RouteLeg.notifications()). |
static java.lang.String |
NOTIFICATION_FLOW_NONE
Include none of the notifications in the route response (see
RouteLeg.notifications()). |
static java.lang.String |
NOTIFICATION_REFRESH_TYPE_DYNAMIC
A notification that is updated and reset with each route refresh.
|
static java.lang.String |
NOTIFICATION_REFRESH_TYPE_STATIC
A notification that is received with the initial route request or during one of the route
refreshes, but is then kept constant and not updated on route refreshes.
|
static java.lang.String |
NOTIFICATION_SUBTYPE_COUNTRY_BORDER_CROSSING
Country border exclusion notification subtype of type
NOTIFICATION_TYPE_VIOLATION. |
static java.lang.String |
NOTIFICATION_SUBTYPE_EV_INSUFFICIENT_CHARGE
EV insufficient charge notification subtype of type
NOTIFICATION_TYPE_ALERT. |
static java.lang.String |
NOTIFICATION_SUBTYPE_EV_MIN_CHARGE_AT_CHARGING_STATION
EV minimal charge at charging station notification subtype of type
NOTIFICATION_TYPE_VIOLATION. |
static java.lang.String |
NOTIFICATION_SUBTYPE_EV_MIN_CHARGE_AT_DESTINATION
EV minimal charge at charging station notification subtype of type
NOTIFICATION_TYPE_VIOLATION. |
static java.lang.String |
NOTIFICATION_SUBTYPE_EV_STATION_UNAVAILABLE
Station unavailable notification subtype of type
NOTIFICATION_TYPE_ALERT. |
static java.lang.String |
NOTIFICATION_SUBTYPE_MAX_HEIGHT
Max height notification subtype of type
NOTIFICATION_TYPE_VIOLATION. |
static java.lang.String |
NOTIFICATION_SUBTYPE_MAX_WEIGHT
Max weight notification subtype of type
NOTIFICATION_TYPE_VIOLATION. |
static java.lang.String |
NOTIFICATION_SUBTYPE_MAX_WIDTH
Max width notification subtype of type
NOTIFICATION_TYPE_VIOLATION. |
static java.lang.String |
NOTIFICATION_SUBTYPE_POINT_EXCLUSION
Point exclusion notification subtype of type
NOTIFICATION_TYPE_VIOLATION. |
static java.lang.String |
NOTIFICATION_SUBTYPE_STATE_BORDER_CROSSING
State border exclusion notification subtype of type
NOTIFICATION_TYPE_VIOLATION. |
static java.lang.String |
NOTIFICATION_SUBTYPE_TUNNEL
Tunnel notification subtype of type
NOTIFICATION_TYPE_VIOLATION. |
static java.lang.String |
NOTIFICATION_SUBTYPE_UNPAVED
Unpaved notification subtype of type
NOTIFICATION_TYPE_VIOLATION. |
static java.lang.String |
NOTIFICATION_TYPE_ALERT
Alert notification type.
|
static java.lang.String |
NOTIFICATION_TYPE_VIOLATION
Violation notification type.
|
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 |
PAYMENT_METHOD_APP |
static java.lang.String |
PAYMENT_METHOD_CASH |
static java.lang.String |
PAYMENT_METHOD_COINS |
static java.lang.String |
PAYMENT_METHOD_CREDIT_CARDS |
static java.lang.String |
PAYMENT_METHOD_CRYPTOCURRENCIES |
static java.lang.String |
PAYMENT_METHOD_DEBIT_CARDS |
static java.lang.String |
PAYMENT_METHOD_ETC |
static java.lang.String |
PAYMENT_METHOD_ETC2 |
static java.lang.String |
PAYMENT_METHOD_ETCX |
static java.lang.String |
PAYMENT_METHOD_EXACT_CASH |
static java.lang.String |
PAYMENT_METHOD_GENERAL |
static java.lang.String |
PAYMENT_METHOD_NOTES |
static java.lang.String |
PAYMENT_METHOD_PASS_CARD |
static java.lang.String |
PAYMENT_METHOD_VIDEO |
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.
|
static int |
TRAFFIC_TENDENCY_CONSTANT_CONGESTION |
static int |
TRAFFIC_TENDENCY_DECREASING_CONGESTION |
static int |
TRAFFIC_TENDENCY_INCREASING_CONGESTION |
static int |
TRAFFIC_TENDENCY_RAPIDLY_DECREASING_CONGESTION |
static int |
TRAFFIC_TENDENCY_RAPIDLY_INCREASING_CONGESTION |
static int |
TRAFFIC_TENDENCY_UNKNOWN |
public static final java.lang.String PROFILE_DEFAULT_USER
public static final java.lang.String BASE_API_URL
public static final java.lang.String PROFILE_DRIVING_TRAFFIC
public static final java.lang.String PROFILE_DRIVING
public static final java.lang.String PROFILE_WALKING
public static final java.lang.String PROFILE_CYCLING
public static final java.lang.String GEOMETRY_POLYLINE
public static final java.lang.String GEOMETRY_POLYLINE6
public static final java.lang.String OVERVIEW_SIMPLIFIED
OVERVIEW_FULL geometry. If not specified simplified is
the default.public static final java.lang.String OVERVIEW_FULL
public static final java.lang.String OVERVIEW_FALSE
public static final java.lang.String ANNOTATION_DURATION
public static final java.lang.String ANNOTATION_DISTANCE
public static final java.lang.String ANNOTATION_SPEED
public static final java.lang.String ANNOTATION_CONGESTION
PROFILE_DRIVING_TRAFFIC.public static final java.lang.String ANNOTATION_CONGESTION_NUMERIC
PROFILE_DRIVING_TRAFFIC.public static final java.lang.String ANNOTATION_MAXSPEED
PROFILE_DRIVING and
the PROFILE_DRIVING_TRAFFIC.public static final java.lang.String ANNOTATION_CLOSURE
PROFILE_DRIVING_TRAFFIC.public static final java.lang.String ANNOTATION_TRAFFIC_TENDENCY
public static final java.lang.String ANNOTATION_FREEFLOW_SPEED
public static final java.lang.String ANNOTATION_CURRENT_SPEED
public static final java.lang.String EXCLUDE_TOLL
public static final java.lang.String EXCLUDE_MOTORWAY
public static final java.lang.String EXCLUDE_FERRY
public static final java.lang.String EXCLUDE_TUNNEL
public static final java.lang.String EXCLUDE_RESTRICTED
public static final java.lang.String EXCLUDE_CASH_ONLY_TOLLS
public static final java.lang.String EXCLUDE_UNPAVED
public static final java.lang.String INCLUDE_HOV2
public static final java.lang.String INCLUDE_HOV3
public static final java.lang.String INCLUDE_HOT
public static final java.lang.String IMPERIAL
public static final java.lang.String METRIC
public static final java.lang.String BRITISH_IMPERIAL
public static final java.lang.String SOURCE_FIRST
public static final java.lang.String SOURCE_ANY
public static final java.lang.String DESTINATION_ANY
public static final java.lang.String DESTINATION_LAST
public static final java.lang.String APPROACH_UNRESTRICTED
Used in MapMatching and Directions API.
public static final java.lang.String APPROACH_CURB
public static final int TRAFFIC_TENDENCY_UNKNOWN
public static final int TRAFFIC_TENDENCY_CONSTANT_CONGESTION
public static final int TRAFFIC_TENDENCY_INCREASING_CONGESTION
public static final int TRAFFIC_TENDENCY_DECREASING_CONGESTION
public static final int TRAFFIC_TENDENCY_RAPIDLY_INCREASING_CONGESTION
public static final int TRAFFIC_TENDENCY_RAPIDLY_DECREASING_CONGESTION
public static final java.lang.String PAYMENT_METHOD_GENERAL
public static final java.lang.String PAYMENT_METHOD_ETC
public static final java.lang.String PAYMENT_METHOD_ETC2
public static final java.lang.String PAYMENT_METHOD_ETCX
public static final java.lang.String PAYMENT_METHOD_CASH
public static final java.lang.String PAYMENT_METHOD_EXACT_CASH
public static final java.lang.String PAYMENT_METHOD_COINS
public static final java.lang.String PAYMENT_METHOD_NOTES
public static final java.lang.String PAYMENT_METHOD_DEBIT_CARDS
public static final java.lang.String PAYMENT_METHOD_PASS_CARD
public static final java.lang.String PAYMENT_METHOD_CREDIT_CARDS
public static final java.lang.String PAYMENT_METHOD_VIDEO
public static final java.lang.String PAYMENT_METHOD_CRYPTOCURRENCIES
public static final java.lang.String PAYMENT_METHOD_APP
public static final java.lang.String AMENITY_TYPE_GAS_STATION
public static final java.lang.String AMENITY_TYPE_ELECTRIC_CHARGING_STATION
public static final java.lang.String AMENITY_TYPE_TOILET
public static final java.lang.String AMENITY_TYPE_COFFEE
public static final java.lang.String AMENITY_TYPE_RESTAURANT
public static final java.lang.String AMENITY_TYPE_SNACK
public static final java.lang.String AMENITY_TYPE_ATM
public static final java.lang.String AMENITY_TYPE_INFO
public static final java.lang.String AMENITY_TYPE_BABY_CARE
public static final java.lang.String AMENITY_TYPE_FACILITIES_FOR_DISABLED
public static final java.lang.String AMENITY_TYPE_SHOP
public static final java.lang.String AMENITY_TYPE_TELEPHONE
public static final java.lang.String AMENITY_TYPE_HOTEL
public static final java.lang.String AMENITY_TYPE_HOTSPRING
public static final java.lang.String AMENITY_TYPE_SHOWER
public static final java.lang.String AMENITY_TYPE_PICNIC_SHELTER
public static final java.lang.String AMENITY_TYPE_POST
public static final java.lang.String AMENITY_TYPE_FAX
public static final java.lang.String NOTIFICATION_TYPE_VIOLATION
Notification.type() will have this value
if some request parameters were violated.public static final java.lang.String NOTIFICATION_TYPE_ALERT
Notification.type() will have this value
if some implicit route preferences cannot be satisfiedpublic static final java.lang.String NOTIFICATION_REFRESH_TYPE_STATIC
Notification.refreshType() will have this valuepublic static final java.lang.String NOTIFICATION_REFRESH_TYPE_DYNAMIC
Notification.refreshType() will have this valuepublic static final java.lang.String NOTIFICATION_SUBTYPE_MAX_HEIGHT
NOTIFICATION_TYPE_VIOLATION.
Notification.subtype() will have this value
if RouteOptions.maxHeight() parameter is violated.public static final java.lang.String NOTIFICATION_SUBTYPE_MAX_WIDTH
NOTIFICATION_TYPE_VIOLATION.
Notification.subtype() will have this value
if RouteOptions.maxWidth() parameter is violated.public static final java.lang.String NOTIFICATION_SUBTYPE_MAX_WEIGHT
NOTIFICATION_TYPE_VIOLATION.
Notification.subtype() will have this value
if RouteOptions.maxWeight() parameter is violated.public static final java.lang.String NOTIFICATION_SUBTYPE_UNPAVED
NOTIFICATION_TYPE_VIOLATION.
Notification.subtype() will have this value
if RouteOptions.exclude() parameter with value
EXCLUDE_UNPAVED is violated.public static final java.lang.String NOTIFICATION_SUBTYPE_POINT_EXCLUSION
NOTIFICATION_TYPE_VIOLATION.
Notification.subtype() will have this value
if RouteOptions.exclude() parameter with point value is violated.public static final java.lang.String NOTIFICATION_SUBTYPE_COUNTRY_BORDER_CROSSING
NOTIFICATION_TYPE_VIOLATION.
Notification.subtype() will have this value
if RouteOptions.exclude() parameter "country_border" is violated.
Country border notification subtype of type
NOTIFICATION_TYPE_ALERT.
Notification.subtype() will have this value if route crosses a country border.
public static final java.lang.String NOTIFICATION_SUBTYPE_STATE_BORDER_CROSSING
NOTIFICATION_TYPE_VIOLATION.
Notification.subtype() will have this value
if RouteOptions.exclude() parameter "state_border" is violated.
State border notification subtype of type
NOTIFICATION_TYPE_ALERT.
Notification.subtype() will have this value if route crosses a state border.
public static final java.lang.String NOTIFICATION_SUBTYPE_EV_MIN_CHARGE_AT_CHARGING_STATION
NOTIFICATION_TYPE_VIOLATION.
Notification.subtype() will have this value
if route request is EV (engine=electric) and EV's battery charge level was less
than requested at a charging station.public static final java.lang.String NOTIFICATION_SUBTYPE_EV_MIN_CHARGE_AT_DESTINATION
NOTIFICATION_TYPE_VIOLATION.
Notification.subtype() will have this value
if route request is EV (engine=electric) and EV's battery charge level was less
than requested at a destinationpublic static final java.lang.String NOTIFICATION_SUBTYPE_TUNNEL
NOTIFICATION_TYPE_VIOLATION.
Notification.subtype() will have this value
if RouteOptions.exclude() tunnel parameter is violated.
Tunnel notification subtype of type
NOTIFICATION_TYPE_ALERT.
Notification.subtype() will have this value if route has a tunnel
public static final java.lang.String NOTIFICATION_SUBTYPE_EV_INSUFFICIENT_CHARGE
NOTIFICATION_TYPE_ALERT.
Notification.subtype() will have this value if route request is EV (engine=electric)
and EV's battery charge level transitioned from a positive value to zero or less for the first
time on a leg. Note that if a leg starts with zero charge level the notification is not
emitted.public static final java.lang.String NOTIFICATION_SUBTYPE_EV_STATION_UNAVAILABLE
NOTIFICATION_TYPE_ALERT.
Notification.subtype() will have this value if route request is EV (engine=electric)
and the station offered during trip planning became unavailable.
The reason for availability change is provided in field Notification.reason() and
can be either NOTIFICATION_EV_STATION_OUT_OF_ORDER
(when station broke down) or NOTIFICATION_EV_STATION_OCCUPIED
(when there are no available chargers at the station)public static final java.lang.String NOTIFICATION_EV_STATION_OUT_OF_ORDER
Notification.reason() will have this value if route request is EV (engine=electric)
and the station offered during trip planning became unavailable.public static final java.lang.String NOTIFICATION_EV_STATION_OCCUPIED
Notification.reason() will have this value if route request is EV (engine=electric)
and the station offered during trip planning became unavailable.public static final java.lang.String NOTIFICATION_FLOW_ALL
RouteLeg.notifications()).public static final java.lang.String NOTIFICATION_FLOW_NONE
RouteLeg.notifications()).