Class: Aws::GeoRoutes::Types::RouteMatrixAvoidanceOptions

Inherits:
Struct
  • Object
show all
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:

Constant Summary collapse

SENSITIVE = 
[:car_shuttle_trains, :controlled_access_highways, :dirt_roads, :ferries, :toll_roads, :toll_transponders, :truck_road_types, :tunnels, :u_turns]

Instance Attribute Summary collapse

Instance Attribute Details

#areas ⇒ Array<Types::RouteMatrixAvoidanceArea>

Areas to be avoided.

Returns:



3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
 
# File 'gems/aws-sdk-georoutes/lib/aws-sdk-georoutes/types.rb', line 3615

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

#car_shuttle_trains ⇒ Boolean

Avoid car-shuttle-trains while calculating the route.

Returns:

  • (Boolean) 


3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
 
# File 'gems/aws-sdk-georoutes/lib/aws-sdk-georoutes/types.rb', line 3615

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

#controlled_access_highways ⇒ Boolean

Avoid controlled access highways while calculating the route.

Returns:

  • (Boolean) 


3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
 
# File 'gems/aws-sdk-georoutes/lib/aws-sdk-georoutes/types.rb', line 3615

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

#dirt_roads ⇒ Boolean

Avoid dirt roads while calculating the route.

Returns:

  • (Boolean) 


3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
 
# File 'gems/aws-sdk-georoutes/lib/aws-sdk-georoutes/types.rb', line 3615

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

#ferries ⇒ Boolean

Avoid ferries while calculating the route.

Returns:

  • (Boolean) 


3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
 
# File 'gems/aws-sdk-georoutes/lib/aws-sdk-georoutes/types.rb', line 3615

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

#toll_roads ⇒ Boolean

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

Returns:

  • (Boolean) 


3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
 
# File 'gems/aws-sdk-georoutes/lib/aws-sdk-georoutes/types.rb', line 3615

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

#toll_transponders ⇒ Boolean

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

Returns:

  • (Boolean) 


3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
 
# File 'gems/aws-sdk-georoutes/lib/aws-sdk-georoutes/types.rb', line 3615

class RouteMatrixAvoidanceOptions < Struct.new(
  :areas,
  :car_shuttle_trains,
  :controlled_access_highways,
  :dirt_roads,
  :ferries,
  :toll_roads,
  :toll_transponders,
  :truck_road_types,
  :tunnels,
  :u_turns,
  :zone_categories)
  SENSITIVE = [:car_shuttle_trains, :controlled_access_highways, :dirt_roads, :ferries, :toll_roads, :toll_transponders, :truck_road_types, :tunnels, :u_turns]
  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>) 


3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
 
# File 'gems/aws-sdk-georoutes/lib/aws-sdk-georoutes/types.rb', line 3615

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

#tunnels ⇒ Boolean

Avoid tunnels while calculating the route.

Returns:

  • (Boolean) 


3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
 
# File 'gems/aws-sdk-georoutes/lib/aws-sdk-georoutes/types.rb', line 3615

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

#u_turns ⇒ Boolean

Avoid U-turns for calculation on highways and motorways.

Returns:

  • (Boolean) 


3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
 
# File 'gems/aws-sdk-georoutes/lib/aws-sdk-georoutes/types.rb', line 3615

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

#zone_categories ⇒ Array<Types::RouteMatrixAvoidanceZoneCategory>

Zone categories to be avoided.

Returns:



3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
 
# File 'gems/aws-sdk-georoutes/lib/aws-sdk-georoutes/types.rb', line 3615

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