Package software.amazon.awssdk.services.georoutes.model

Interface RouteAvoidanceOptions.Builder

All Superinterfaces:

Buildable, CopyableBuilder<RouteAvoidanceOptions.Builder,RouteAvoidanceOptions>, SdkBuilder<RouteAvoidanceOptions.Builder,RouteAvoidanceOptions>, SdkPojo

Enclosing class:

RouteAvoidanceOptions

public static interface RouteAvoidanceOptions.Builder
extends SdkPojo, CopyableBuilder<RouteAvoidanceOptions.Builder,RouteAvoidanceOptions>

Method Summary

Modifier and Type	Method	Description
RouteAvoidanceOptions.Builder	areas(Collection<RouteAvoidanceArea> areas)	Areas to be avoided.
RouteAvoidanceOptions.Builder	areas(Consumer<RouteAvoidanceArea.Builder>... areas)	Areas to be avoided.
RouteAvoidanceOptions.Builder	areas(RouteAvoidanceArea... areas)	Areas to be avoided.
RouteAvoidanceOptions.Builder	carShuttleTrains(Boolean carShuttleTrains)	Avoid car-shuttle-trains while calculating the route.
RouteAvoidanceOptions.Builder	controlledAccessHighways(Boolean controlledAccessHighways)	Avoid controlled access highways while calculating the route.
RouteAvoidanceOptions.Builder	dirtRoads(Boolean dirtRoads)	Avoid dirt roads while calculating the route.
RouteAvoidanceOptions.Builder	ferries(Boolean ferries)	Avoid ferries while calculating the route.
RouteAvoidanceOptions.Builder	seasonalClosure(Boolean seasonalClosure)	Avoid roads that have seasonal closure while calculating the route.
RouteAvoidanceOptions.Builder	tollRoads(Boolean tollRoads)	Avoids roads where the specified toll transponders are the only mode of payment.
RouteAvoidanceOptions.Builder	tollTransponders(Boolean tollTransponders)	Avoids roads where the specified toll transponders are the only mode of payment.
RouteAvoidanceOptions.Builder	truckRoadTypes(String... truckRoadTypes)	Truck road type identifiers.
RouteAvoidanceOptions.Builder	truckRoadTypes(Collection<String> truckRoadTypes)	Truck road type identifiers.
RouteAvoidanceOptions.Builder	tunnels(Boolean tunnels)	Avoid tunnels while calculating the route.
RouteAvoidanceOptions.Builder	uTurns(Boolean uTurns)	Avoid U-turns for calculation on highways and motorways.
RouteAvoidanceOptions.Builder	zoneCategories(Collection<RouteAvoidanceZoneCategory> zoneCategories)	Zone categories to be avoided.
RouteAvoidanceOptions.Builder	zoneCategories(Consumer<RouteAvoidanceZoneCategory.Builder>... zoneCategories)	Zone categories to be avoided.
RouteAvoidanceOptions.Builder	zoneCategories(RouteAvoidanceZoneCategory... zoneCategories)	Zone categories to be avoided.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

areas

RouteAvoidanceOptions.Builder areas(Collection<RouteAvoidanceArea> areas)

Areas to be avoided.

Parameters:

areas - Areas to be avoided.

Returns:

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

areas

RouteAvoidanceOptions.Builder areas(RouteAvoidanceArea... areas)

Areas to be avoided.

Parameters:

areas - Areas to be avoided.

Returns:

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

areas

RouteAvoidanceOptions.Builder areas(Consumer<RouteAvoidanceArea.Builder>... areas)

Areas to be avoided.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #areas(List).

Parameters:

areas - a consumer that will call methods on RouteAvoidanceArea.Builder

Returns:

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

See Also:

#areas(java.util.Collection)

carShuttleTrains

RouteAvoidanceOptions.Builder carShuttleTrains(Boolean carShuttleTrains)

Avoid car-shuttle-trains while calculating the route.

Parameters:

carShuttleTrains - Avoid car-shuttle-trains while calculating the route.

Returns:

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

controlledAccessHighways

RouteAvoidanceOptions.Builder controlledAccessHighways(Boolean controlledAccessHighways)

Avoid controlled access highways while calculating the route.

Parameters:

controlledAccessHighways - Avoid controlled access highways while calculating the route.

Returns:

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

dirtRoads

RouteAvoidanceOptions.Builder dirtRoads(Boolean dirtRoads)

Avoid dirt roads while calculating the route.

Parameters:

dirtRoads - Avoid dirt roads while calculating the route.

Returns:

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

ferries

RouteAvoidanceOptions.Builder ferries(Boolean ferries)

Avoid ferries while calculating the route.

Parameters:

ferries - Avoid ferries while calculating the route.

Returns:

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

seasonalClosure

RouteAvoidanceOptions.Builder seasonalClosure(Boolean seasonalClosure)

Avoid roads that have seasonal closure while calculating the route.

Parameters:

seasonalClosure - Avoid roads that have seasonal closure while calculating the route.

Returns:

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

tollRoads

RouteAvoidanceOptions.Builder tollRoads(Boolean tollRoads)

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

Parameters:

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

Returns:

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

tollTransponders

RouteAvoidanceOptions.Builder tollTransponders(Boolean tollTransponders)

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

Parameters:

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

Returns:

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

truckRoadTypes

RouteAvoidanceOptions.Builder truckRoadTypes(Collection<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.

Parameters:

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.

Returns:

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

truckRoadTypes

RouteAvoidanceOptions.Builder truckRoadTypes(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.

Parameters:

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.

Returns:

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

tunnels

RouteAvoidanceOptions.Builder tunnels(Boolean tunnels)

Avoid tunnels while calculating the route.

Parameters:

tunnels - Avoid tunnels while calculating the route.

Returns:

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

uTurns

RouteAvoidanceOptions.Builder uTurns(Boolean uTurns)

Avoid U-turns for calculation on highways and motorways.

Parameters:

uTurns - Avoid U-turns for calculation on highways and motorways.

Returns:

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

zoneCategories

RouteAvoidanceOptions.Builder zoneCategories(Collection<RouteAvoidanceZoneCategory> zoneCategories)

Zone categories to be avoided.

Parameters:

zoneCategories - Zone categories to be avoided.

Returns:

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

zoneCategories

RouteAvoidanceOptions.Builder zoneCategories(RouteAvoidanceZoneCategory... zoneCategories)

Zone categories to be avoided.

Parameters:

zoneCategories - Zone categories to be avoided.

Returns:

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

zoneCategories

RouteAvoidanceOptions.Builder zoneCategories(Consumer<RouteAvoidanceZoneCategory.Builder>... zoneCategories)

Zone categories to be avoided.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #zoneCategories(List).

Parameters:

zoneCategories - a consumer that will call methods on RouteAvoidanceZoneCategory.Builder

Returns:

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

See Also:

#zoneCategories(java.util.Collection)