Package software.amazon.awssdk.services.location.model

Class Step

java.lang.Object
software.amazon.awssdk.services.location.model.Step
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Step.Builder,Step>
@Generated("software.amazon.awssdk:codegen") public final class Step extends Object implements SdkPojo, Serializable, 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:

  • Method Details

    • distance

      public final Double distance()

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

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

    • durationSeconds

      public final 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.

      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.

    • 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 the isEmpty() 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

      public final List<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.

      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

      public final 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.

      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.

    • 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 the isEmpty() 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

      public final List<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.

      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

      public Step.Builder 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 interface ToCopyableBuilder<Step.Builder,Step>
      Returns:
      a builder for type T

    • builder

      public static Step.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Step.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.