Class RouteMatrixEntry

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

The calculated route matrix containing the results for all pairs of Origins to Destination positions. Each row corresponds to one entry in Origins. Each entry in the row corresponds to the route from that entry in Origins to an entry in Destination positions.

See Also:

  • Method Details

    • distance

      public final Long distance()

      The total distance of travel for the route.

      Returns:
      The total distance of travel for the route.

    • duration

      public final Long duration()

      The expected duration of travel for the route.

      Unit: seconds

      Returns:
      The expected duration of travel for the route.

      Unit: seconds

    • error

      public final RouteMatrixErrorCode error()

      Error code that occurred during calculation of the route.

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

      Returns:
      Error code that occurred during calculation of the route.
      See Also:

    • errorAsString

      public final String errorAsString()

      Error code that occurred during calculation of the route.

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

      Returns:
      Error code that occurred during calculation of the route.
      See Also:

    • toBuilder

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

    • builder

      public static RouteMatrixEntry.Builder builder()

    • serializableBuilderClass

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