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

Builder

class Builder

Properties

allow

var allow: RouteAllowOptions?

Features that are allowed while calculating a route.

arrivalTime

var arrivalTime: String?

Time of arrival at the destination.

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.

departNow

var departNow: Boolean?

Uses the current time as the time of departure.

departureTime

var departureTime: String?

Time of departure from thr 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.

driver

var driver: RouteDriverOptions?

Driver related options.

exclude

var exclude: RouteExclusionOptions?

Features to be strictly excluded while calculating the route.

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.

legAdditionalFeatures

var legAdditionalFeatures: List<RouteLegAdditionalFeature>?

A list of optional additional parameters such as timezone that can be requested for each result.

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.

optimizeRoutingFor

var optimizeRoutingFor: RoutingObjective?

Specifies the optimization criteria for calculating a route.

origin

var origin: List<Double>?

The start position for the route.

originOptions

var originOptions: RouteOriginOptions?

Origin related options.

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.

tolls

var tolls: RouteTollOptions?

Toll related options.

traffic

var traffic: RouteTrafficOptions?

Traffic related options.

travelMode

var travelMode: RouteTravelMode?

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

travelModeOptions

var travelModeOptions: RouteTravelModeOptions?

Travel mode related options for the provided travel mode.

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.

waypoints

var waypoints: List<RouteWaypoint>?

List of waypoints between the Origin and Destination.