Class: Aws::GeoRoutes::Types::SnapToRoadsRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:key]

Instance Attribute Summary collapse

Instance Attribute Details

#key ⇒ String

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

Returns:

  • (String) 


5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
 
# File 'lib/aws-sdk-georoutes/types.rb', line 5985

class SnapToRoadsRequest < Struct.new(
  :key,
  :snapped_geometry_format,
  :snap_radius,
  :trace_points,
  :travel_mode,
  :travel_mode_options)
  SENSITIVE = [:key]
  include Aws::Structure
end

#snap_radius ⇒ Integer

The radius around the provided tracepoint that is considered for snapping.

Unit: ‘meters`

Default value: ‘300`

Returns:

  • (Integer) 


5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
 
# File 'lib/aws-sdk-georoutes/types.rb', line 5985

class SnapToRoadsRequest < Struct.new(
  :key,
  :snapped_geometry_format,
  :snap_radius,
  :trace_points,
  :travel_mode,
  :travel_mode_options)
  SENSITIVE = [:key]
  include Aws::Structure
end

#snapped_geometry_format ⇒ String

Chooses what the returned SnappedGeometry format should be.

Default Value: ‘FlexiblePolyline`

Returns:

  • (String) 


5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
 
# File 'lib/aws-sdk-georoutes/types.rb', line 5985

class SnapToRoadsRequest < Struct.new(
  :key,
  :snapped_geometry_format,
  :snap_radius,
  :trace_points,
  :travel_mode,
  :travel_mode_options)
  SENSITIVE = [:key]
  include Aws::Structure
end

#trace_points ⇒ Array<Types::RoadSnapTracePoint>

List of trace points to be snapped onto the road network.

Returns:



5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
 
# File 'lib/aws-sdk-georoutes/types.rb', line 5985

class SnapToRoadsRequest < Struct.new(
  :key,
  :snapped_geometry_format,
  :snap_radius,
  :trace_points,
  :travel_mode,
  :travel_mode_options)
  SENSITIVE = [:key]
  include Aws::Structure
end

#travel_mode ⇒ String

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

Default Value: ‘Car`

Returns:

  • (String) 


5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
 
# File 'lib/aws-sdk-georoutes/types.rb', line 5985

class SnapToRoadsRequest < Struct.new(
  :key,
  :snapped_geometry_format,
  :snap_radius,
  :trace_points,
  :travel_mode,
  :travel_mode_options)
  SENSITIVE = [:key]
  include Aws::Structure
end

#travel_mode_options ⇒ Types::RoadSnapTravelModeOptions

Travel mode related options for the provided travel mode.

Returns:



5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
 
# File 'lib/aws-sdk-georoutes/types.rb', line 5985

class SnapToRoadsRequest < Struct.new(
  :key,
  :snapped_geometry_format,
  :snap_radius,
  :trace_points,
  :travel_mode,
  :travel_mode_options)
  SENSITIVE = [:key]
  include Aws::Structure
end