Class CalculateRouteMatrixSummary

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

A summary of the calculated route matrix.

See Also:

  • Method Details

    • dataSource

      public final String dataSource()

      The data provider of traffic and road network data used to calculate the routes. Indicates one of the available providers:

      • Esri

      • Grab

      • Here

      For more information about data providers, see Amazon Location Service data providers.

      Returns:
      The data provider of traffic and road network data used to calculate the routes. Indicates one of the available providers:

      • Esri

      • Grab

      • Here

      For more information about data providers, see Amazon Location Service data providers.

    • routeCount

      public final Integer routeCount()

      The count of cells in the route matrix. Equal to the number of DeparturePositions multiplied by the number of DestinationPositions.

      Returns:
      The count of cells in the route matrix. Equal to the number of DeparturePositions multiplied by the number of DestinationPositions.

    • errorCount

      public final Integer errorCount()

      The count of error results in the route matrix. If this number is 0, all routes were calculated successfully.

      Returns:
      The count of error results in the route matrix. If this number is 0, all routes were calculated successfully.

    • distanceUnit

      public final DistanceUnit distanceUnit()

      The unit of measurement for route distances.

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

      Returns:
      The unit of measurement for route distances.
      See Also:

    • distanceUnitAsString

      public final String distanceUnitAsString()

      The unit of measurement for route distances.

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

      Returns:
      The unit of measurement for route distances.
      See Also:

    • toBuilder

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

    • builder

      public static CalculateRouteMatrixSummary.Builder builder()

    • serializableBuilderClass

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