Class Step
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Step.Builder,
Step>
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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Step.Builder
builder()
final Double
distance()
The travel distance between the step'sStartPosition
andEndPosition
.final Double
The estimated travel time, in seconds, from the step'sStartPosition
to theEndPosition
.The end position of a step.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Integer
Represents the start position, or index, in a sequence of steps within the leg's line string geometry.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the EndPosition property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the StartPosition property.static Class
<? extends Step.Builder> The starting position of a step.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
distance
The travel distance between the step's
StartPosition
andEndPosition
.- Returns:
- The travel distance between the step's
StartPosition
andEndPosition
.
-
durationSeconds
The estimated travel time, in seconds, from the step's
StartPosition
to theEndPosition
. . 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 theEndPosition
. . The travel mode and departure time that you specify in the request determines the calculated time.
-
hasEndPosition
public final boolean hasEndPosition()For responses, this returns true if the service returned a value for the EndPosition property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasEndPosition()
method.- 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.
-
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
toTrue
.- 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
toTrue
.
-
hasStartPosition
public final boolean hasStartPosition()For responses, this returns true if the service returned a value for the StartPosition property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasStartPosition()
method.- 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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Step.Builder,
Step> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-