Class RouteTruckOptions

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

Travel mode options when the provided travel mode is "Truck"

See Also:

  • Method Details

    • axleCount

      public final Integer axleCount()

      Total number of axles of the vehicle.

      Returns:
      Total number of axles of the vehicle.

    • engineType

      public final RouteEngineType engineType()

      Engine type of the vehicle.

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

      Returns:
      Engine type of the vehicle.
      See Also:

    • engineTypeAsString

      public final String engineTypeAsString()

      Engine type of the vehicle.

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

      Returns:
      Engine type of the vehicle.
      See Also:

    • grossWeight

      public final Long grossWeight()

      Gross weight of the vehicle including trailers, and goods at capacity.

      Unit: Kilograms

      Returns:
      Gross weight of the vehicle including trailers, and goods at capacity.

      Unit: Kilograms

    • hazardousCargos

      public final List<RouteHazardousCargoType> hazardousCargos()

      List of Hazardous cargo contained in the vehicle.

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

      Returns:
      List of Hazardous cargo contained in the vehicle.

    • hasHazardousCargos

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

    • hazardousCargosAsStrings

      public final List<String> hazardousCargosAsStrings()

      List of Hazardous cargo contained in the vehicle.

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

      Returns:
      List of Hazardous cargo contained in the vehicle.

    • height

      public final Long height()

      Height of the vehicle.

      Unit: centimeters

      Returns:
      Height of the vehicle.

      Unit: centimeters

    • heightAboveFirstAxle

      public final Long heightAboveFirstAxle()

      Height of the vehicle above its first axle.

      Unit: centimeters

      Returns:
      Height of the vehicle above its first axle.

      Unit: centimeters

    • kpraLength

      public final Long kpraLength()

      Kingpin to rear axle length of the vehicle.

      Unit: centimeters

      Returns:
      Kingpin to rear axle length of the vehicle.

      Unit: centimeters

    • length

      public final Long length()

      Length of the vehicle.

      Unit: c

      Returns:
      Length of the vehicle.

      Unit: c

    • licensePlate

      public final RouteVehicleLicensePlate licensePlate()

      The vehicle License Plate.

      Returns:
      The vehicle License Plate.

    • maxSpeed

      public final Double maxSpeed()

      Maximum speed

      Unit: KilometersPerHour

      Returns:
      Maximum speed

      Unit: KilometersPerHour

    • occupancy

      public final Integer occupancy()

      The number of occupants in the vehicle.

      Default Value: 1

      Returns:
      The number of occupants in the vehicle.

      Default Value: 1

    • payloadCapacity

      public final Long payloadCapacity()

      Payload capacity of the vehicle and trailers attached.

      Unit: kilograms

      Returns:
      Payload capacity of the vehicle and trailers attached.

      Unit: kilograms

    • tireCount

      public final Integer tireCount()

      Number of tires on the vehicle.

      Returns:
      Number of tires on the vehicle.

    • trailer

      public final RouteTrailerOptions trailer()

      Trailer options corresponding to the vehicle.

      Returns:
      Trailer options corresponding to the vehicle.

    • truckType

      public final RouteTruckType truckType()

      Type of the truck.

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

      Returns:
      Type of the truck.
      See Also:

    • truckTypeAsString

      public final String truckTypeAsString()

      Type of the truck.

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

      Returns:
      Type of the truck.
      See Also:

    • tunnelRestrictionCode

      public final String tunnelRestrictionCode()

      The tunnel restriction code.

      Tunnel categories in this list indicate the restrictions which apply to certain tunnels in Great Britain. They relate to the types of dangerous goods that can be transported through them.

      • Tunnel Category B

        • Risk Level: Limited risk

        • Restrictions: Few restrictions

      • Tunnel Category C

        • Risk Level: Medium risk

        • Restrictions: Some restrictions

      • Tunnel Category D

        • Risk Level: High risk

        • Restrictions: Many restrictions occur

      • Tunnel Category E

        • Risk Level: Very high risk

        • Restrictions: Restricted tunnel

      Returns:
      The tunnel restriction code.

      Tunnel categories in this list indicate the restrictions which apply to certain tunnels in Great Britain. They relate to the types of dangerous goods that can be transported through them.

      • Tunnel Category B

        • Risk Level: Limited risk

        • Restrictions: Few restrictions

      • Tunnel Category C

        • Risk Level: Medium risk

        • Restrictions: Some restrictions

      • Tunnel Category D

        • Risk Level: High risk

        • Restrictions: Many restrictions occur

      • Tunnel Category E

        • Risk Level: Very high risk

        • Restrictions: Restricted tunnel

    • weightPerAxle

      public final Long weightPerAxle()

      Heaviest weight per axle irrespective of the axle type or the axle group. Meant for usage in countries where the differences in axle types or axle groups are not distinguished.

      Unit: Kilograms

      Returns:
      Heaviest weight per axle irrespective of the axle type or the axle group. Meant for usage in countries where the differences in axle types or axle groups are not distinguished.

      Unit: Kilograms

    • weightPerAxleGroup

      public final WeightPerAxleGroup weightPerAxleGroup()

      Specifies the total weight for the specified axle group. Meant for usage in countries that have different regulations based on the axle group type.

      Unit: Kilograms

      Returns:
      Specifies the total weight for the specified axle group. Meant for usage in countries that have different regulations based on the axle group type.

      Unit: Kilograms

    • width

      public final Long width()

      Width of the vehicle.

      Unit: centimeters

      Returns:
      Width of the vehicle.

      Unit: centimeters

    • toBuilder

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

    • builder

      public static RouteTruckOptions.Builder builder()

    • serializableBuilderClass

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