Class: Aws::GeoRoutes::Types::RouteAvoidanceOptions

Inherits:

Struct

• Object
• Struct
• Aws::GeoRoutes::Types::RouteAvoidanceOptions

Defined in:

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

Overview

Specifies options for areas to avoid when calculating the route. This is a best-effort avoidance setting, meaning the router will try to honor the avoidance preferences but may still include restricted areas if no feasible alternative route exists. If avoidance options are not followed, the response will indicate that the avoidance criteria were violated.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #areas ⇒ Array<Types::RouteAvoidanceArea>

  Areas to be avoided.

• #car_shuttle_trains ⇒ Boolean

  Avoid car-shuttle-trains while calculating the route.

• #controlled_access_highways ⇒ Boolean

  Avoid controlled access highways while calculating the route.

• #dirt_roads ⇒ Boolean

  Avoid dirt roads while calculating the route.

• #ferries ⇒ Boolean

  Avoid ferries while calculating the route.

• #seasonal_closure ⇒ Boolean

  Avoid roads that have seasonal closure while calculating the route.

• #toll_roads ⇒ Boolean

  Avoids roads where the specified toll transponders are the only mode of payment.

• #toll_transponders ⇒ Boolean

  Avoids roads where the specified toll transponders are the only mode of payment.

• #truck_road_types ⇒ Array<String>

  Truck road type identifiers.

• #tunnels ⇒ Boolean

  Avoid tunnels while calculating the route.

• #u_turns ⇒ Boolean

  Avoid U-turns for calculation on highways and motorways.

• #zone_categories ⇒ Array<Types::RouteAvoidanceZoneCategory>

  Zone categories to be avoided.

Instance Attribute Details

#areas ⇒ Array<Types::RouteAvoidanceArea>

Areas to be avoided.

Returns:

• (Array<Types::RouteAvoidanceArea>)

# File 'gems/aws-sdk-georoutes/lib/aws-sdk-georoutes/types.rb', line 2092

class RouteAvoidanceOptions < Struct.new(
  :areas,
  :car_shuttle_trains,
  :controlled_access_highways,
  :dirt_roads,
  :ferries,
  :seasonal_closure,
  :toll_roads,
  :toll_transponders,
  :truck_road_types,
  :tunnels,
  :u_turns,
  :zone_categories)
  SENSITIVE = []
  include Aws::Structure
end

#car_shuttle_trains ⇒ Boolean

Avoid car-shuttle-trains while calculating the route.

Returns:

• (Boolean)

# File 'gems/aws-sdk-georoutes/lib/aws-sdk-georoutes/types.rb', line 2092

class RouteAvoidanceOptions < Struct.new(
  :areas,
  :car_shuttle_trains,
  :controlled_access_highways,
  :dirt_roads,
  :ferries,
  :seasonal_closure,
  :toll_roads,
  :toll_transponders,
  :truck_road_types,
  :tunnels,
  :u_turns,
  :zone_categories)
  SENSITIVE = []
  include Aws::Structure
end

#controlled_access_highways ⇒ Boolean

Avoid controlled access highways while calculating the route.

Returns:

• (Boolean)

# File 'gems/aws-sdk-georoutes/lib/aws-sdk-georoutes/types.rb', line 2092

class RouteAvoidanceOptions < Struct.new(
  :areas,
  :car_shuttle_trains,
  :controlled_access_highways,
  :dirt_roads,
  :ferries,
  :seasonal_closure,
  :toll_roads,
  :toll_transponders,
  :truck_road_types,
  :tunnels,
  :u_turns,
  :zone_categories)
  SENSITIVE = []
  include Aws::Structure
end

#dirt_roads ⇒ Boolean

Avoid dirt roads while calculating the route.

Returns:

• (Boolean)

# File 'gems/aws-sdk-georoutes/lib/aws-sdk-georoutes/types.rb', line 2092

class RouteAvoidanceOptions < Struct.new(
  :areas,
  :car_shuttle_trains,
  :controlled_access_highways,
  :dirt_roads,
  :ferries,
  :seasonal_closure,
  :toll_roads,
  :toll_transponders,
  :truck_road_types,
  :tunnels,
  :u_turns,
  :zone_categories)
  SENSITIVE = []
  include Aws::Structure
end

#ferries ⇒ Boolean

Avoid ferries while calculating the route.

Returns:

• (Boolean)

# File 'gems/aws-sdk-georoutes/lib/aws-sdk-georoutes/types.rb', line 2092

