Class RouteAvoidanceOptions

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

Specifies options for areas to avoid when calculating the route. This is a best-effort avoidance setting, meaning the router will try to honor the avoidance preferences but may still include restricted areas if no feasible alternative route exists. If avoidance options are not followed, the response will indicate that the avoidance criteria were violated.

See Also:

  • Method Details

    • hasAreas

      public final boolean hasAreas()
      For responses, this returns true if the service returned a value for the Areas 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.

    • areas

      public final List<RouteAvoidanceArea> areas()

      Areas to be avoided.

      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 hasAreas() method.

      Returns:
      Areas to be avoided.

    • carShuttleTrains

      public final Boolean carShuttleTrains()

      Avoid car-shuttle-trains while calculating the route.

      Returns:
      Avoid car-shuttle-trains while calculating the route.

    • controlledAccessHighways

      public final Boolean controlledAccessHighways()

      Avoid controlled access highways while calculating the route.

      Returns:
      Avoid controlled access highways while calculating the route.

    • dirtRoads

      public final Boolean dirtRoads()

      Avoid dirt roads while calculating the route.

      Returns:
      Avoid dirt roads while calculating the route.

    • ferries

      public final Boolean ferries()

      Avoid ferries while calculating the route.

      Returns:
      Avoid ferries while calculating the route.

    • seasonalClosure

      public final Boolean seasonalClosure()

      Avoid roads that have seasonal closure while calculating the route.

      Returns:
      Avoid roads that have seasonal closure while calculating the route.

    • tollRoads

      public final Boolean tollRoads()

      Avoids roads where the specified toll transponders are the only mode of payment.

      Returns:
      Avoids roads where the specified toll transponders are the only mode of payment.

    • tollTransponders

      public final Boolean tollTransponders()

      Avoids roads where the specified toll transponders are the only mode of payment.

      Returns:
      Avoids roads where the specified toll transponders are the only mode of payment.

    • hasTruckRoadTypes

      public final boolean hasTruckRoadTypes()
      For responses, this returns true if the service returned a value for the TruckRoadTypes 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.

    • truckRoadTypes

      public final List<String> truckRoadTypes()

      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.

      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 hasTruckRoadTypes() method.

      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.

    • tunnels

      public final Boolean tunnels()

      Avoid tunnels while calculating the route.

      Returns:
      Avoid tunnels while calculating the route.

    • uTurns

      public final Boolean uTurns()

      Avoid U-turns for calculation on highways and motorways.

      Returns:
      Avoid U-turns for calculation on highways and motorways.

    • hasZoneCategories

      public final boolean hasZoneCategories()
      For responses, this returns true if the service returned a value for the ZoneCategories 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.

    • zoneCategories

      public final List<RouteAvoidanceZoneCategory> zoneCategories()

      Zone categories to be avoided.

      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 hasZoneCategories() method.

      Returns:
      Zone categories to be avoided.

    • toBuilder

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

    • builder

      public static RouteAvoidanceOptions.Builder builder()

    • serializableBuilderClass

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