Interface RouteMatrixTruckOptions.Builder

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

  • Method Details

    • axleCount

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

    • grossWeight

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

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

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

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

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

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

    • kpraLength

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

      RouteMatrixTruckOptions.Builder length(Long length)

      Length of the vehicle.

      Unit: centimeters

      Parameters:
      length - Length of the vehicle.

      Unit: centimeters

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

    • licensePlate

      RouteMatrixTruckOptions.Builder licensePlate(RouteMatrixVehicleLicensePlate 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 RouteMatrixTruckOptions.Builder licensePlate(Consumer<RouteMatrixVehicleLicensePlate.Builder> licensePlate)

      The vehicle License Plate.

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

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

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

    • maxSpeed

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

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

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

    • trailer

      RouteMatrixTruckOptions.Builder trailer(RouteMatrixTrailerOptions 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 RouteMatrixTruckOptions.Builder trailer(Consumer<RouteMatrixTrailerOptions.Builder> trailer)

      Trailer options corresponding to the vehicle.

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

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

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

    • truckType

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

      RouteMatrixTruckOptions.Builder truckType(RouteMatrixTruckType 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

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

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

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

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

    • weightPerAxleGroup

      default RouteMatrixTruckOptions.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.

      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

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