Step (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.location.model.Step

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Step
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Step()

Constructors
Constructor and Description
`Step()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Step`	`clone()`
`boolean`	`equals(Object obj)`
`Double`	`getDistance()` The travel distance between the step's `StartPosition` and `EndPosition`.
`Double`	`getDurationSeconds()` The estimated travel time, in seconds, from the step's `StartPosition` to the `EndPosition` .
`List<Double>`	`getEndPosition()` The end position of a step.
`Integer`	`getGeometryOffset()` Represents the start position, or index, in a sequence of steps within the leg's line string geometry.
`List<Double>`	`getStartPosition()` The starting position of a step.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDistance(Double distance)` The travel distance between the step's `StartPosition` and `EndPosition`.
`void`	`setDurationSeconds(Double durationSeconds)` The estimated travel time, in seconds, from the step's `StartPosition` to the `EndPosition` .
`void`	`setEndPosition(Collection<Double> endPosition)` The end position of a step.
`void`	`setGeometryOffset(Integer geometryOffset)` Represents the start position, or index, in a sequence of steps within the leg's line string geometry.
`void`	`setStartPosition(Collection<Double> startPosition)` The starting position of a step.
`String`	`toString()` Returns a string representation of this object.
`Step`	`withDistance(Double distance)` The travel distance between the step's `StartPosition` and `EndPosition`.
`Step`	`withDurationSeconds(Double durationSeconds)` The estimated travel time, in seconds, from the step's `StartPosition` to the `EndPosition` .
`Step`	`withEndPosition(Collection<Double> endPosition)` The end position of a step.
`Step`	`withEndPosition(Double... endPosition)` The end position of a step.
`Step`	`withGeometryOffset(Integer geometryOffset)` Represents the start position, or index, in a sequence of steps within the leg's line string geometry.
`Step`	`withStartPosition(Collection<Double> startPosition)` The starting position of a step.
`Step`	`withStartPosition(Double... startPosition)` The starting position of a step.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Step
```
public Step()
```
- Method Detail
  - getStartPosition
```
public List<Double> getStartPosition()
```
    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:
    
    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.
  - setStartPosition
```
public void setStartPosition(Collection<Double> startPosition)
```
    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.
    
    Parameters:
    
    startPosition - 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.
  - withStartPosition
```
public Step withStartPosition(Double... startPosition)
```
    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.
    
    NOTE: This method appends the values to the existing list (if any). Use setStartPosition(java.util.Collection) or withStartPosition(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    startPosition - 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - withStartPosition
```
public Step withStartPosition(Collection<Double> startPosition)
```
    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.
    
    Parameters:
    
    startPosition - 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getEndPosition
```
public List<Double> getEndPosition()
```
    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:
    
    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.
  - setEndPosition
```
public void setEndPosition(Collection<Double> endPosition)
```
    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.
    
    Parameters:
    
    endPosition - 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.
  - withEndPosition
```
public Step withEndPosition(Double... endPosition)
```
    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.
    
    NOTE: This method appends the values to the existing list (if any). Use setEndPosition(java.util.Collection) or withEndPosition(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    endPosition - 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - withEndPosition
```
public Step withEndPosition(Collection<Double> endPosition)
```
    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.
    
    Parameters:
    
    endPosition - 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDistance
```
public void setDistance(Double distance)
```
    The travel distance between the step's StartPosition and EndPosition.
    
    Parameters:
    
    distance - The travel distance between the step's StartPosition and EndPosition.
  - getDistance
```
public Double getDistance()
```
    The travel distance between the step's StartPosition and EndPosition.
    
    Returns:
    
    The travel distance between the step's StartPosition and EndPosition.
  - withDistance
```
public Step withDistance(Double distance)
```
    The travel distance between the step's StartPosition and EndPosition.
    
    Parameters:
    
    distance - The travel distance between the step's StartPosition and EndPosition.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDurationSeconds
```
public void setDurationSeconds(Double durationSeconds)
```
    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.
    
    Parameters:
    
    durationSeconds - 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.
  - getDurationSeconds
```
public Double getDurationSeconds()
```
    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:
    
    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.
  - withDurationSeconds
```
public Step withDurationSeconds(Double durationSeconds)
```
    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.
    
    Parameters:
    
    durationSeconds - 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGeometryOffset
```
public void setGeometryOffset(Integer geometryOffset)
```
    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.
    
    Parameters:
    
    geometryOffset - 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.
  - getGeometryOffset
```
public Integer getGeometryOffset()
```
    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:
    
    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.
  - withGeometryOffset
```
public Step withGeometryOffset(Integer geometryOffset)
```
    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.
    
    Parameters:
    
    geometryOffset - 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Step clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.772

Class Step

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Step

Method Detail

getStartPosition

setStartPosition

withStartPosition

withStartPosition

getEndPosition

setEndPosition

withEndPosition

withEndPosition

setDistance

getDistance

withDistance

setDurationSeconds

getDurationSeconds

withDurationSeconds

setGeometryOffset

getGeometryOffset

withGeometryOffset

toString

equals

hashCode

clone

marshall