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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb

Overview

Note:

When making an API call, you may pass CalculateRouteRequest data as a hash:

{
  calculator_name: "ResourceName", # required
  car_mode_options: {
    avoid_ferries: false,
    avoid_tolls: false,
  },
  depart_now: false,
  departure_position: [1.0], # required
  departure_time: Time.now,
  destination_position: [1.0], # required
  distance_unit: "Kilometers", # accepts Kilometers, Miles
  include_leg_geometry: false,
  travel_mode: "Car", # accepts Car, Truck, Walking
  truck_mode_options: {
    avoid_ferries: false,
    avoid_tolls: false,
    dimensions: {
      height: 1.0,
      length: 1.0,
      unit: "Meters", # accepts Meters, Feet
      width: 1.0,
    },
    weight: {
      total: 1.0,
      unit: "Kilograms", # accepts Kilograms, Pounds
    },
  },
  waypoint_positions: [
    [1.0],
  ],
}

Constant Summary collapse

SENSITIVE =
[:departure_position, :destination_position]

Instance Attribute Summary collapse

Instance Attribute Details

#calculator_nameString

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

Returns:

  • (String)


802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 802

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

#car_mode_optionsTypes::CalculateRouteCarModeOptions

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

Requirements: TravelMode must be specified as Car.



802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 802

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

#depart_nowBoolean

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)


802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 802

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

#departure_positionArray<Float>

The start position for the route. Defined in 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>)


802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 802

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

#departure_timeTime

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

Setting a departure time in the past returns a 400 ValidationException error.

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

^

Returns:

  • (Time)


802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 802

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

#destination_positionArray<Float>

The finish position for the route. Defined in 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>)


802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 802

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

#distance_unitString

Set the unit system to specify the distance.

Default Value: Kilometers

Returns:

  • (String)


802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 802

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

#include_leg_geometryBoolean

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)


802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 802

class CalculateRouteRequest < Struct.new(
  :calculator_name,
  :car_mode_options,
  :depart_now,
  :departure_position,
  :departure_time,
  :destination_position,
  :distance_unit,
  :include_leg_geometry,
  :travel_mode,
  :truck_mode_options,
  :waypoint_positions)
  SENSITIVE = [:departure_position, :destination_position]
  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.

The TravelMode you specify 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)


802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 802

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

#truck_mode_optionsTypes::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.



802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 802

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

#waypoint_positionsArray<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>>)


802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 802

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