georoutes/aws.sdk.kotlin.services.georoutes.model/RouteAvoidanceOptions

RouteAvoidanceOptions

class RouteAvoidanceOptions

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.

Types

object Companion

Properties

val areas: List<RouteAvoidanceArea>?

Areas to be avoided.

carShuttleTrains

val carShuttleTrains: Boolean?

Avoid car-shuttle-trains while calculating the route.

controlledAccessHighways

val controlledAccessHighways: Boolean?

Avoid controlled access highways while calculating the route.

val dirtRoads: Boolean?

Avoid dirt roads while calculating the route.

val ferries: Boolean?

Avoid ferries while calculating the route.

seasonalClosure

val seasonalClosure: Boolean?

Avoid roads that have seasonal closure while calculating the route.

val tollRoads: Boolean?

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

tollTransponders

val tollTransponders: Boolean?

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

val truckRoadTypes: List<String>?

Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.

val tunnels: Boolean?

Avoid tunnels while calculating the route.

val uTurns: Boolean?

Avoid U-turns for calculation on highways and motorways.

val zoneCategories: List<RouteAvoidanceZoneCategory>?

Zone categories to be avoided.

Functions

inline fun copy(block: RouteAvoidanceOptions.Builder.() -> Unit = {}): RouteAvoidanceOptions

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String