Class IsolineAvoidanceOptions
- java.lang.Object
-
- software.amazon.awssdk.services.georoutes.model.IsolineAvoidanceOptions
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<IsolineAvoidanceOptions.Builder,IsolineAvoidanceOptions>
@Generated("software.amazon.awssdk:codegen") public final class IsolineAvoidanceOptions extends Object implements SdkPojo, Serializable, ToCopyableBuilder<IsolineAvoidanceOptions.Builder,IsolineAvoidanceOptions>
Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceIsolineAvoidanceOptions.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<IsolineAvoidanceArea>areas()Areas to be avoided.static IsolineAvoidanceOptions.Builderbuilder()BooleancarShuttleTrains()Avoid car-shuttle-trains while calculating the route.BooleancontrolledAccessHighways()Avoid controlled access highways while calculating the route.BooleandirtRoads()Avoid dirt roads while calculating the route.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)Booleanferries()Avoid ferries while calculating the route.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAreas()For responses, this returns true if the service returned a value for the Areas property.inthashCode()booleanhasTruckRoadTypes()For responses, this returns true if the service returned a value for the TruckRoadTypes property.booleanhasZoneCategories()For responses, this returns true if the service returned a value for the ZoneCategories property.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()BooleanseasonalClosure()Avoid roads that have seasonal closure while calculating the route.static Class<? extends IsolineAvoidanceOptions.Builder>serializableBuilderClass()IsolineAvoidanceOptions.BuildertoBuilder()BooleantollRoads()Avoids roads where the specified toll transponders are the only mode of payment.BooleantollTransponders()Avoids roads where the specified toll transponders are the only mode of payment.StringtoString()Returns a string representation of this object.List<String>truckRoadTypes()Truck road type identifiers.Booleantunnels()Avoid tunnels while calculating the route.BooleanuTurns()Avoid U-turns for calculation on highways and motorways.List<IsolineAvoidanceZoneCategory>zoneCategories()Zone categories to be avoided.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 theisEmpty()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<IsolineAvoidanceArea> 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 theisEmpty()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.
BK1throughBK4apply only to Sweden.A2,A4,B2,B4,C,D,ET2,ET4apply 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.
BK1throughBK4apply only to Sweden.A2,A4,B2,B4,C,D,ET2,ET4apply 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 theisEmpty()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<IsolineAvoidanceZoneCategory> 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 IsolineAvoidanceOptions.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<IsolineAvoidanceOptions.Builder,IsolineAvoidanceOptions>
-
builder
public static IsolineAvoidanceOptions.Builder builder()
-
serializableBuilderClass
public static Class<? extends IsolineAvoidanceOptions.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-