georoutes/aws.sdk.kotlin.services.georoutes.model/CalculateRouteMatrixRequest/Builder

Builder

Properties

Features that are allowed while calculating a route.

Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation.

departNow

var departNow: Boolean?

Uses the current time as the time of departure.

departureTime

var departureTime: String?

Time of departure from thr origin.

destinations

var destinations: List<RouteMatrixDestination>?

List of destinations for the route.

exclude

var exclude: RouteMatrixExclusionOptions?

Features to be strictly excluded while calculating the route.

key

var key: String?

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

optimizeRoutingFor

var optimizeRoutingFor: RoutingObjective?

Specifies the optimization criteria for calculating a route.

origins

var origins: List<RouteMatrixOrigin>?

The position in longitude and latitude for the origin.

routingBoundary

var routingBoundary: RouteMatrixBoundary?

Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid.

traffic

var traffic: RouteMatrixTrafficOptions?

Traffic related options.

travelMode

var travelMode: RouteMatrixTravelMode?

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

travelModeOptions

var travelModeOptions: RouteMatrixTravelModeOptions?

Travel mode related options for the provided travel mode.

Functions

allow

fun allow(block: RouteMatrixAllowOptions.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.georoutes.model.RouteMatrixAllowOptions inside the given block

avoid

fun avoid(block: RouteMatrixAvoidanceOptions.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.georoutes.model.RouteMatrixAvoidanceOptions inside the given block

exclude

fun exclude(block: RouteMatrixExclusionOptions.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.georoutes.model.RouteMatrixExclusionOptions inside the given block

routingBoundary

fun routingBoundary(block: RouteMatrixBoundary.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.georoutes.model.RouteMatrixBoundary inside the given block

traffic

fun traffic(block: RouteMatrixTrafficOptions.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.georoutes.model.RouteMatrixTrafficOptions inside the given block

travelModeOptions

fun travelModeOptions(block: RouteMatrixTravelModeOptions.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.georoutes.model.RouteMatrixTravelModeOptions inside the given block