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

OptimizeWaypointsRequest

class OptimizeWaypointsRequest

Types

Builder

class Builder

Companion

object Companion

Properties

avoid

val 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

val clustering: WaypointOptimizationClusteringOptions?

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

departureTime

val departureTime: String?

Departure time from the waypoint.

destination

val destination: List<Double>?

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

destinationOptions

val destinationOptions: WaypointOptimizationDestinationOptions?

Destination related options.

driver

val driver: WaypointOptimizationDriverOptions?

Driver related options.

exclude

val exclude: WaypointOptimizationExclusionOptions?

Features to be strictly excluded while calculating the route.

key

val 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

val optimizeSequencingFor: WaypointOptimizationSequencingObjective?

Specifies the optimization criteria for the calculated sequence.

origin

val origin: List<Double>?

The start position for the route.

originOptions

val originOptions: WaypointOptimizationOriginOptions?

Origin related options.

traffic

val traffic: WaypointOptimizationTrafficOptions?

Traffic-related options.

travelMode

val travelMode: WaypointOptimizationTravelMode?

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

travelModeOptions

val travelModeOptions: WaypointOptimizationTravelModeOptions?

Travel mode related options for the provided travel mode.

waypoints

val waypoints: List<WaypointOptimizationWaypoint>?

List of waypoints between the Origin and Destination.

Functions

copy

inline fun copy(block: OptimizeWaypointsRequest.Builder.() -> Unit = {}): OptimizeWaypointsRequest

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String