Interface RouteViolatedConstraints.Builder

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

  • Method Details

    • allHazardsRestricted

      RouteViolatedConstraints.Builder allHazardsRestricted(Boolean allHazardsRestricted)

      This restriction applies to truck cargo, where the resulting route excludes roads on which hazardous materials are prohibited from being transported.

      Parameters:
      allHazardsRestricted - This restriction applies to truck cargo, where the resulting route excludes roads on which hazardous materials are prohibited from being transported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • axleCount

      RouteViolatedConstraints.Builder axleCount(RouteNoticeDetailRange 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.

    • axleCount

      default RouteViolatedConstraints.Builder axleCount(Consumer<RouteNoticeDetailRange.Builder> axleCount)

      Total number of axles of the vehicle.

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

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

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

    • hazardousCargosWithStrings

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

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

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

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

    • maxHeight

      RouteViolatedConstraints.Builder maxHeight(Long maxHeight)

      The maximum height of the vehicle.

      Parameters:
      maxHeight - The maximum height of the vehicle.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxKpraLength

      RouteViolatedConstraints.Builder maxKpraLength(Long maxKpraLength)

      The maximum Kpra length of the vehicle.

      Unit: centimeters

      Parameters:
      maxKpraLength - The maximum Kpra length of the vehicle.

      Unit: centimeters

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

    • maxLength

      RouteViolatedConstraints.Builder maxLength(Long maxLength)

      The maximum length of the vehicle.

      Parameters:
      maxLength - The maximum length of the vehicle.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxPayloadCapacity

      RouteViolatedConstraints.Builder maxPayloadCapacity(Long maxPayloadCapacity)

      The maximum load capacity of the vehicle.

      Unit: kilograms

      Parameters:
      maxPayloadCapacity - The maximum load capacity of the vehicle.

      Unit: kilograms

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

    • maxWeight

      RouteViolatedConstraints.Builder maxWeight(RouteWeightConstraint maxWeight)

      The maximum weight of the route.

      Unit: Kilograms

      Parameters:
      maxWeight - The maximum weight of the route.

      Unit: Kilograms

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

    • maxWeight

      default RouteViolatedConstraints.Builder maxWeight(Consumer<RouteWeightConstraint.Builder> maxWeight)

      The maximum weight of the route.

      Unit: Kilograms

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

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

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

    • maxWeightPerAxle

      RouteViolatedConstraints.Builder maxWeightPerAxle(Long maxWeightPerAxle)

      The maximum weight per axle of the vehicle.

      Unit: Kilograms

      Parameters:
      maxWeightPerAxle - The maximum weight per axle of the vehicle.

      Unit: Kilograms

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

    • maxWeightPerAxleGroup

      RouteViolatedConstraints.Builder maxWeightPerAxleGroup(WeightPerAxleGroup maxWeightPerAxleGroup)

      The maximum weight per axle group of the vehicle.

      Unit: Kilograms

      Parameters:
      maxWeightPerAxleGroup - The maximum weight per axle group of the vehicle.

      Unit: Kilograms

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

    • maxWeightPerAxleGroup

      default RouteViolatedConstraints.Builder maxWeightPerAxleGroup(Consumer<WeightPerAxleGroup.Builder> maxWeightPerAxleGroup)

      The maximum weight per axle group of the vehicle.

      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 maxWeightPerAxleGroup(WeightPerAxleGroup).

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

    • maxWidth

      RouteViolatedConstraints.Builder maxWidth(Long maxWidth)

      The maximum width of the vehicle.

      Parameters:
      maxWidth - The maximum width of the vehicle.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • occupancy

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

    • occupancy

      default RouteViolatedConstraints.Builder occupancy(Consumer<RouteNoticeDetailRange.Builder> occupancy)

      The number of occupants in the vehicle.

      Default Value: 1

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

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

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

    • restrictedTimes

      RouteViolatedConstraints.Builder restrictedTimes(String restrictedTimes)

      Access radius restrictions based on time.

      Parameters:
      restrictedTimes - Access radius restrictions based on time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timeDependent

      RouteViolatedConstraints.Builder timeDependent(Boolean timeDependent)

      The time dependent constraint.

      Parameters:
      timeDependent - The time dependent constraint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • trailerCount

      RouteViolatedConstraints.Builder trailerCount(RouteNoticeDetailRange trailerCount)

      Number of trailers attached to the vehicle.

      Default Value: 0

      Parameters:
      trailerCount - Number of trailers attached to the vehicle.

      Default Value: 0

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

    • trailerCount

      default RouteViolatedConstraints.Builder trailerCount(Consumer<RouteNoticeDetailRange.Builder> trailerCount)

      Number of trailers attached to the vehicle.

      Default Value: 0

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

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

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

    • travelMode

      RouteViolatedConstraints.Builder travelMode(Boolean travelMode)

      Travel mode corresponding to the leg.

      Parameters:
      travelMode - Travel mode corresponding to the leg.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • truckRoadType

      RouteViolatedConstraints.Builder truckRoadType(String truckRoadType)

      Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.

      There are currently no other supported values as of 26th April 2024.

      Parameters:
      truckRoadType - Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.

      There are currently no other supported values as of 26th April 2024.

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

    • truckType

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

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

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