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

Builder

Properties

Features that are allowed while calculating a route. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

arrivalTime

var arrivalTime: String?

Time of arrival at the destination. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

avoid

var avoid: RouteAvoidanceOptions?

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 ControlledAccessHighways, Ferries, and TollRoads

departNow

var departNow: Boolean?

Uses the current time as the time of departure.

departureTime

var departureTime: String?

Time of departure from the origin.

destination

var destination: List<Double>?

The final position for the route. In the World Geodetic System (WGS 84) format: [longitude, latitude].

destinationOptions

var destinationOptions: RouteDestinationOptions?

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

driver

var driver: RouteDriverOptions?

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

exclude

var exclude: RouteExclusionOptions?

Features to be strictly excluded while calculating the route. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

instructionsMeasurementSystem

var instructionsMeasurementSystem: MeasurementSystem?

Measurement system to be used for instructions within steps in the response.

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.

languages

var languages: List<String>?

List of languages for instructions within steps in the response. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

legAdditionalFeatures

var legAdditionalFeatures: List<RouteLegAdditionalFeature>?

A list of optional additional parameters such as timezone that can be requested for each result. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only PassThroughWaypoints, Summary, and TravelStepInstructions

legGeometryFormat

var legGeometryFormat: GeometryFormat?

Specifies the format of the geometry returned for each leg of the route. You can choose between two different geometry encoding formats.

maxAlternatives

var maxAlternatives: Int?

Maximum number of alternative routes to be provided in the response, if available. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only up to 3 alternative routes.

optimizeRoutingFor

var optimizeRoutingFor: RoutingObjective?

Controls the trade-off between achieving the shortest travel time (FastestRoute) and achieving the shortest physical distance ((ShortestRoute) when calculating each route in the matrix.

origin

var origin: List<Double>?

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

originOptions

var originOptions: RouteOriginOptions?

Specifies how the origin point should be matched to the road network and any routing constraints that apply when the traveler is departing the origin. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

spanAdditionalFeatures

var spanAdditionalFeatures: List<RouteSpanAdditionalFeature>?

A list of optional features such as SpeedLimit that can be requested for a Span. A span is a section of a Leg for which the requested features have the same values. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

tolls

var tolls: RouteTollOptions?

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

traffic

var traffic: RouteTrafficOptions?

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

travelMode

var travelMode: RouteTravelMode?

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 values.

travelModeOptions

var travelModeOptions: RouteTravelModeOptions?

Travel mode related options for the provided travel mode. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only Car and Pedestrian travel mode options.

travelStepType

var travelStepType: RouteTravelStepType?

Type of step returned by the response. Default provides basic steps intended for web based applications. TurnByTurn provides detailed instructions with more granularity intended for a turn based navigation system. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions Default does not return any steps.