Interface OptimizeWaypointsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<OptimizeWaypointsRequest.Builder,OptimizeWaypointsRequest>, GeoRoutesRequest.Builder, SdkBuilder<OptimizeWaypointsRequest.Builder,OptimizeWaypointsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

OptimizeWaypointsRequest

@Mutable
@NotThreadSafe
public static interface OptimizeWaypointsRequest.Builder
extends GeoRoutesRequest.Builder, SdkPojo, CopyableBuilder<OptimizeWaypointsRequest.Builder,OptimizeWaypointsRequest>

Method Summary

Modifier and Type	Method	Description
default OptimizeWaypointsRequest.Builder	avoid(Consumer<WaypointOptimizationAvoidanceOptions.Builder> avoid)	Features that are avoided.
OptimizeWaypointsRequest.Builder	avoid(WaypointOptimizationAvoidanceOptions avoid)	Features that are avoided.
default OptimizeWaypointsRequest.Builder	clustering(Consumer<WaypointOptimizationClusteringOptions.Builder> clustering)	Clustering allows you to specify how nearby waypoints can be clustered to improve the optimized sequence.
OptimizeWaypointsRequest.Builder	clustering(WaypointOptimizationClusteringOptions clustering)	Clustering allows you to specify how nearby waypoints can be clustered to improve the optimized sequence.
OptimizeWaypointsRequest.Builder	departureTime(String departureTime)	Departure time from the waypoint.
OptimizeWaypointsRequest.Builder	destination(Double... destination)	The final position for the route in the World Geodetic System (WGS 84) format: [longitude, latitude].
OptimizeWaypointsRequest.Builder	destination(Collection<Double> destination)	The final position for the route in the World Geodetic System (WGS 84) format: [longitude, latitude].
default OptimizeWaypointsRequest.Builder	destinationOptions(Consumer<WaypointOptimizationDestinationOptions.Builder> destinationOptions)	Destination related options.
OptimizeWaypointsRequest.Builder	destinationOptions(WaypointOptimizationDestinationOptions destinationOptions)	Destination related options.
default OptimizeWaypointsRequest.Builder	driver(Consumer<WaypointOptimizationDriverOptions.Builder> driver)	Driver related options.
OptimizeWaypointsRequest.Builder	driver(WaypointOptimizationDriverOptions driver)	Driver related options.
default OptimizeWaypointsRequest.Builder	exclude(Consumer<WaypointOptimizationExclusionOptions.Builder> exclude)	Features to be strictly excluded while calculating the route.
OptimizeWaypointsRequest.Builder	exclude(WaypointOptimizationExclusionOptions exclude)	Features to be strictly excluded while calculating the route.
OptimizeWaypointsRequest.Builder	key(String key)	Optional: The API key to be used for authorization.
OptimizeWaypointsRequest.Builder	optimizeSequencingFor(String optimizeSequencingFor)	Specifies the optimization criteria for the calculated sequence.
OptimizeWaypointsRequest.Builder	optimizeSequencingFor(WaypointOptimizationSequencingObjective optimizeSequencingFor)	Specifies the optimization criteria for the calculated sequence.
OptimizeWaypointsRequest.Builder	origin(Double... origin)	The start position for the route.
OptimizeWaypointsRequest.Builder	origin(Collection<Double> origin)	The start position for the route.
default OptimizeWaypointsRequest.Builder	originOptions(Consumer<WaypointOptimizationOriginOptions.Builder> originOptions)	Origin related options.
OptimizeWaypointsRequest.Builder	originOptions(WaypointOptimizationOriginOptions originOptions)	Origin related options.
OptimizeWaypointsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
OptimizeWaypointsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default OptimizeWaypointsRequest.Builder	traffic(Consumer<WaypointOptimizationTrafficOptions.Builder> traffic)	Traffic-related options.
OptimizeWaypointsRequest.Builder	traffic(WaypointOptimizationTrafficOptions traffic)	Traffic-related options.
OptimizeWaypointsRequest.Builder	travelMode(String travelMode)	Specifies the mode of transport when calculating a route.
OptimizeWaypointsRequest.Builder	travelMode(WaypointOptimizationTravelMode travelMode)	Specifies the mode of transport when calculating a route.
default OptimizeWaypointsRequest.Builder	travelModeOptions(Consumer<WaypointOptimizationTravelModeOptions.Builder> travelModeOptions)	Travel mode related options for the provided travel mode.
OptimizeWaypointsRequest.Builder	travelModeOptions(WaypointOptimizationTravelModeOptions travelModeOptions)	Travel mode related options for the provided travel mode.
OptimizeWaypointsRequest.Builder	waypoints(Collection<WaypointOptimizationWaypoint> waypoints)	List of waypoints between the Origin and Destination.
OptimizeWaypointsRequest.Builder	waypoints(Consumer<WaypointOptimizationWaypoint.Builder>... waypoints)	List of waypoints between the Origin and Destination.
OptimizeWaypointsRequest.Builder	waypoints(WaypointOptimizationWaypoint... waypoints)	List of waypoints between the Origin and Destination.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.georoutes.model.GeoRoutesRequest.Builder

