Class: Aws::LocationService::Types::Step

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

Overview

Represents an element of a leg within a route. A step contains instructions for how to move to the next step in the leg.

See Also:

Constant Summary collapse

SENSITIVE = 
[:start_position, :end_position]

Instance Attribute Summary collapse

Instance Attribute Details

#distance ⇒ Float

The travel distance between the step's StartPosition and EndPosition.

Returns:

  • (Float) 

6347
6348
6349
6350
6351
6352
6353
6354
6355
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 6347

class Step < Struct.new(
  :start_position,
  :end_position,
  :distance,
  :duration_seconds,
  :geometry_offset)
  SENSITIVE = [:start_position, :end_position]
  include Aws::Structure
end

#duration_seconds ⇒ Float

The estimated travel time, in seconds, from the step's StartPosition to the EndPosition. . The travel mode and departure time that you specify in the request determines the calculated time.

Returns:

  • (Float) 

6347
6348
6349
6350
6351
6352
6353
6354
6355
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 6347

class Step < Struct.new(
  :start_position,
  :end_position,
  :distance,
  :duration_seconds,
  :geometry_offset)
  SENSITIVE = [:start_position, :end_position]
  include Aws::Structure
end

#end_position ⇒ Array<Float>

The end position of a step. If the position the last step in the leg, this position is the same as the end position of the leg.

Returns:

  • (Array<Float>) 

6347
6348
6349
6350
6351
6352
6353
6354
6355
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 6347

class Step < Struct.new(
  :start_position,
  :end_position,
  :distance,
  :duration_seconds,
  :geometry_offset)
  SENSITIVE = [:start_position, :end_position]
  include Aws::Structure
end

#geometry_offset ⇒ Integer

Represents the start position, or index, in a sequence of steps within the leg's line string geometry. For example, the index of the first step in a leg geometry is 0.

Included in the response for queries that set IncludeLegGeometry to True.

Returns:

  • (Integer) 

6347
6348
6349
6350
6351
6352
6353
6354
6355
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 6347

class Step < Struct.new(
  :start_position,
  :end_position,
  :distance,
  :duration_seconds,
  :geometry_offset)
  SENSITIVE = [:start_position, :end_position]
  include Aws::Structure
end

#start_position ⇒ Array<Float>

The starting position of a step. If the position is the first step in the leg, this position is the same as the start position of the leg.

Returns:

  • (Array<Float>) 

6347
6348
6349
6350
6351
6352
6353
6354
6355
 
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 6347

class Step < Struct.new(
  :start_position,
  :end_position,
  :distance,
  :duration_seconds,
  :geometry_offset)
  SENSITIVE = [:start_position, :end_position]
  include Aws::Structure
end