Interface RouteTruckOptions.Builder

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

  • Method Details

    • axleCount

      RouteTruckOptions.Builder axleCount(Integer axleCount)

      Total number of axles of the vehicle.

      Parameters:
      axleCount - Total number of axles of the vehicle.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • engineType

      RouteTruckOptions.Builder engineType(String engineType)

      Engine type of the vehicle.

      Parameters:
      engineType - Engine type of the vehicle.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • engineType

      RouteTruckOptions.Builder engineType(RouteEngineType engineType)

      Engine type of the vehicle.

      Parameters:
      engineType - Engine type of the vehicle.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • grossWeight

      RouteTruckOptions.Builder grossWeight(Long grossWeight)

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

      Unit: Kilograms

      Parameters:
      grossWeight - Gross weight of the vehicle including trailers, and goods at capacity.

      Unit: Kilograms

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

    • hazardousCargosWithStrings

      RouteTruckOptions.Builder hazardousCargosWithStrings(Collection<String> hazardousCargos)

      List of Hazardous cargo contained in the vehicle.

      Parameters:
      hazardousCargos - List of Hazardous cargo contained in the vehicle.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hazardousCargosWithStrings

      RouteTruckOptions.Builder hazardousCargosWithStrings(String... hazardousCargos)

      List of Hazardous cargo contained in the vehicle.

      Parameters:
      hazardousCargos - List of Hazardous cargo contained in the vehicle.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hazardousCargos

      RouteTruckOptions.Builder hazardousCargos(Collection<RouteHazardousCargoType> hazardousCargos)

      List of Hazardous cargo contained in the vehicle.

      Parameters:
      hazardousCargos - List of Hazardous cargo contained in the vehicle.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hazardousCargos

      RouteTruckOptions.Builder hazardousCargos(RouteHazardousCargoType... hazardousCargos)

      List of Hazardous cargo contained in the vehicle.

      Parameters:
      hazardousCargos - List of Hazardous cargo contained in the vehicle.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • height

      RouteTruckOptions.Builder height(Long height)

      Height of the vehicle.

      Unit: centimeters

      Parameters:
      height - Height of the vehicle.

      Unit: centimeters

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

    • heightAboveFirstAxle

      RouteTruckOptions.Builder heightAboveFirstAxle(Long heightAboveFirstAxle)

      Height of the vehicle above its first axle.

      Unit: centimeters

      Parameters:
      heightAboveFirstAxle - Height of the vehicle above its first axle.

      Unit: centimeters

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

    • kpraLength

      RouteTruckOptions.Builder kpraLength(Long kpraLength)

      Kingpin to rear axle length of the vehicle.

      Unit: centimeters

      Parameters:
      kpraLength - Kingpin to rear axle length of the vehicle.

      Unit: centimeters

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

    • length

      RouteTruckOptions.Builder length(Long length)

      Length of the vehicle.

      Unit: c

      Parameters:
      length - Length of the vehicle.

      Unit: c

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

    • licensePlate

      RouteTruckOptions.Builder licensePlate(RouteVehicleLicensePlate licensePlate)

      The vehicle License Plate.

      Parameters:
      licensePlate - The vehicle License Plate.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • licensePlate

      default RouteTruckOptions.Builder licensePlate(Consumer<RouteVehicleLicensePlate.Builder> licensePlate)

      The vehicle License Plate.

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

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

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

    • maxSpeed

      RouteTruckOptions.Builder maxSpeed(Double maxSpeed)

      Maximum speed

      Unit: KilometersPerHour

      Parameters:
      maxSpeed - Maximum speed

      Unit: KilometersPerHour

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

    • occupancy

      RouteTruckOptions.Builder occupancy(Integer occupancy)

      The number of occupants in the vehicle.

      Default Value: 1

      Parameters:
      occupancy - The number of occupants in the vehicle.

      Default Value: 1

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

    • payloadCapacity

      RouteTruckOptions.Builder payloadCapacity(Long payloadCapacity)

      Payload capacity of the vehicle and trailers attached.

      Unit: kilograms

      Parameters:
      payloadCapacity - Payload capacity of the vehicle and trailers attached.

      Unit: kilograms

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

    • tireCount

      RouteTruckOptions.Builder tireCount(Integer tireCount)

      Number of tires on the vehicle.

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

    • trailer

      RouteTruckOptions.Builder trailer(RouteTrailerOptions trailer)

      Trailer options corresponding to the vehicle.

      Parameters:
      trailer - Trailer options corresponding to the vehicle.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • trailer

      default RouteTruckOptions.Builder trailer(Consumer<RouteTrailerOptions.Builder> trailer)

      Trailer options corresponding to the vehicle.

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

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

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

    • truckType

      RouteTruckOptions.Builder truckType(String truckType)

      Type of the truck.

      Parameters:
      truckType - Type of the truck.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • truckType

      RouteTruckOptions.Builder truckType(RouteTruckType truckType)

      Type of the truck.

      Parameters:
      truckType - Type of the truck.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tunnelRestrictionCode

      RouteTruckOptions.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

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

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

    • weightPerAxleGroup

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

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

    • weightPerAxleGroup

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

      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

      RouteTruckOptions.Builder width(Long width)

      Width of the vehicle.

      Unit: centimeters

      Parameters:
      width - Width of the vehicle.

      Unit: centimeters

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