class RouteAvoidanceOptions < Struct.new(
  :areas,
  :car_shuttle_trains,
  :controlled_access_highways,
  :dirt_roads,
  :ferries,
  :seasonal_closure,
  :toll_roads,
  :toll_transponders,
  :truck_road_types,
  :tunnels,
  :u_turns,
  :zone_categories)
  SENSITIVE = []
  include Aws::Structure
end

#seasonal_closure ⇒ Boolean

Avoid roads that have seasonal closure while calculating the route.

Returns:

• (Boolean)

# File 'gems/aws-sdk-georoutes/lib/aws-sdk-georoutes/types.rb', line 2092

class RouteAvoidanceOptions < Struct.new(
  :areas,
  :car_shuttle_trains,
  :controlled_access_highways,
  :dirt_roads,
  :ferries,
  :seasonal_closure,
  :toll_roads,
  :toll_transponders,
  :truck_road_types,
  :tunnels,
  :u_turns,
  :zone_categories)
  SENSITIVE = []
  include Aws::Structure
end

#toll_roads ⇒ Boolean

Avoids roads where the specified toll transponders are the only mode of payment.

Returns:

• (Boolean)

# File 'gems/aws-sdk-georoutes/lib/aws-sdk-georoutes/types.rb', line 2092

class RouteAvoidanceOptions < Struct.new(
  :areas,
  :car_shuttle_trains,
  :controlled_access_highways,
  :dirt_roads,
  :ferries,
  :seasonal_closure,
  :toll_roads,
  :toll_transponders,
  :truck_road_types,
  :tunnels,
  :u_turns,
  :zone_categories)
  SENSITIVE = []
  include Aws::Structure
end

#toll_transponders ⇒ Boolean

Avoids roads where the specified toll transponders are the only mode of payment.

Returns:

• (Boolean)

# File 'gems/aws-sdk-georoutes/lib/aws-sdk-georoutes/types.rb', line 2092

class RouteAvoidanceOptions < Struct.new(
  :areas,
  :car_shuttle_trains,
  :controlled_access_highways,
  :dirt_roads,
  :ferries,
  :seasonal_closure,
  :toll_roads,
  :toll_transponders,
  :truck_road_types,
  :tunnels,
  :u_turns,
  :zone_categories)
  SENSITIVE = []
  include Aws::Structure
end

#truck_road_types ⇒ Array<String>

Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.

There are currently no other supported values as of 26th April 2024.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-georoutes/lib/aws-sdk-georoutes/types.rb', line 2092

class RouteAvoidanceOptions < Struct.new(
  :areas,
  :car_shuttle_trains,
  :controlled_access_highways,
  :dirt_roads,
  :ferries,
  :seasonal_closure,
  :toll_roads,
  :toll_transponders,
  :truck_road_types,
  :tunnels,
  :u_turns,
  :zone_categories)
  SENSITIVE = []
  include Aws::Structure
end

#tunnels ⇒ Boolean

Avoid tunnels while calculating the route.

Returns:

• (Boolean)

# File 'gems/aws-sdk-georoutes/lib/aws-sdk-georoutes/types.rb', line 2092

class RouteAvoidanceOptions < Struct.new(
  :areas,
  :car_shuttle_trains,
  :controlled_access_highways,
  :dirt_roads,
  :ferries,
  :seasonal_closure,
  :toll_roads,
  :toll_transponders,
  :truck_road_types,
  :tunnels,
  :u_turns,
  :zone_categories)
  SENSITIVE = []
  include Aws::Structure
end

#u_turns ⇒ Boolean

Avoid U-turns for calculation on highways and motorways.

Returns:

• (Boolean)

# File 'gems/aws-sdk-georoutes/lib/aws-sdk-georoutes/types.rb', line 2092

class RouteAvoidanceOptions < Struct.new(
  :areas,
  :car_shuttle_trains,
  :controlled_access_highways,
  :dirt_roads,
  :ferries,
  :seasonal_closure,
  :toll_roads,
  :toll_transponders,
  :truck_road_types,
  :tunnels,
  :u_turns,
  :zone_categories)
  SENSITIVE = []
  include Aws::Structure
end

#zone_categories ⇒ Array<Types::RouteAvoidanceZoneCategory>

Zone categories to be avoided.

Returns:

• (Array<Types::RouteAvoidanceZoneCategory>)

# File 'gems/aws-sdk-georoutes/lib/aws-sdk-georoutes/types.rb', line 2092

class RouteAvoidanceOptions < Struct.new(
  :areas,
  :car_shuttle_trains,
  :controlled_access_highways,
  :dirt_roads,
  :ferries,
  :seasonal_closure,
  :toll_roads,
  :toll_transponders,
  :truck_road_types,
  :tunnels,
  :u_turns,
  :zone_categories)
  SENSITIVE = []
  include Aws::Structure
end