Class: Aws::LocationService::Types::CalculateRouteRequest

Inherits:

Struct

• Object
• Struct
• Aws::LocationService::Types::CalculateRouteRequest

Defined in:

gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:departure_position, :destination_position, :key]

Instance Attribute Summary

• #arrival_time ⇒ Time

  Specifies the desired time of arrival.

• #calculator_name ⇒ String

  The name of the route calculator resource that you want to use to calculate the route.

• #car_mode_options ⇒ Types::CalculateRouteCarModeOptions

  Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls.

• #depart_now ⇒ Boolean

  Sets the time of departure as the current time.

• #departure_position ⇒ Array<Float>

  The start position for the route.

• #departure_time ⇒ Time

  Specifies the desired time of departure.

• #destination_position ⇒ Array<Float>

  The finish position for the route.

• #distance_unit ⇒ String

  Set the unit system to specify the distance.

• #include_leg_geometry ⇒ Boolean

  Set to include the geometry details in the result for each path between a pair of positions.

• #key ⇒ String

  The optional [API key][1] to authorize the request.

• #optimize_for ⇒ String

  Specifies the distance to optimize for when calculating a route.

• #travel_mode ⇒ String

  Specifies the mode of transport when calculating a route.

• #truck_mode_options ⇒ Types::CalculateRouteTruckModeOptions

  Specifies route preferences when traveling by Truck, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.

• #waypoint_positions ⇒ Array<Array<Float>>

  Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.

Instance Attribute Details

#arrival_time ⇒ Time

Specifies the desired time of arrival. Uses the given time to calculate the route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

ArrivalTime is not supported Esri.

Returns:

• (Time)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 1080

class CalculateRouteRequest < Struct.new(
  :arrival_time,
  :calculator_name,
  :car_mode_options,
  :depart_now,
  :departure_position,
  :departure_time,
  :destination_position,
  :distance_unit,
  :include_leg_geometry,
  :key,
  :optimize_for,
  :travel_mode,
  :truck_mode_options,
  :waypoint_positions)
  SENSITIVE = [:departure_position, :destination_position, :key]
  include Aws::Structure
end

#calculator_name ⇒ String

The name of the route calculator resource that you want to use to calculate the route.

Returns:

• (String)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 1080

class CalculateRouteRequest < Struct.new(
  :arrival_time,
  :calculator_name,
  :car_mode_options,
  :depart_now,
  :departure_position,
  :departure_time,
  :destination_position,
  :distance_unit,
  :include_leg_geometry,
  :key,
  :optimize_for,
  :travel_mode,
  :truck_mode_options,
  :waypoint_positions)
  SENSITIVE = [:departure_position, :destination_position, :key]
  include Aws::Structure
end

#car_mode_options ⇒ Types::CalculateRouteCarModeOptions

Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls.

Requirements: TravelMode must be specified as Car.

Returns:

• (Types::CalculateRouteCarModeOptions)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 1080

class CalculateRouteRequest < Struct.new(
  :arrival_time,
  :calculator_name,
  :car_mode_options,
  :depart_now,
  :departure_position,
  :departure_time,
  :destination_position,
  :distance_unit,
  :include_leg_geometry,
  :key,
  :optimize_for,
  :travel_mode,
  :truck_mode_options,
  :waypoint_positions)
  SENSITIVE = [:departure_position, :destination_position, :key]
  include Aws::Structure
end

#depart_now ⇒ Boolean

Sets the time of departure as the current time. Uses the current time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

Default Value: false

Valid Values: false | true

Returns:

• (Boolean)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 1080

class CalculateRouteRequest < Struct.new(
  :arrival_time,
  :calculator_name,
  :car_mode_options,
  :depart_now,
  :departure_position,
  :departure_time,
  :destination_position,
  :distance_unit,
  :include_leg_geometry,
  :key,
  :optimize_for,
  :travel_mode,
  :truck_mode_options,
  :waypoint_positions)
  SENSITIVE = [:departure_position, :destination_position, :key]
  include Aws::Structure
end

#departure_position ⇒ Array<Float>

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

• For example, [-123.115, 49.285]

^

If you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.

Valid Values: [-180 to 180,-90 to 90]

Returns:

• (Array<Float>)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 1080

class CalculateRouteRequest < Struct.new(
  :arrival_time,
  :calculator_name,
  :car_mode_options,
  :depart_now,
  :departure_position,
  :departure_time,
  :destination_position,
  :distance_unit,
  :include_leg_geometry,
  :key,
  :optimize_for,
  :travel_mode,
  :truck_mode_options,
  :waypoint_positions)
  SENSITIVE = [:departure_position, :destination_position, :key]
  include Aws::Structure
end

#departure_time ⇒ Time

Specifies the desired time of departure. Uses the given time to calculate the route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

• In ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00

^

Returns:

• (Time)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 1080

class CalculateRouteRequest < Struct.new(
  :arrival_time,
  :calculator_name,
  :car_mode_options,
  :depart_now,
  :departure_position,
  :departure_time,
  :destination_position,
  :distance_unit,
  :include_leg_geometry,
  :key,
  :optimize_for,
  :travel_mode,
  :truck_mode_options,
  :waypoint_positions)
  SENSITIVE = [:departure_position, :destination_position, :key]
  include Aws::Structure
end

#destination_position ⇒ Array<Float>

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

• For example, [-122.339, 47.615]

^

If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road.

Valid Values: [-180 to 180,-90 to 90]

Returns:

