Class: Aws::GeoRoutes::Types::RouteMatchingOptions

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

Overview

Options related to route matching.

See Also:

Constant Summary collapse

SENSITIVE = 
[:name_hint]

Instance Attribute Summary collapse

Instance Attribute Details

#name_hint ⇒ String

Attempts to match the provided position to a road similar to the provided name.

Returns:

  • (String) 


2914
2915
2916
2917
2918
2919
2920
2921
 
# File 'gems/aws-sdk-georoutes/lib/aws-sdk-georoutes/types.rb', line 2914

class RouteMatchingOptions < Struct.new(
  :name_hint,
  :on_road_threshold,
  :radius,
  :strategy)
  SENSITIVE = [:name_hint]
  include Aws::Structure
end

#on_road_threshold ⇒ Integer

If the distance to a highway/bridge/tunnel/sliproad is within threshold, the waypoint will be snapped to the highway/bridge/tunnel/sliproad.

Unit: meters

Returns:

  • (Integer) 


2914
2915
2916
2917
2918
2919
2920
2921
 
# File 'gems/aws-sdk-georoutes/lib/aws-sdk-georoutes/types.rb', line 2914

class RouteMatchingOptions < Struct.new(
  :name_hint,
  :on_road_threshold,
  :radius,
  :strategy)
  SENSITIVE = [:name_hint]
  include Aws::Structure
end

#radius ⇒ Integer

Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.

Unit: Meters

Returns:

  • (Integer) 


2914
2915
2916
2917
2918
2919
2920
2921
 
# File 'gems/aws-sdk-georoutes/lib/aws-sdk-georoutes/types.rb', line 2914

class RouteMatchingOptions < Struct.new(
  :name_hint,
  :on_road_threshold,
  :radius,
  :strategy)
  SENSITIVE = [:name_hint]
  include Aws::Structure
end

#strategy ⇒ String

Strategy that defines matching of the position onto the road network. MatchAny considers all roads possible, whereas MatchMostSignificantRoad matches to the most significant road.

Returns:

  • (String) 


2914
2915
2916
2917
2918
2919
2920
2921
 
# File 'gems/aws-sdk-georoutes/lib/aws-sdk-georoutes/types.rb', line 2914

class RouteMatchingOptions < Struct.new(
  :name_hint,
  :on_road_threshold,
  :radius,
  :strategy)
  SENSITIVE = [:name_hint]
  include Aws::Structure
end