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. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only TollRoads, Ferries, and ControlledAccessHighways.

departNow

var departNow: Boolean?

Uses the current time as the time of departure.

departureTime

var departureTime: String?

Time of departure from the 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. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

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?

Controls the trade-off between finding the shortest travel time (FastestRoute) and the shortest distance (ShortestRoute) when calculating reachable areas.

origins

var origins: List<RouteMatrixOrigin>?

The position for the origin in World Geodetic System (WGS 84) format: [longitude, latitude].

routingBoundary

var routingBoundary: RouteMatrixBoundary?

Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only Unbounded set to true.

traffic

var traffic: RouteMatrixTrafficOptions?

Traffic related options. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

travelMode

var travelMode: RouteMatrixTravelMode?

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only Car, Pedestrian, and Scooter.