Module Values.RouteAvoidanceOptionsSource

Specifies options for areas to avoid when calculating the route. This is a best-effort avoidance setting, meaning the router will try to honor the avoidance preferences but may still include restricted areas if no feasible alternative route exists. If avoidance options are not followed, the response will indicate that the avoidance criteria were violated.

Sourcetype nonrec t = {
  1. areas : RouteAvoidanceAreaList.t option;
    (*

    Areas to be avoided. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

    *)
  2. carShuttleTrains : SensitiveBoolean.t option;
    (*

    Avoid car-shuttle-trains while calculating the route. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

    *)
  3. controlledAccessHighways : SensitiveBoolean.t option;
    (*

    Avoid controlled access highways while calculating the route.

    *)
  4. dirtRoads : SensitiveBoolean.t option;
    (*

    Avoid dirt roads while calculating the route. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

    *)
  5. ferries : SensitiveBoolean.t option;
    (*

    Avoid ferries while calculating the route.

    *)
  6. seasonalClosure : SensitiveBoolean.t option;
    (*

    Avoid roads that have seasonal closure while calculating the route. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

    *)
  7. tollRoads : SensitiveBoolean.t option;
    (*

    Avoids roads where the specified toll transponders are the only mode of payment.

    *)
  8. tollTransponders : SensitiveBoolean.t option;
    (*

    Avoids roads where the specified toll transponders are the only mode of payment. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

    *)
  9. truckRoadTypes : TruckRoadTypeList.t option;
    (*

    Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers. There are currently no other supported values as of 26th April 2024.

    *)
  10. tunnels : SensitiveBoolean.t option;
    (*

    Avoid tunnels while calculating the route. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

    *)
  11. uTurns : SensitiveBoolean.t option;
    (*

    Avoid U-turns for calculation on highways and motorways. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

    *)
  12. zoneCategories : RouteAvoidanceZoneCategoryList.t option;
    (*

    Zone categories to be avoided. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

    *)
}
Sourceval make : ?areas:??? -> ?carShuttleTrains:??? -> ?controlledAccessHighways:??? -> ?dirtRoads:??? -> ?ferries:??? -> ?seasonalClosure:??? -> ?tollRoads:??? -> ?tollTransponders:??? -> ?truckRoadTypes:??? -> ?tunnels:??? -> ?uTurns:??? -> ?zoneCategories:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of SensitiveBoolean.t | `List of [> `String of TruckRoadType.t | `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `List of [> `Double of Double.t | `List of [> `List of [> `Double of Double.t ] list ] list | `String of PolylineRing.t ] list | `Structure of (string * [> `Integer of Integer.t | `List of [> `List of [> `Double of Double.t ] list ] list | `String of Polyline.t ]) list ]) list ] list | `Structure of (string * [> `List of [> `Double of Double.t | `List of [> `List of [> `Double of Double.t ] list ] list | `String of PolylineRing.t ] list | `Structure of (string * [> `Integer of Integer.t | `List of [> `List of [> `Double of Double.t ] list ] list | `String of Polyline.t ]) list ]) list ]) list ] list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t