Leg (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Leg
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains the calculated route's details for each path between a pair of positions. The number of legs returned corresponds to one fewer than the total number of positions in the request.

For example, a route with a departure position and destination position returns one leg with the positions snapped to a nearby road:
- The StartPosition is the departure position.
- The EndPosition is the destination position.
A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:
- Leg 1: The StartPosition is the departure position . The EndPosition is the waypoint positon.
- Leg 2: The StartPosition is the waypoint position. The EndPosition is the destination position.
See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Leg()

Constructors
Constructor and Description
`Leg()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Leg`	`clone()`
`boolean`	`equals(Object obj)`
`Double`	`getDistance()` The distance between the leg's `StartPosition` and `EndPosition` along a calculated route.
`Double`	`getDurationSeconds()` The estimated travel time between the leg's `StartPosition` and `EndPosition`.
`List<Double>`	`getEndPosition()` The terminating position of the leg.
`LegGeometry`	`getGeometry()` Contains the calculated route's path as a linestring geometry.
`List<Double>`	`getStartPosition()` The starting position of the leg.
`List<Step>`	`getSteps()` Contains a list of steps, which represent subsections of a leg.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDistance(Double distance)` The distance between the leg's `StartPosition` and `EndPosition` along a calculated route.
`void`	`setDurationSeconds(Double durationSeconds)` The estimated travel time between the leg's `StartPosition` and `EndPosition`.
`void`	`setEndPosition(Collection<Double> endPosition)` The terminating position of the leg.
`void`	`setGeometry(LegGeometry geometry)` Contains the calculated route's path as a linestring geometry.
`void`	`setStartPosition(Collection<Double> startPosition)` The starting position of the leg.
`void`	`setSteps(Collection<Step> steps)` Contains a list of steps, which represent subsections of a leg.
`String`	`toString()` Returns a string representation of this object.
`Leg`	`withDistance(Double distance)` The distance between the leg's `StartPosition` and `EndPosition` along a calculated route.
`Leg`	`withDurationSeconds(Double durationSeconds)` The estimated travel time between the leg's `StartPosition` and `EndPosition`.
`Leg`	`withEndPosition(Collection<Double> endPosition)` The terminating position of the leg.
`Leg`	`withEndPosition(Double... endPosition)` The terminating position of the leg.
`Leg`	`withGeometry(LegGeometry geometry)` Contains the calculated route's path as a linestring geometry.
`Leg`	`withStartPosition(Collection<Double> startPosition)` The starting position of the leg.
`Leg`	`withStartPosition(Double... startPosition)` The starting position of the leg.
`Leg`	`withSteps(Collection<Step> steps)` Contains a list of steps, which represent subsections of a leg.
`Leg`	`withSteps(Step... steps)` Contains a list of steps, which represent subsections of a leg.

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

- Constructor Detail
  - Leg
```
public Leg()
```
- Method Detail
  - setDistance
```
public void setDistance(Double distance)
```
    The distance between the leg's StartPosition and EndPosition along a calculated route.
    - The default measurement is Kilometers unless the request specifies a DistanceUnit of Miles.
    Parameters:
    distance - The distance between the leg's StartPosition and EndPosition along a calculated route.
    
    The default measurement is Kilometers unless the request specifies a DistanceUnit of Miles.
  - getDistance
```
public Double getDistance()
```
    The distance between the leg's StartPosition and EndPosition along a calculated route.
    - The default measurement is Kilometers unless the request specifies a DistanceUnit of Miles.
    Returns:
    The distance between the leg's StartPosition and EndPosition along a calculated route.
    
    The default measurement is Kilometers unless the request specifies a DistanceUnit of Miles.
  - withDistance
```
public Leg withDistance(Double distance)
```
    The distance between the leg's StartPosition and EndPosition along a calculated route.
    - The default measurement is Kilometers unless the request specifies a DistanceUnit of Miles.
    Parameters:
    distance - The distance between the leg's StartPosition and EndPosition along a calculated route.
    
    The default measurement is Kilometers unless the request specifies a DistanceUnit of Miles.
    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 between the leg's StartPosition and EndPosition. The travel mode and departure time that you specify in the request determines the calculated time.
    
    Parameters:
    
    durationSeconds - The estimated travel time between the leg's StartPosition and 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 between the leg's StartPosition and EndPosition. The travel mode and departure time that you specify in the request determines the calculated time.
    
    Returns:
    
    The estimated travel time between the leg's StartPosition and EndPosition. The travel mode and departure time that you specify in the request determines the calculated time.
  - withDurationSeconds
```
public Leg withDurationSeconds(Double durationSeconds)
```
    The estimated travel time between the leg's StartPosition and EndPosition. The travel mode and departure time that you specify in the request determines the calculated time.
    
    Parameters:
    
    durationSeconds - The estimated travel time between the leg's StartPosition and 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.
  - getEndPosition
```
public List<Double> getEndPosition()
```
    The terminating position of the leg. Follows the format [longitude,latitude].
    
    If the EndPosition isn't located on a road, it's snapped to a nearby road.
    
    Returns:
    
    The terminating position of the leg. Follows the format [longitude,latitude].
    
    If the EndPosition isn't located on a road, it's snapped to a nearby road.
  - setEndPosition
```
public void setEndPosition(Collection<Double> endPosition)
```
    The terminating position of the leg. Follows the format [longitude,latitude].
    
    If the EndPosition isn't located on a road, it's snapped to a nearby road.
    
    Parameters:
    
    endPosition - The terminating position of the leg. Follows the format [longitude,latitude].
    
    If the EndPosition isn't located on a road, it's snapped to a nearby road.
  - withEndPosition
```
public Leg withEndPosition(Double... endPosition)
```
    The terminating position of the leg. Follows the format [longitude,latitude].
    
    If the EndPosition isn't located on a road, it's snapped to a nearby road.
    
    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 terminating position of the leg. Follows the format [longitude,latitude].
    
    If the EndPosition isn't located on a road, it's snapped to a nearby road.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withEndPosition
```
public Leg withEndPosition(Collection<Double> endPosition)
```
    The terminating position of the leg. Follows the format [longitude,latitude].
    
    If the EndPosition isn't located on a road, it's snapped to a nearby road.
    
    Parameters:
    
    endPosition - The terminating position of the leg. Follows the format [longitude,latitude].
    
    If the EndPosition isn't located on a road, it's snapped to a nearby road.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGeometry
```
public void setGeometry(LegGeometry geometry)
```
    Contains the calculated route's path as a linestring geometry.
    
    Parameters:
    
    geometry - Contains the calculated route's path as a linestring geometry.
  - getGeometry
```
public LegGeometry getGeometry()
```
    Contains the calculated route's path as a linestring geometry.
    
    Returns:
    
    Contains the calculated route's path as a linestring geometry.
  - withGeometry
```
public Leg withGeometry(LegGeometry geometry)
```
    Contains the calculated route's path as a linestring geometry.
    
    Parameters:
    
    geometry - Contains the calculated route's path as a linestring geometry.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getStartPosition
```
public List<Double> getStartPosition()
```
    The starting position of the leg. Follows the format [longitude,latitude].
    
    If the StartPosition isn't located on a road, it's snapped to a nearby road.
    
    Returns:
    
    The starting position of the leg. Follows the format [longitude,latitude].
    
    If the StartPosition isn't located on a road, it's snapped to a nearby road.
  - setStartPosition
```
public void setStartPosition(Collection<Double> startPosition)
```
    The starting position of the leg. Follows the format [longitude,latitude].
    
    If the StartPosition isn't located on a road, it's snapped to a nearby road.
    
    Parameters:
    
    startPosition - The starting position of the leg. Follows the format [longitude,latitude].
    
    If the StartPosition isn't located on a road, it's snapped to a nearby road.
  - withStartPosition
```
public Leg withStartPosition(Double... startPosition)
```
    The starting position of the leg. Follows the format [longitude,latitude].
    
    If the StartPosition isn't located on a road, it's snapped to a nearby road.
    
    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 the leg. Follows the format [longitude,latitude].
    
    If the StartPosition isn't located on a road, it's snapped to a nearby road.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withStartPosition
```
public Leg withStartPosition(Collection<Double> startPosition)
```
    The starting position of the leg. Follows the format [longitude,latitude].
    
    If the StartPosition isn't located on a road, it's snapped to a nearby road.
    
    Parameters:
    
    startPosition - The starting position of the leg. Follows the format [longitude,latitude].
    
    If the StartPosition isn't located on a road, it's snapped to a nearby road.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSteps
```
public List<Step> getSteps()
```
    Contains a list of steps, which represent subsections of a leg. Each step provides instructions for how to move to the next step in the leg such as the step's start position, end position, travel distance, travel duration, and geometry offset.
    
    Returns:
    
    Contains a list of steps, which represent subsections of a leg. Each step provides instructions for how to move to the next step in the leg such as the step's start position, end position, travel distance, travel duration, and geometry offset.
  - setSteps
```
public void setSteps(Collection<Step> steps)
```
    Contains a list of steps, which represent subsections of a leg. Each step provides instructions for how to move to the next step in the leg such as the step's start position, end position, travel distance, travel duration, and geometry offset.
    
    Parameters:
    
    steps - Contains a list of steps, which represent subsections of a leg. Each step provides instructions for how to move to the next step in the leg such as the step's start position, end position, travel distance, travel duration, and geometry offset.
  - withSteps
```
public Leg withSteps(Step... steps)
```
    Contains a list of steps, which represent subsections of a leg. Each step provides instructions for how to move to the next step in the leg such as the step's start position, end position, travel distance, travel duration, and geometry offset.
    
    NOTE: This method appends the values to the existing list (if any). Use setSteps(java.util.Collection) or withSteps(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    steps - Contains a list of steps, which represent subsections of a leg. Each step provides instructions for how to move to the next step in the leg such as the step's start position, end position, travel distance, travel duration, and geometry offset.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSteps
```
public Leg withSteps(Collection<Step> steps)
```
    Contains a list of steps, which represent subsections of a leg. Each step provides instructions for how to move to the next step in the leg such as the step's start position, end position, travel distance, travel duration, and geometry offset.
    
    Parameters:
    
    steps - Contains a list of steps, which represent subsections of a leg. Each step provides instructions for how to move to the next step in the leg such as the step's start position, end position, travel distance, travel duration, and geometry offset.
    
    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 Leg 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.

Did this page help you?

Class Leg

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Leg

Method Detail

setDistance

getDistance

withDistance

setDurationSeconds

getDurationSeconds

withDurationSeconds

getEndPosition

setEndPosition

withEndPosition

withEndPosition

setGeometry

getGeometry

withGeometry

getStartPosition

setStartPosition

withStartPosition

withStartPosition

getSteps

setSteps

withSteps

withSteps

toString

equals

hashCode

clone

marshall