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

Builder

Properties

var avoid: WaypointOptimizationAvoidanceOptions?

Features that are avoided. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, this setting is ignored.

clustering

var clustering: WaypointOptimizationClusteringOptions?

Clustering allows you to specify how nearby waypoints can be clustered to improve the optimized sequence.

departureTime

var departureTime: String?

Departure time from the waypoint.

destination

var destination: List<Double>?

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

destinationOptions

var destinationOptions: WaypointOptimizationDestinationOptions?

Destination related options.

driver

var driver: WaypointOptimizationDriverOptions?

Driver related options.

exclude

var exclude: WaypointOptimizationExclusionOptions?

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.

optimizeSequencingFor

var optimizeSequencingFor: WaypointOptimizationSequencingObjective?

Specifies the optimization criteria for the calculated sequence.

origin

var origin: List<Double>?

The start position for the route.

originOptions

var originOptions: WaypointOptimizationOriginOptions?

Origin related options.

traffic

var traffic: WaypointOptimizationTrafficOptions?

Traffic-related options.

travelMode

var travelMode: WaypointOptimizationTravelMode?

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

travelModeOptions

var travelModeOptions: WaypointOptimizationTravelModeOptions?

Travel mode related options for the provided travel mode.

waypoints

var waypoints: List<WaypointOptimizationWaypoint>?

List of waypoints between the Origin and Destination.

Functions

avoid

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

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

clustering

fun clustering(block: WaypointOptimizationClusteringOptions.Builder.() -> Unit)

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

destinationOptions

fun destinationOptions(block: WaypointOptimizationDestinationOptions.Builder.() -> Unit)

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

driver

fun driver(block: WaypointOptimizationDriverOptions.Builder.() -> Unit)

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

exclude

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

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

originOptions

fun originOptions(block: WaypointOptimizationOriginOptions.Builder.() -> Unit)

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

traffic

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

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

travelModeOptions

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

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