ComputeCustomRoutes response message.
JSON representation |
---|
{ "routes": [ { object ( |
Fields | |
---|---|
routes[] |
The ‘best’ routes for the input route objective. |
fastest |
The fastest reference route. |
shortest |
The shortest reference route. |
fallback |
Fallback info for custom routes. |
CustomRoute
Encapsulates a custom route computed based on the route objective specified by the customer. CustomRoute
contains a route and a route token, which can be passed to NavSDK to reconstruct the custom route for turn by turn navigation.
JSON representation |
---|
{
"route": {
object ( |
Fields | |
---|---|
route |
The route considered 'best' for the input route objective. |
token |
Web-safe base64 encoded route token that can be passed to NavSDK, which allows NavSDK to reconstruct the route during navigation, and in the event of rerouting honor the original intention when |
FallbackInfo
Encapsulates fallback info for ComputeCustomRoutes
. ComputeCustomRoutes
performs two types of fallbacks:
If it cannot compute the route using the
routingPreference
requested by the customer, it will fallback to another routing mode. In this casefallback_routing_mode
androuting_mode_fallback_reason
are used to communicate the fallback routing mode used, as well as the reason for fallback.If it cannot compute a 'best' route for the route objective specified by the customer, it might fallback to another objective.
fallback_route_objective
is used to communicate the fallback route objective.
JSON representation |
---|
{ "routingMode": enum ( |
Fields | |
---|---|
routing |
Routing mode used for the response. If fallback was triggered, the mode may be different from routing preference set in the original client request. |
routing |
The reason why fallback response was used instead of the original response. This field is only populated when the fallback mode is triggered and the fallback response is returned. |
route |
The route objective used for the response. If fallback was triggered, the objective may be different from the route objective provided in the original client request. |