Class CalculateRouteSummary

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

A summary of the calculated route.

See Also:

  • Method Details

    • hasRouteBBox

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

    • routeBBox

      public final List<Double> routeBBox()

      Specifies a geographical box surrounding a route. Used to zoom into a route when displaying it in a map. For example, [min x, min y, max x, max y].

      The first 2 bbox parameters describe the lower southwest corner:

      • The first bbox position is the X coordinate or longitude of the lower southwest corner.

      • The second bbox position is the Y coordinate or latitude of the lower southwest corner.

      The next 2 bbox parameters describe the upper northeast corner:

      • The third bbox position is the X coordinate, or longitude of the upper northeast corner.

      • The fourth bbox position is the Y coordinate, or latitude of the upper northeast corner.

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

      Returns:
      Specifies a geographical box surrounding a route. Used to zoom into a route when displaying it in a map. For example, [min x, min y, max x, max y].

      The first 2 bbox parameters describe the lower southwest corner:

      • The first bbox position is the X coordinate or longitude of the lower southwest corner.

      • The second bbox position is the Y coordinate or latitude of the lower southwest corner.

      The next 2 bbox parameters describe the upper northeast corner:

      • The third bbox position is the X coordinate, or longitude of the upper northeast corner.

      • The fourth bbox position is the Y coordinate, or latitude of the upper northeast corner.

    • dataSource

      public final String dataSource()

      The data provider of traffic and road network data used to calculate the route. 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 route. Indicates one of the available providers:

      • Esri

      • Grab

      • Here

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

    • distance

      public final Double distance()

      The total distance covered by the route. The sum of the distance travelled between every stop on the route.

      If Esri is the data source for the route calculator, the route distance can’t be greater than 400 km. If the route exceeds 400 km, the response is a 400 RoutesValidationException error.

      Returns:
      The total distance covered by the route. The sum of the distance travelled between every stop on the route.

      If Esri is the data source for the route calculator, the route distance can’t be greater than 400 km. If the route exceeds 400 km, the response is a 400 RoutesValidationException error.

    • durationSeconds

      public final Double durationSeconds()

      The total travel time for the route measured in seconds. The sum of the travel time between every stop on the route.

      Returns:
      The total travel time for the route measured in seconds. The sum of the travel time between every stop on the route.

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

    • builder

      public static CalculateRouteSummary.Builder builder()

    • serializableBuilderClass

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