Class: Aws::LocationService::Types::CalculateRouteTruckModeOptions

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 CalculateRouteTruckModeOptions data as a hash:

{
  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
  },
}

Contains details about additional route preferences for requests that specify TravelMode as Truck.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#avoid_ferriesBoolean

Avoids ferries when calculating routes.

Default Value: false

Valid Values: false | true

Returns:

  • (Boolean)


988
989
990
991
992
993
994
995
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 988

class CalculateRouteTruckModeOptions < Struct.new(
  :avoid_ferries,
  :avoid_tolls,
  :dimensions,
  :weight)
  SENSITIVE = []
  include Aws::Structure
end

#avoid_tollsBoolean

Avoids ferries when calculating routes.

Default Value: false

Valid Values: false | true

Returns:

  • (Boolean)


988
989
990
991
992
993
994
995
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 988

class CalculateRouteTruckModeOptions < Struct.new(
  :avoid_ferries,
  :avoid_tolls,
  :dimensions,
  :weight)
  SENSITIVE = []
  include Aws::Structure
end

#dimensionsTypes::TruckDimensions

Specifies the truck's dimension specifications including length, height, width, and unit of measurement. Used to avoid roads that can't support the truck's dimensions.



988
989
990
991
992
993
994
995
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 988

class CalculateRouteTruckModeOptions < Struct.new(
  :avoid_ferries,
  :avoid_tolls,
  :dimensions,
  :weight)
  SENSITIVE = []
  include Aws::Structure
end

#weightTypes::TruckWeight

Specifies the truck's weight specifications including total weight and unit of measurement. Used to avoid roads that can't support the truck's weight.

Returns:



988
989
990
991
992
993
994
995
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 988

class CalculateRouteTruckModeOptions < Struct.new(
  :avoid_ferries,
  :avoid_tolls,
  :dimensions,
  :weight)
  SENSITIVE = []
  include Aws::Structure
end