Class: Aws::GeoRoutes::Types::OptimizeWaypointsRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-georoutes/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[:destination, :key, :origin]

Instance Attribute Summary collapse

Instance Attribute Details

#avoidTypes::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_timeString

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`

Returns:

  • (String)


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

#destinationArray<Float>

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

Returns:

  • (Array<Float>)


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_optionsTypes::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

#driverTypes::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

#excludeTypes::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

#keyString

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

Returns:

  • (String)


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_forString

Specifies the optimization criteria for the calculated sequence.

Default Value: ‘FastestRoute`.

Returns:

  • (String)


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

#originArray<Float>

The start position for the route.

Returns:

  • (Array<Float>)


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_optionsTypes::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

#trafficTypes::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_modeString

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

Default Value: ‘Car`

Returns:

  • (String)


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_optionsTypes::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

#waypointsArray<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