Class RouteViolatedConstraints

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

This property contains a summary of violated constraints.

See Also:

  • Method Details

    • allHazardsRestricted

      public final Boolean allHazardsRestricted()

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

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

    • axleCount

      public final RouteNoticeDetailRange axleCount()

      Total number of axles of the vehicle.

      Returns:
      Total number of axles of the vehicle.

    • hazardousCargos

      public final List<RouteHazardousCargoType> hazardousCargos()

      List of Hazardous cargo contained in the vehicle.

      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:
      List of Hazardous cargo contained in the vehicle.

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

      List of Hazardous cargo contained in the vehicle.

      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:
      List of Hazardous cargo contained in the vehicle.

    • maxHeight

      public final Long maxHeight()

      The maximum height of the vehicle.

      Returns:
      The maximum height of the vehicle.

    • maxKpraLength

      public final Long maxKpraLength()

      The maximum Kpra length of the vehicle.

      Unit: centimeters

      Returns:
      The maximum Kpra length of the vehicle.

      Unit: centimeters

    • maxLength

      public final Long maxLength()

      The maximum length of the vehicle.

      Returns:
      The maximum length of the vehicle.

    • maxPayloadCapacity

      public final Long maxPayloadCapacity()

      The maximum load capacity of the vehicle.

      Unit: kilograms

      Returns:
      The maximum load capacity of the vehicle.

      Unit: kilograms

    • maxWeight

      public final RouteWeightConstraint maxWeight()

      The maximum weight of the route.

      Unit: Kilograms

      Returns:
      The maximum weight of the route.

      Unit: Kilograms

    • maxWeightPerAxle

      public final Long maxWeightPerAxle()

      The maximum weight per axle of the vehicle.

      Unit: Kilograms

      Returns:
      The maximum weight per axle of the vehicle.

      Unit: Kilograms

    • maxWeightPerAxleGroup

      public final WeightPerAxleGroup maxWeightPerAxleGroup()

      The maximum weight per axle group of the vehicle.

      Unit: Kilograms

      Returns:
      The maximum weight per axle group of the vehicle.

      Unit: Kilograms

    • maxWidth

      public final Long maxWidth()

      The maximum width of the vehicle.

      Returns:
      The maximum width of the vehicle.

    • occupancy

      public final RouteNoticeDetailRange occupancy()

      The number of occupants in the vehicle.

      Default Value: 1

      Returns:
      The number of occupants in the vehicle.

      Default Value: 1

    • restrictedTimes

      public final String restrictedTimes()

      Access radius restrictions based on time.

      Returns:
      Access radius restrictions based on time.

    • timeDependent

      public final Boolean timeDependent()

      The time dependent constraint.

      Returns:
      The time dependent constraint.

    • trailerCount

      public final RouteNoticeDetailRange trailerCount()

      Number of trailers attached to the vehicle.

      Default Value: 0

      Returns:
      Number of trailers attached to the vehicle.

      Default Value: 0

    • travelMode

      public final Boolean travelMode()

      Travel mode corresponding to the leg.

      Returns:
      Travel mode corresponding to the leg.

    • truckRoadType

      public final 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.

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

    • truckType

      public final RouteTruckType truckType()

      Type of the truck.

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

      Returns:
      Type of the truck.
      See Also:

    • truckTypeAsString

      public final String truckTypeAsString()

      Type of the truck.

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

      Returns:
      Type of the truck.
      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

    • toBuilder

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

    • builder

      public static RouteViolatedConstraints.Builder builder()

    • serializableBuilderClass

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