build

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 Details

avoid

OptimizeWaypointsRequest.Builder avoid(WaypointOptimizationAvoidanceOptions avoid)

Features that are avoided. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, this setting is ignored.

Parameters:

avoid - Features that are avoided. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, this setting is ignored.

Returns:

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

avoid

default OptimizeWaypointsRequest.Builder avoid(Consumer<WaypointOptimizationAvoidanceOptions.Builder> avoid)

Features that are avoided. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, this setting is ignored.

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

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

Parameters:

avoid - a consumer that will call methods on WaypointOptimizationAvoidanceOptions.Builder

Returns:

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

See Also:

• avoid(WaypointOptimizationAvoidanceOptions)

clustering

OptimizeWaypointsRequest.Builder clustering(WaypointOptimizationClusteringOptions clustering)

Clustering allows you to specify how nearby waypoints can be clustered to improve the optimized sequence.

Parameters:

clustering - Clustering allows you to specify how nearby waypoints can be clustered to improve the optimized sequence.

Returns:

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

clustering

default OptimizeWaypointsRequest.Builder clustering(Consumer<WaypointOptimizationClusteringOptions.Builder> clustering)

Clustering allows you to specify how nearby waypoints can be clustered to improve the optimized sequence.

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

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

Parameters:

clustering - a consumer that will call methods on WaypointOptimizationClusteringOptions.Builder

Returns:

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

See Also:

• clustering(WaypointOptimizationClusteringOptions)

departureTime

OptimizeWaypointsRequest.Builder departureTime(String departureTime)

Departure time from the waypoint.

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

Parameters:

departureTime - Departure time from the waypoint.

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

Returns:

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

destination

OptimizeWaypointsRequest.Builder destination(Collection<Double> destination)

The final position for the route in the World Geodetic System (WGS 84) format: [longitude, latitude].

Parameters:

destination - The final position for the route in the World Geodetic System (WGS 84) format: [longitude, latitude].

Returns:

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

destination

OptimizeWaypointsRequest.Builder destination(Double... destination)

The final position for the route in the World Geodetic System (WGS 84) format: [longitude, latitude].

Parameters:

destination - The final position for the route in the World Geodetic System (WGS 84) format: [longitude, latitude].

Returns:

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

destinationOptions

OptimizeWaypointsRequest.Builder destinationOptions(WaypointOptimizationDestinationOptions destinationOptions)

Destination related options.

Parameters:

destinationOptions - Destination related options.

Returns:

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

destinationOptions

default OptimizeWaypointsRequest.Builder destinationOptions(Consumer<WaypointOptimizationDestinationOptions.Builder> destinationOptions)

Destination related options.

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

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

Parameters:

destinationOptions - a consumer that will call methods on WaypointOptimizationDestinationOptions.Builder

Returns:

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

See Also:

• destinationOptions(WaypointOptimizationDestinationOptions)

driver

OptimizeWaypointsRequest.Builder driver(WaypointOptimizationDriverOptions driver)

Driver related options.

Parameters:

driver - Driver related options.

Returns:

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

driver

default OptimizeWaypointsRequest.Builder driver(Consumer<WaypointOptimizationDriverOptions.Builder> driver)

Driver related options.

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

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

Parameters:

driver - a consumer that will call methods on WaypointOptimizationDriverOptions.Builder

Returns:

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

See Also:

• driver(WaypointOptimizationDriverOptions)

exclude

OptimizeWaypointsRequest.Builder exclude(WaypointOptimizationExclusionOptions exclude)

Features to be strictly excluded while calculating the route.

Parameters:

exclude - Features to be strictly excluded while calculating the route.

Returns:

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

exclude

default OptimizeWaypointsRequest.Builder exclude(Consumer<WaypointOptimizationExclusionOptions.Builder> exclude)

Features to be strictly excluded while calculating the route.

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

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

Parameters:

exclude - a consumer that will call methods on WaypointOptimizationExclusionOptions.Builder

Returns:

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

See Also:

• exclude(WaypointOptimizationExclusionOptions)

key

OptimizeWaypointsRequest.Builder key(String key)

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

Parameters:

key - Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

Returns:

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

optimizeSequencingFor

OptimizeWaypointsRequest.Builder optimizeSequencingFor(String optimizeSequencingFor)

