Class RouteFerryTravelStep

java.lang.Object
software.amazon.awssdk.services.georoutes.model.RouteFerryTravelStep
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RouteFerryTravelStep.Builder,RouteFerryTravelStep>
@Generated("software.amazon.awssdk:codegen") public final class RouteFerryTravelStep extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RouteFerryTravelStep.Builder,RouteFerryTravelStep>

Steps of a leg that must be performed during the travel portion of the leg.

See Also:

  • Method Details

    • distance

      public final Long distance()

      Distance of the step.

      Returns:
      Distance of the step.

    • duration

      public final Long duration()

      Duration of the step.

      Unit: seconds

      Returns:
      Duration of the step.

      Unit: seconds

    • geometryOffset

      public final Integer geometryOffset()

      Offset in the leg geometry corresponding to the start of this step.

      Returns:
      Offset in the leg geometry corresponding to the start of this step.

    • instruction

      public final String instruction()

      Brief description of the step in the requested language.

      Only available when the TravelStepType is Default.

      Returns:
      Brief description of the step in the requested language.

      Only available when the TravelStepType is Default.

    • type

      public final RouteFerryTravelStepType type()

      Type of the step.

      If the service returns an enum value that is not available in the current SDK version, type will return RouteFerryTravelStepType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      Type of the step.
      See Also:

    • typeAsString

      public final String typeAsString()

      Type of the step.

      If the service returns an enum value that is not available in the current SDK version, type will return RouteFerryTravelStepType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      Type of the step.
      See Also:

    • toBuilder

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

    • builder

      public static RouteFerryTravelStep.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RouteFerryTravelStep.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.