Class TruckDimensions

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

Contains details about the truck dimensions in the unit of measurement that you specify. Used to filter out roads that can't support or allow the specified dimensions for requests that specify TravelMode as Truck.

See Also:

  • Method Details

    • length

      public final Double length()

      The length of the truck.

      • For example, 15.5.

      For routes calculated with a HERE resource, this value must be between 0 and 300 meters.

      Returns:
      The length of the truck.

      • For example, 15.5.

      For routes calculated with a HERE resource, this value must be between 0 and 300 meters.

    • height

      public final Double height()

      The height of the truck.

      • For example, 4.5.

      For routes calculated with a HERE resource, this value must be between 0 and 50 meters.

      Returns:
      The height of the truck.

      • For example, 4.5.

      For routes calculated with a HERE resource, this value must be between 0 and 50 meters.

    • width

      public final Double width()

      The width of the truck.

      • For example, 4.5.

      For routes calculated with a HERE resource, this value must be between 0 and 50 meters.

      Returns:
      The width of the truck.

      • For example, 4.5.

      For routes calculated with a HERE resource, this value must be between 0 and 50 meters.

    • unit

      public final DimensionUnit unit()

      Specifies the unit of measurement for the truck dimensions.

      Default Value: Meters

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

      Returns:
      Specifies the unit of measurement for the truck dimensions.

      Default Value: Meters

      See Also:

    • unitAsString

      public final String unitAsString()

      Specifies the unit of measurement for the truck dimensions.

      Default Value: Meters

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

      Returns:
      Specifies the unit of measurement for the truck dimensions.

      Default Value: Meters

      See Also:

    • toBuilder

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

    • builder

      public static TruckDimensions.Builder builder()

    • serializableBuilderClass

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