Class RouteFerrySpan

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

Span computed for the requested SpanAdditionalFeatures.

See Also:

  • Method Details

    • country

      public final String country()

      3 letter Country code corresponding to the Span.

      Returns:
      3 letter Country code corresponding to the Span.

    • distance

      public final Long distance()

      Distance of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.

      Unit: meters

      Returns:
      Distance of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.

      Unit: meters

    • duration

      public final Long duration()

      Duration of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.

      Unit: seconds

      Returns:
      Duration of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.

      Unit: seconds

    • geometryOffset

      public final Integer geometryOffset()

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

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

    • hasNames

      public final boolean hasNames()
      For responses, this returns true if the service returned a value for the Names 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.

    • names

      public final List<LocalizedString> names()

      Provides an array of names of the ferry span in available languages.

      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 hasNames() method.

      Returns:
      Provides an array of names of the ferry span in available languages.

    • region

      public final String region()

      2-3 letter Region code corresponding to the Span. This is either a province or a state.

      Returns:
      2-3 letter Region code corresponding to the Span. This is either a province or a state.

    • toBuilder

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

    • builder

      public static RouteFerrySpan.Builder builder()

    • serializableBuilderClass

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