Class RouteMatrixEntryError

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

An error corresponding to the calculation of a route between the DeparturePosition and DestinationPosition.

The error code can be one of the following:

  • RouteNotFound - Unable to find a valid route with the given parameters.

  • RouteTooLong - Route calculation went beyond the maximum size of a route and was terminated before completion.

  • PositionsNotFound - One or more of the input positions were not found on the route network.

  • DestinationPositionNotFound - The destination position was not found on the route network.

  • DeparturePositionNotFound - The departure position was not found on the route network.

  • OtherValidationError - The given inputs were not valid or a route was not found. More information is given in the error Message

See Also:

  • Method Details

    • code

      public final RouteMatrixErrorCode code()

      The type of error which occurred for the route calculation.

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

      Returns:
      The type of error which occurred for the route calculation.
      See Also:

    • codeAsString

      public final String codeAsString()

      The type of error which occurred for the route calculation.

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

      Returns:
      The type of error which occurred for the route calculation.
      See Also:

    • message

      public final String message()

      A message about the error that occurred for the route calculation.

      Returns:
      A message about the error that occurred for the route calculation.

    • toBuilder

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

    • builder

      public static RouteMatrixEntryError.Builder builder()

    • serializableBuilderClass

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