Specifies the optimization criteria for the calculated sequence.

Default Value: FastestRoute.

Parameters:

optimizeSequencingFor - Specifies the optimization criteria for the calculated sequence.

Default Value: FastestRoute.

Returns:

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

See Also:

• WaypointOptimizationSequencingObjective
• WaypointOptimizationSequencingObjective

optimizeSequencingFor

OptimizeWaypointsRequest.Builder optimizeSequencingFor(WaypointOptimizationSequencingObjective optimizeSequencingFor)

Specifies the optimization criteria for the calculated sequence.

Default Value: FastestRoute.

Parameters:

optimizeSequencingFor - Specifies the optimization criteria for the calculated sequence.

Default Value: FastestRoute.

Returns:

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

See Also:

• WaypointOptimizationSequencingObjective
• WaypointOptimizationSequencingObjective

origin

OptimizeWaypointsRequest.Builder origin(Collection<Double> origin)

The start position for the route.

Parameters:

origin - The start position for the route.

Returns:

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

origin

OptimizeWaypointsRequest.Builder origin(Double... origin)

The start position for the route.

Parameters:

origin - The start position for the route.

Returns:

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

originOptions

OptimizeWaypointsRequest.Builder originOptions(WaypointOptimizationOriginOptions originOptions)

Origin related options.

Parameters:

originOptions - Origin related options.

Returns:

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

originOptions

default OptimizeWaypointsRequest.Builder originOptions(Consumer<WaypointOptimizationOriginOptions.Builder> originOptions)

Origin related options.

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

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

Parameters:

originOptions - a consumer that will call methods on WaypointOptimizationOriginOptions.Builder

Returns:

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

See Also:

• originOptions(WaypointOptimizationOriginOptions)

traffic

OptimizeWaypointsRequest.Builder traffic(WaypointOptimizationTrafficOptions traffic)

Traffic-related options.

Parameters:

traffic - Traffic-related options.

Returns:

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

traffic

default OptimizeWaypointsRequest.Builder traffic(Consumer<WaypointOptimizationTrafficOptions.Builder> traffic)

Traffic-related options.

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

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

Parameters:

traffic - a consumer that will call methods on WaypointOptimizationTrafficOptions.Builder

Returns:

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

See Also:

• traffic(WaypointOptimizationTrafficOptions)

travelMode

OptimizeWaypointsRequest.Builder travelMode(String travelMode)

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

Default Value: Car

Parameters:

travelMode - Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

Default Value: Car

Returns:

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

See Also:

• WaypointOptimizationTravelMode
• WaypointOptimizationTravelMode

travelMode

OptimizeWaypointsRequest.Builder travelMode(WaypointOptimizationTravelMode travelMode)

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

Default Value: Car

Parameters:

travelMode - Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

Default Value: Car

Returns:

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

See Also:

• WaypointOptimizationTravelMode
• WaypointOptimizationTravelMode

travelModeOptions

OptimizeWaypointsRequest.Builder travelModeOptions(WaypointOptimizationTravelModeOptions travelModeOptions)

Travel mode related options for the provided travel mode.

Parameters:

travelModeOptions - Travel mode related options for the provided travel mode.

Returns:

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

travelModeOptions

default OptimizeWaypointsRequest.Builder travelModeOptions(Consumer<WaypointOptimizationTravelModeOptions.Builder> travelModeOptions)

Travel mode related options for the provided travel mode.

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

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

Parameters:

travelModeOptions - a consumer that will call methods on WaypointOptimizationTravelModeOptions.Builder

Returns:

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

See Also:

• travelModeOptions(WaypointOptimizationTravelModeOptions)

waypoints

OptimizeWaypointsRequest.Builder waypoints(Collection<WaypointOptimizationWaypoint> waypoints)

List of waypoints between the Origin and Destination.

Parameters:

waypoints - List of waypoints between the Origin and Destination.

Returns:

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

waypoints

OptimizeWaypointsRequest.Builder waypoints(WaypointOptimizationWaypoint... waypoints)

List of waypoints between the Origin and Destination.

Parameters:

waypoints - List of waypoints between the Origin and Destination.

Returns:

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

waypoints

OptimizeWaypointsRequest.Builder waypoints(Consumer<WaypointOptimizationWaypoint.Builder>... waypoints)

List of waypoints between the Origin and Destination.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to waypoints(List<WaypointOptimizationWaypoint>).

Parameters:

waypoints - a consumer that will call methods on WaypointOptimizationWaypoint.Builder

Returns:

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

See Also:

• waypoints(java.util.Collection<WaypointOptimizationWaypoint>)

overrideConfiguration

OptimizeWaypointsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

OptimizeWaypointsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.