Class: Aws::GeoRoutes::Types::OptimizeWaypointsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::GeoRoutes::Types::OptimizeWaypointsRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-georoutes/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[:destination, :key, :origin]
Instance Attribute Summary collapse
-
#avoid ⇒ Types::WaypointOptimizationAvoidanceOptions
Features that are avoided while calculating a route.
-
#departure_time ⇒ String
Departure time from the waypoint.
-
#destination ⇒ Array<Float>
The final position for the route in the World Geodetic System (WGS 84) format: ‘[longitude, latitude]`.
-
#destination_options ⇒ Types::WaypointOptimizationDestinationOptions
Destination related options.
-
#driver ⇒ Types::WaypointOptimizationDriverOptions
Driver related options.
-
#exclude ⇒ Types::WaypointOptimizationExclusionOptions
Features to be strictly excluded while calculating the route.
-
#key ⇒ String
Optional: The API key to be used for authorization.
-
#optimize_sequencing_for ⇒ String
Specifies the optimization criteria for the calculated sequence.
-
#origin ⇒ Array<Float>
The start position for the route.
-
#origin_options ⇒ Types::WaypointOptimizationOriginOptions
Origin related options.
-
#traffic ⇒ Types::WaypointOptimizationTrafficOptions
Traffic-related options.
-
#travel_mode ⇒ String
Specifies the mode of transport when calculating a route.
-
#travel_mode_options ⇒ Types::WaypointOptimizationTravelModeOptions
Travel mode related options for the provided travel mode.
-
#waypoints ⇒ Array<Types::WaypointOptimizationWaypoint>
List of waypoints between the ‘Origin` and `Destination`.
Instance Attribute Details
#avoid ⇒ Types::WaypointOptimizationAvoidanceOptions
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, this setting is ignored.
1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 |
# File 'lib/aws-sdk-georoutes/types.rb', line 1549 class OptimizeWaypointsRequest < Struct.new( :avoid, :departure_time, :destination, :destination_options, :driver, :exclude, :key, :optimize_sequencing_for, :origin, :origin_options, :traffic, :travel_mode, :travel_mode_options, :waypoints) SENSITIVE = [:destination, :key, :origin] include Aws::Structure end |
#departure_time ⇒ String
Departure time from the waypoint.
Time format:‘YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm`
Examples:
‘2020-04-22T17:57:24Z`
‘2020-04-22T17:57:24+02:00`
1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 |
# File 'lib/aws-sdk-georoutes/types.rb', line 1549 class OptimizeWaypointsRequest < Struct.new( :avoid, :departure_time, :destination, :destination_options, :driver, :exclude, :key, :optimize_sequencing_for, :origin, :origin_options, :traffic, :travel_mode, :travel_mode_options, :waypoints) SENSITIVE = [:destination, :key, :origin] include Aws::Structure end |
#destination ⇒ Array<Float>
The final position for the route in the World Geodetic System (WGS 84) format: ‘[longitude, latitude]`.
1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 |
# File 'lib/aws-sdk-georoutes/types.rb', line 1549 class OptimizeWaypointsRequest < Struct.new( :avoid, :departure_time, :destination, :destination_options, :driver, :exclude, :key, :optimize_sequencing_for, :origin, :origin_options, :traffic, :travel_mode, :travel_mode_options, :waypoints) SENSITIVE = [:destination, :key, :origin] include Aws::Structure end |
#destination_options ⇒ Types::WaypointOptimizationDestinationOptions
Destination related options.
1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 |
# File 'lib/aws-sdk-georoutes/types.rb', line 1549 class OptimizeWaypointsRequest < Struct.new( :avoid, :departure_time, :destination, :destination_options, :driver, :exclude, :key, :optimize_sequencing_for, :origin, :origin_options, :traffic, :travel_mode, :travel_mode_options, :waypoints) SENSITIVE = [:destination, :key, :origin] include Aws::Structure end |
#driver ⇒ Types::WaypointOptimizationDriverOptions
Driver related options.
1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 |
# File 'lib/aws-sdk-georoutes/types.rb', line 1549 class OptimizeWaypointsRequest < Struct.new( :avoid, :departure_time, :destination, :destination_options, :driver, :exclude, :key, :optimize_sequencing_for, :origin, :origin_options, :traffic, :travel_mode, :travel_mode_options, :waypoints) SENSITIVE = [:destination, :key, :origin] include Aws::Structure end |
#exclude ⇒ Types::WaypointOptimizationExclusionOptions
Features to be strictly excluded while calculating the route.
1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 |
# File 'lib/aws-sdk-georoutes/types.rb', line 1549 class OptimizeWaypointsRequest < Struct.new( :avoid, :departure_time, :destination, :destination_options, :driver, :exclude, :key, :optimize_sequencing_for, :origin, :origin_options, :traffic, :travel_mode, :travel_mode_options, :waypoints) SENSITIVE = [:destination, :key, :origin] include Aws::Structure end |
#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.
1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 |
# File 'lib/aws-sdk-georoutes/types.rb', line 1549 class OptimizeWaypointsRequest < Struct.new( :avoid, :departure_time, :destination, :destination_options, :driver, :exclude, :key, :optimize_sequencing_for, :origin, :origin_options, :traffic, :travel_mode, :travel_mode_options, :waypoints) SENSITIVE = [:destination, :key, :origin] include Aws::Structure end |
#optimize_sequencing_for ⇒ String
Specifies the optimization criteria for the calculated sequence.
Default Value: ‘FastestRoute`.
1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 |
# File 'lib/aws-sdk-georoutes/types.rb', line 1549 class OptimizeWaypointsRequest < Struct.new( :avoid, :departure_time, :destination, :destination_options, :driver, :exclude, :key, :optimize_sequencing_for, :origin, :origin_options, :traffic, :travel_mode, :travel_mode_options, :waypoints) SENSITIVE = [:destination, :key, :origin] include Aws::Structure end |
#origin ⇒ Array<Float>
The start position for the route.
1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 |
# File 'lib/aws-sdk-georoutes/types.rb', line 1549 class OptimizeWaypointsRequest < Struct.new( :avoid, :departure_time, :destination, :destination_options, :driver, :exclude, :key, :optimize_sequencing_for, :origin, :origin_options, :traffic, :travel_mode, :travel_mode_options, :waypoints) SENSITIVE = [:destination, :key, :origin] include Aws::Structure end |
#origin_options ⇒ Types::WaypointOptimizationOriginOptions
Origin related options.
1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 |
# File 'lib/aws-sdk-georoutes/types.rb', line 1549 class OptimizeWaypointsRequest < Struct.new( :avoid, :departure_time, :destination, :destination_options, :driver, :exclude, :key, :optimize_sequencing_for, :origin, :origin_options, :traffic, :travel_mode, :travel_mode_options, :waypoints) SENSITIVE = [:destination, :key, :origin] include Aws::Structure end |
#traffic ⇒ Types::WaypointOptimizationTrafficOptions
Traffic-related options.
1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 |
# File 'lib/aws-sdk-georoutes/types.rb', line 1549 class OptimizeWaypointsRequest < Struct.new( :avoid, :departure_time, :destination, :destination_options, :driver, :exclude, :key, :optimize_sequencing_for, :origin, :origin_options, :traffic, :travel_mode, :travel_mode_options, :waypoints) SENSITIVE = [:destination, :key, :origin] include Aws::Structure end |
#travel_mode ⇒ String
Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.
Default Value: ‘Car`
1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 |
# File 'lib/aws-sdk-georoutes/types.rb', line 1549 class OptimizeWaypointsRequest < Struct.new( :avoid, :departure_time, :destination, :destination_options, :driver, :exclude, :key, :optimize_sequencing_for, :origin, :origin_options, :traffic, :travel_mode, :travel_mode_options, :waypoints) SENSITIVE = [:destination, :key, :origin] include Aws::Structure end |
#travel_mode_options ⇒ Types::WaypointOptimizationTravelModeOptions
Travel mode related options for the provided travel mode.
1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 |
# File 'lib/aws-sdk-georoutes/types.rb', line 1549 class OptimizeWaypointsRequest < Struct.new( :avoid, :departure_time, :destination, :destination_options, :driver, :exclude, :key, :optimize_sequencing_for, :origin, :origin_options, :traffic, :travel_mode, :travel_mode_options, :waypoints) SENSITIVE = [:destination, :key, :origin] include Aws::Structure end |
#waypoints ⇒ Array<Types::WaypointOptimizationWaypoint>
List of waypoints between the ‘Origin` and `Destination`.
1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 |
# File 'lib/aws-sdk-georoutes/types.rb', line 1549 class OptimizeWaypointsRequest < Struct.new( :avoid, :departure_time, :destination, :destination_options, :driver, :exclude, :key, :optimize_sequencing_for, :origin, :origin_options, :traffic, :travel_mode, :travel_mode_options, :waypoints) SENSITIVE = [:destination, :key, :origin] include Aws::Structure end |