Class IsolineTruckOptions

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

Vehicle characteristics and restrictions that affect which roads can be used when calculating reachable areas for trucks. These details ensure that routes respect physical limitations and legal requirements.

These apply when the provided travel mode is Truck

See Also:

  • Method Details

    • axleCount

      public final Integer axleCount()

      The total number of axles on the vehicle. Required for certain road restrictions and weight limit calculations.

      Returns:
      The total number of axles on the vehicle. Required for certain road restrictions and weight limit calculations.

    • engineType

      public final IsolineEngineType engineType()

      The type of engine powering the vehicle, which may affect route calculation due to road restrictions or vehicle characteristics.

      • INTERNAL_COMBUSTION—Standard gasoline or diesel engine.

      • ELECTRIC—Battery electric vehicle.

      • PLUGIN_HYBRID—Combination of electric and internal combustion engines with plug-in charging capability.

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

      Returns:
      The type of engine powering the vehicle, which may affect route calculation due to road restrictions or vehicle characteristics.

      • INTERNAL_COMBUSTION—Standard gasoline or diesel engine.

      • ELECTRIC—Battery electric vehicle.

      • PLUGIN_HYBRID—Combination of electric and internal combustion engines with plug-in charging capability.

      See Also:

    • engineTypeAsString

      public final String engineTypeAsString()

      The type of engine powering the vehicle, which may affect route calculation due to road restrictions or vehicle characteristics.

      • INTERNAL_COMBUSTION—Standard gasoline or diesel engine.

      • ELECTRIC—Battery electric vehicle.

      • PLUGIN_HYBRID—Combination of electric and internal combustion engines with plug-in charging capability.

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

      Returns:
      The type of engine powering the vehicle, which may affect route calculation due to road restrictions or vehicle characteristics.

      • INTERNAL_COMBUSTION—Standard gasoline or diesel engine.

      • ELECTRIC—Battery electric vehicle.

      • PLUGIN_HYBRID—Combination of electric and internal combustion engines with plug-in charging capability.

      See Also:

    • grossWeight

      public final Long grossWeight()

      The gross vehicle weight (the maximum weight a vehicle can safely operate at, as specified by the manufacturer) in kilograms. Used to avoid roads with weight restrictions and ensure compliance with maximum allowed vehicle weight regulations.

      Unit: kilograms

      Returns:
      The gross vehicle weight (the maximum weight a vehicle can safely operate at, as specified by the manufacturer) in kilograms. Used to avoid roads with weight restrictions and ensure compliance with maximum allowed vehicle weight regulations.

      Unit: kilograms

    • hazardousCargos

      public final List<IsolineHazardousCargoType> hazardousCargos()

      Types of hazardous materials being transported. This affects which roads and tunnels can be used based on local regulations.

      • Combustible—Materials that can burn readily

      • Corrosive—Materials that can destroy or irreversibly damage other substances

      • Explosive—Materials that can produce an explosion by chemical reaction

      • Flammable—Materials that can easily ignite

      • Gas—Hazardous materials in gaseous form

      • HarmfulToWater—Materials that pose a risk to water sources if released

      • Organic—Hazardous organic compounds

      • Other—Hazardous materials not covered by other categories

      • Poison—Toxic materials

      • PoisonousInhalation—Materials that are toxic when inhaled

      • Radioactive—Materials that emit ionizing radiation

      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:
      Types of hazardous materials being transported. This affects which roads and tunnels can be used based on local regulations.

      • Combustible—Materials that can burn readily

      • Corrosive—Materials that can destroy or irreversibly damage other substances

      • Explosive—Materials that can produce an explosion by chemical reaction

      • Flammable—Materials that can easily ignite

      • Gas—Hazardous materials in gaseous form

      • HarmfulToWater—Materials that pose a risk to water sources if released

      • Organic—Hazardous organic compounds

      • Other—Hazardous materials not covered by other categories

      • Poison—Toxic materials

      • PoisonousInhalation—Materials that are toxic when inhaled

      • Radioactive—Materials that emit ionizing radiation

    • 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()

      Types of hazardous materials being transported. This affects which roads and tunnels can be used based on local regulations.

      • Combustible—Materials that can burn readily

      • Corrosive—Materials that can destroy or irreversibly damage other substances

      • Explosive—Materials that can produce an explosion by chemical reaction

      • Flammable—Materials that can easily ignite

      • Gas—Hazardous materials in gaseous form

      • HarmfulToWater—Materials that pose a risk to water sources if released

      • Organic—Hazardous organic compounds

      • Other—Hazardous materials not covered by other categories

      • Poison—Toxic materials

      • PoisonousInhalation—Materials that are toxic when inhaled

      • Radioactive—Materials that emit ionizing radiation

      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:
      Types of hazardous materials being transported. This affects which roads and tunnels can be used based on local regulations.

      • Combustible—Materials that can burn readily

      • Corrosive—Materials that can destroy or irreversibly damage other substances

      • Explosive—Materials that can produce an explosion by chemical reaction

      • Flammable—Materials that can easily ignite

      • Gas—Hazardous materials in gaseous form

      • HarmfulToWater—Materials that pose a risk to water sources if released

      • Organic—Hazardous organic compounds

      • Other—Hazardous materials not covered by other categories

      • Poison—Toxic materials

      • PoisonousInhalation—Materials that are toxic when inhaled

      • Radioactive—Materials that emit ionizing radiation

    • height

      public final Long height()

      The vehicle height in centimeters. Used to avoid routes with low bridges or other height restrictions.

      Unit: centimeters

      Returns:
      The vehicle height in centimeters. Used to avoid routes with low bridges or other height restrictions.

      Unit: centimeters

    • heightAboveFirstAxle

      public final Long heightAboveFirstAxle()

      The height in centimeters measured from the ground to the highest point above the first axle. Used for specific bridge and tunnel clearance restrictions.

      Unit: centimeters

      Returns:
      The height in centimeters measured from the ground to the highest point above the first axle. Used for specific bridge and tunnel clearance restrictions.

      Unit: centimeters

    • kpraLength

      public final Long kpraLength()

      The kingpin to rear axle (KPRA) length in centimeters. Used to determine if the vehicle can safely navigate turns and intersections.

      Unit: centimeters

      Returns:
      The kingpin to rear axle (KPRA) length in centimeters. Used to determine if the vehicle can safely navigate turns and intersections.

      Unit: centimeters

    • length

      public final Long length()

      The total vehicle length in centimeters. Used to avoid roads with length restrictions and determine if the vehicle can safely navigate turns.

      Unit: centimeters

      Returns:
      The total vehicle length in centimeters. Used to avoid roads with length restrictions and determine if the vehicle can safely navigate turns.

      Unit: centimeters

    • licensePlate

      public final IsolineVehicleLicensePlate licensePlate()

      License plate information used in regions where road access or routing restrictions are based on license plate numbers.

      Returns:
      License plate information used in regions where road access or routing restrictions are based on license plate numbers.

    • maxSpeed

      public final Double maxSpeed()

      The maximum speed in kilometers per hour at which the vehicle can or is permitted to travel. This affects travel time calculations and may result in different reachable areas compared to using default speed limits. Value must be between 3.6 and 252 kilometers per hour.

      Unit: kilometers per hour

      Returns:
      The maximum speed in kilometers per hour at which the vehicle can or is permitted to travel. This affects travel time calculations and may result in different reachable areas compared to using default speed limits. Value must be between 3.6 and 252 kilometers per hour.

      Unit: kilometers per hour

    • occupancy

      public final Integer occupancy()

      The number of occupants in the vehicle. This can affect route calculations by enabling the use of high-occupancy vehicle (HOV) lanes where minimum occupancy requirements are met.

      Default value: 1

      Returns:
      The number of occupants in the vehicle. This can affect route calculations by enabling the use of high-occupancy vehicle (HOV) lanes where minimum occupancy requirements are met.

      Default value: 1

    • payloadCapacity

      public final Long payloadCapacity()

      The maximum cargo weight in kilograms that the vehicle (including attached trailers) is rated to carry.

      Unit: kilograms

      Returns:
      The maximum cargo weight in kilograms that the vehicle (including attached trailers) is rated to carry.

      Unit: kilograms

    • tireCount

      public final Integer tireCount()

      The total number of tires on the vehicle.

      Returns:
      The total number of tires on the vehicle.

    • trailer

      public final IsolineTrailerOptions trailer()

      Optional specifications for attached trailers. When provided, trailer characteristics affect route calculations to ensure compliance with trailer-specific restrictions such as length limits, weight distribution requirements, and access restrictions for multi-trailer configurations.

      Returns:
      Optional specifications for attached trailers. When provided, trailer characteristics affect route calculations to ensure compliance with trailer-specific restrictions such as length limits, weight distribution requirements, and access restrictions for multi-trailer configurations.

    • truckType

      public final IsolineTruckType truckType()

      The type of truck: LightTruck for smaller delivery vehicles, StraightTruck for rigid body trucks, or Tractor for tractor-trailer combinations.

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

      Returns:
      The type of truck: LightTruck for smaller delivery vehicles, StraightTruck for rigid body trucks, or Tractor for tractor-trailer combinations.
      See Also:

    • truckTypeAsString

      public final String truckTypeAsString()

      The type of truck: LightTruck for smaller delivery vehicles, StraightTruck for rigid body trucks, or Tractor for tractor-trailer combinations.

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

      Returns:
      The type of truck: LightTruck for smaller delivery vehicles, StraightTruck for rigid body trucks, or Tractor for tractor-trailer combinations.
      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()

      The heaviest weight per axle in kilograms, regardless of axle type or grouping. Used for roads with axle-weight restrictions in regions where regulations don't distinguish between different axle configurations.

      Unit: kilograms

      Returns:
      The heaviest weight per axle in kilograms, regardless of axle type or grouping. Used for roads with axle-weight restrictions in regions where regulations don't distinguish between different axle configurations.

      Unit: kilograms

    • weightPerAxleGroup

      public final WeightPerAxleGroup weightPerAxleGroup()

      Specifies the total weight for different axle group configurations. Used in regions where regulations set different weight limits based on axle group types.

      Unit: kilograms

      Returns:
      Specifies the total weight for different axle group configurations. Used in regions where regulations set different weight limits based on axle group types.

      Unit: kilograms

    • width

      public final Long width()

      The vehicle width in centimeters. Used to avoid routes with width restrictions.

      Unit: centimeters

      Returns:
      The vehicle width in centimeters. Used to avoid routes with width restrictions.

      Unit: centimeters

    • toBuilder

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

    • builder

      public static IsolineTruckOptions.Builder builder()

    • serializableBuilderClass

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