• (Array<Float>)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 1080

class CalculateRouteRequest < Struct.new(
  :arrival_time,
  :calculator_name,
  :car_mode_options,
  :depart_now,
  :departure_position,
  :departure_time,
  :destination_position,
  :distance_unit,
  :include_leg_geometry,
  :key,
  :optimize_for,
  :travel_mode,
  :truck_mode_options,
  :waypoint_positions)
  SENSITIVE = [:departure_position, :destination_position, :key]
  include Aws::Structure
end

#distance_unit ⇒ String

Set the unit system to specify the distance.

Default Value: Kilometers

Returns:

• (String)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 1080

class CalculateRouteRequest < Struct.new(
  :arrival_time,
  :calculator_name,
  :car_mode_options,
  :depart_now,
  :departure_position,
  :departure_time,
  :destination_position,
  :distance_unit,
  :include_leg_geometry,
  :key,
  :optimize_for,
  :travel_mode,
  :truck_mode_options,
  :waypoint_positions)
  SENSITIVE = [:departure_position, :destination_position, :key]
  include Aws::Structure
end

#include_leg_geometry ⇒ Boolean

Set to include the geometry details in the result for each path between a pair of positions.

Default Value: false

Valid Values: false | true

Returns:

• (Boolean)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 1080

class CalculateRouteRequest < Struct.new(
  :arrival_time,
  :calculator_name,
  :car_mode_options,
  :depart_now,
  :departure_position,
  :departure_time,
  :destination_position,
  :distance_unit,
  :include_leg_geometry,
  :key,
  :optimize_for,
  :travel_mode,
  :truck_mode_options,
  :waypoint_positions)
  SENSITIVE = [:departure_position, :destination_position, :key]
  include Aws::Structure
end

#key ⇒ String

The optional API key to authorize the request.

Returns:

• (String)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 1080

class CalculateRouteRequest < Struct.new(
  :arrival_time,
  :calculator_name,
  :car_mode_options,
  :depart_now,
  :departure_position,
  :departure_time,
  :destination_position,
  :distance_unit,
  :include_leg_geometry,
  :key,
  :optimize_for,
  :travel_mode,
  :truck_mode_options,
  :waypoint_positions)
  SENSITIVE = [:departure_position, :destination_position, :key]
  include Aws::Structure
end

#optimize_for ⇒ String

Specifies the distance to optimize for when calculating a route.

Returns:

• (String)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 1080

class CalculateRouteRequest < Struct.new(
  :arrival_time,
  :calculator_name,
  :car_mode_options,
  :depart_now,
  :departure_position,
  :departure_time,
  :destination_position,
  :distance_unit,
  :include_leg_geometry,
  :key,
  :optimize_for,
  :travel_mode,
  :truck_mode_options,
  :waypoint_positions)
  SENSITIVE = [:departure_position, :destination_position, :key]
  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. You can choose Car, Truck, Walking, Bicycle or Motorcycle as options for the TravelMode.

Bicycle and Motorcycle are only valid when using Grab as a data provider, and only within Southeast Asia.

Truck is not available for Grab.

For more details on the using Grab for routing, including areas of coverage, see GrabMaps in the Amazon Location Service Developer Guide.

The TravelMode you specify also determines how you specify route preferences:

• If traveling by Car use the CarModeOptions parameter.

• If traveling by Truck use the TruckModeOptions parameter.

Default Value: Car

Returns:

• (String)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 1080

class CalculateRouteRequest < Struct.new(
  :arrival_time,
  :calculator_name,
  :car_mode_options,
  :depart_now,
  :departure_position,
  :departure_time,
  :destination_position,
  :distance_unit,
  :include_leg_geometry,
  :key,
  :optimize_for,
  :travel_mode,
  :truck_mode_options,
  :waypoint_positions)
  SENSITIVE = [:departure_position, :destination_position, :key]
  include Aws::Structure
end

#truck_mode_options ⇒ Types::CalculateRouteTruckModeOptions

Specifies route preferences when traveling by Truck, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.

Requirements: TravelMode must be specified as Truck.

Returns:

• (Types::CalculateRouteTruckModeOptions)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 1080

class CalculateRouteRequest < Struct.new(
  :arrival_time,
  :calculator_name,
  :car_mode_options,
  :depart_now,
  :departure_position,
  :departure_time,
  :destination_position,
  :distance_unit,
  :include_leg_geometry,
  :key,
  :optimize_for,
  :travel_mode,
  :truck_mode_options,
  :waypoint_positions)
  SENSITIVE = [:departure_position, :destination_position, :key]
  include Aws::Structure
end

#waypoint_positions ⇒ Array<Array<Float>>

Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.

• For example, from the DeparturePosition [-123.115, 49.285], the route follows the order that the waypoint positions are given [[-122.757, 49.0021],[-122.349, 47.620]]

^

If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road.

Specifying more than 23 waypoints returns a 400 ValidationException error.

If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.

Valid Values: [-180 to 180,-90 to 90]

Returns:

• (Array<Array<Float>>)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 1080

class CalculateRouteRequest < Struct.new(
  :arrival_time,
  :calculator_name,
  :car_mode_options,
  :depart_now,
  :departure_position,
  :departure_time,
  :destination_position,
  :distance_unit,
  :include_leg_geometry,
  :key,
  :optimize_for,
  :travel_mode,
  :truck_mode_options,
  :waypoint_positions)
  SENSITIVE = [:departure_position, :destination_position, :key]
  include Aws::Structure
end