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

Interface RouteWaypoint.Builder

All Superinterfaces:

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

Enclosing class:

RouteWaypoint

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

Method Summary

Modifier and Type	Method	Description
RouteWaypoint.Builder	avoidActionsForDistance(Long avoidActionsForDistance)	Avoids actions for the provided distance.
RouteWaypoint.Builder	avoidUTurns(Boolean avoidUTurns)	Avoid U-turns for calculation on highways and motorways.
RouteWaypoint.Builder	heading(Double heading)	GPS Heading at the position.
default RouteWaypoint.Builder	matching(Consumer<RouteMatchingOptions.Builder> matching)	Options to configure matching the provided position to the road network.
RouteWaypoint.Builder	matching(RouteMatchingOptions matching)	Options to configure matching the provided position to the road network.
RouteWaypoint.Builder	passThrough(Boolean passThrough)	If the waypoint should not be treated as a stop.
RouteWaypoint.Builder	position(Double... position)	Position defined as [longitude, latitude].
RouteWaypoint.Builder	position(Collection<Double> position)	Position defined as [longitude, latitude].
default RouteWaypoint.Builder	sideOfStreet(Consumer<RouteSideOfStreetOptions.Builder> sideOfStreet)	Options to configure matching the provided position to a side of the street.
RouteWaypoint.Builder	sideOfStreet(RouteSideOfStreetOptions sideOfStreet)	Options to configure matching the provided position to a side of the street.
RouteWaypoint.Builder	stopDuration(Long stopDuration)	Duration of the stop.

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

avoidActionsForDistance

RouteWaypoint.Builder avoidActionsForDistance(Long avoidActionsForDistance)

Avoids actions for the provided distance. This is typically to consider for users in moving vehicles who may not have sufficient time to make an action at an origin or a destination.

Parameters:

avoidActionsForDistance - Avoids actions for the provided distance. This is typically to consider for users in moving vehicles who may not have sufficient time to make an action at an origin or a destination.

Returns:

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

avoidUTurns

RouteWaypoint.Builder avoidUTurns(Boolean avoidUTurns)

Avoid U-turns for calculation on highways and motorways.

Parameters:

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

Returns:

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

heading

RouteWaypoint.Builder heading(Double heading)

GPS Heading at the position.

Parameters:

heading - GPS Heading at the position.

Returns:

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

matching

RouteWaypoint.Builder matching(RouteMatchingOptions matching)

Options to configure matching the provided position to the road network.

Parameters:

matching - Options to configure matching the provided position to the road network.

Returns:

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

matching

default RouteWaypoint.Builder matching(Consumer<RouteMatchingOptions.Builder> matching)

Options to configure matching the provided position to the road network.

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

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

Parameters:

matching - a consumer that will call methods on RouteMatchingOptions.Builder

Returns:

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

See Also:

matching(RouteMatchingOptions)

passThrough

RouteWaypoint.Builder passThrough(Boolean passThrough)

If the waypoint should not be treated as a stop. If yes, the waypoint is passed through and doesn't split the route into different legs.

Parameters:

passThrough - If the waypoint should not be treated as a stop. If yes, the waypoint is passed through and doesn't split the route into different legs.

Returns:

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

position

RouteWaypoint.Builder position(Collection<Double> position)

Position defined as [longitude, latitude].

Parameters:

position - Position defined as [longitude, latitude].

Returns:

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

position

RouteWaypoint.Builder position(Double... position)

Position defined as [longitude, latitude].

Parameters:

position - Position defined as [longitude, latitude].

Returns:

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

sideOfStreet

RouteWaypoint.Builder sideOfStreet(RouteSideOfStreetOptions sideOfStreet)

Options to configure matching the provided position to a side of the street.

Parameters:

sideOfStreet - Options to configure matching the provided position to a side of the street.

Returns:

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

sideOfStreet

default RouteWaypoint.Builder sideOfStreet(Consumer<RouteSideOfStreetOptions.Builder> sideOfStreet)

Options to configure matching the provided position to a side of the street.

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

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

Parameters:

sideOfStreet - a consumer that will call methods on RouteSideOfStreetOptions.Builder

Returns:

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

See Also:

sideOfStreet(RouteSideOfStreetOptions)

stopDuration

RouteWaypoint.Builder stopDuration(Long stopDuration)

Duration of the stop.

Unit: seconds

Parameters:

stopDuration - Duration of the stop.

Unit: seconds

Returns:

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