Interface IsolineTruckOptions.Builder

All Superinterfaces:
Buildable, CopyableBuilder<IsolineTruckOptions.Builder,IsolineTruckOptions>, SdkBuilder<IsolineTruckOptions.Builder,IsolineTruckOptions>, SdkPojo
Enclosing class:
IsolineTruckOptions
@Mutable @NotThreadSafe public static interface IsolineTruckOptions.Builder extends SdkPojo, CopyableBuilder<IsolineTruckOptions.Builder,IsolineTruckOptions>

  • Method Details

    • axleCount

      IsolineTruckOptions.Builder axleCount(Integer axleCount)

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

      Parameters:
      axleCount - The total number of axles on the vehicle. Required for certain road restrictions and weight limit calculations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • engineType

      IsolineTruckOptions.Builder engineType(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • engineType

      IsolineTruckOptions.Builder engineType(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • grossWeight

      IsolineTruckOptions.Builder grossWeight(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • hazardousCargosWithStrings

      IsolineTruckOptions.Builder hazardousCargosWithStrings(Collection<String> 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

      Parameters:
      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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hazardousCargosWithStrings

      IsolineTruckOptions.Builder hazardousCargosWithStrings(String... 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

      Parameters:
      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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hazardousCargos

      IsolineTruckOptions.Builder hazardousCargos(Collection<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

      Parameters:
      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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hazardousCargos

      IsolineTruckOptions.Builder hazardousCargos(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

      Parameters:
      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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • height

      IsolineTruckOptions.Builder height(Long height)

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

      Unit: centimeters

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

      Unit: centimeters

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • heightAboveFirstAxle

      IsolineTruckOptions.Builder heightAboveFirstAxle(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • kpraLength

      IsolineTruckOptions.Builder kpraLength(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • length

      IsolineTruckOptions.Builder length(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • licensePlate

      IsolineTruckOptions.Builder licensePlate(IsolineVehicleLicensePlate licensePlate)

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

      Parameters:
      licensePlate - License plate information used in regions where road access or routing restrictions are based on license plate numbers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • licensePlate

      default IsolineTruckOptions.Builder licensePlate(Consumer<IsolineVehicleLicensePlate.Builder> licensePlate)

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

      This is a convenience method that creates an instance of the IsolineVehicleLicensePlate.Builder avoiding the need to create one manually via IsolineVehicleLicensePlate.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to licensePlate(IsolineVehicleLicensePlate).

      Parameters:
      licensePlate - a consumer that will call methods on IsolineVehicleLicensePlate.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxSpeed

      IsolineTruckOptions.Builder maxSpeed(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • occupancy

      IsolineTruckOptions.Builder occupancy(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • payloadCapacity

      IsolineTruckOptions.Builder payloadCapacity(Long payloadCapacity)

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

      Unit: kilograms

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

      Unit: kilograms

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tireCount

      IsolineTruckOptions.Builder tireCount(Integer tireCount)

      The total number of tires on the vehicle.

      Parameters:
      tireCount - The total number of tires on the vehicle.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • trailer

      IsolineTruckOptions.Builder trailer(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • trailer

      default IsolineTruckOptions.Builder trailer(Consumer<IsolineTrailerOptions.Builder> 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.

      This is a convenience method that creates an instance of the IsolineTrailerOptions.Builder avoiding the need to create one manually via IsolineTrailerOptions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to trailer(IsolineTrailerOptions).

      Parameters:
      trailer - a consumer that will call methods on IsolineTrailerOptions.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • truckType

      IsolineTruckOptions.Builder truckType(String truckType)

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

      Parameters:
      truckType - The type of truck: LightTruck for smaller delivery vehicles, StraightTruck for rigid body trucks, or Tractor for tractor-trailer combinations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • truckType

      IsolineTruckOptions.Builder truckType(IsolineTruckType truckType)

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

      Parameters:
      truckType - The type of truck: LightTruck for smaller delivery vehicles, StraightTruck for rigid body trucks, or Tractor for tractor-trailer combinations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tunnelRestrictionCode

      IsolineTruckOptions.Builder tunnelRestrictionCode(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • weightPerAxle

      IsolineTruckOptions.Builder weightPerAxle(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • weightPerAxleGroup

      IsolineTruckOptions.Builder weightPerAxleGroup(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • weightPerAxleGroup

      default IsolineTruckOptions.Builder weightPerAxleGroup(Consumer<WeightPerAxleGroup.Builder> 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

      This is a convenience method that creates an instance of the WeightPerAxleGroup.Builder avoiding the need to create one manually via WeightPerAxleGroup.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to weightPerAxleGroup(WeightPerAxleGroup).

      Parameters:
      weightPerAxleGroup - a consumer that will call methods on WeightPerAxleGroup.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • width

      IsolineTruckOptions.Builder width(Long width)

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

      Unit: centimeters

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

      Unit: centimeters

      Returns:
      Returns a reference to this object so that method calls can be chained together.