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

Interface SnapToRoadsRequest.Builder

All Superinterfaces:

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

Enclosing class:

SnapToRoadsRequest

public static interface SnapToRoadsRequest.Builder
extends GeoRoutesRequest.Builder, SdkPojo, CopyableBuilder<SnapToRoadsRequest.Builder,SnapToRoadsRequest>

Method Summary

Modifier and Type	Method	Description
SnapToRoadsRequest.Builder	key(String key)	Optional: The API key to be used for authorization.
SnapToRoadsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
SnapToRoadsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
SnapToRoadsRequest.Builder	snappedGeometryFormat(String snappedGeometryFormat)	Chooses what the returned SnappedGeometry format should be.
SnapToRoadsRequest.Builder	snappedGeometryFormat(GeometryFormat snappedGeometryFormat)	Chooses what the returned SnappedGeometry format should be.
SnapToRoadsRequest.Builder	snapRadius(Long snapRadius)	The radius around the provided tracepoint that is considered for snapping.
SnapToRoadsRequest.Builder	tracePoints(Collection<RoadSnapTracePoint> tracePoints)	List of trace points to be snapped onto the road network.
SnapToRoadsRequest.Builder	tracePoints(Consumer<RoadSnapTracePoint.Builder>... tracePoints)	List of trace points to be snapped onto the road network.
SnapToRoadsRequest.Builder	tracePoints(RoadSnapTracePoint... tracePoints)	List of trace points to be snapped onto the road network.
SnapToRoadsRequest.Builder	travelMode(String travelMode)	Specifies the mode of transport when calculating a route.
SnapToRoadsRequest.Builder	travelMode(RoadSnapTravelMode travelMode)	Specifies the mode of transport when calculating a route.
default SnapToRoadsRequest.Builder	travelModeOptions(Consumer<RoadSnapTravelModeOptions.Builder> travelModeOptions)	Travel mode related options for the provided travel mode.
SnapToRoadsRequest.Builder	travelModeOptions(RoadSnapTravelModeOptions travelModeOptions)	Travel mode related options for the provided travel mode.

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 Detail

key

SnapToRoadsRequest.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.

snappedGeometryFormat

SnapToRoadsRequest.Builder snappedGeometryFormat(String snappedGeometryFormat)

Chooses what the returned SnappedGeometry format should be.

Default Value: FlexiblePolyline

Parameters:

snappedGeometryFormat - Chooses what the returned SnappedGeometry format should be.

Default Value: FlexiblePolyline

Returns:

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

See Also:

GeometryFormat, GeometryFormat

snappedGeometryFormat

SnapToRoadsRequest.Builder snappedGeometryFormat(GeometryFormat snappedGeometryFormat)

Chooses what the returned SnappedGeometry format should be.

Default Value: FlexiblePolyline

Parameters:

snappedGeometryFormat - Chooses what the returned SnappedGeometry format should be.

Default Value: FlexiblePolyline

Returns:

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

See Also:

GeometryFormat, GeometryFormat

snapRadius

SnapToRoadsRequest.Builder snapRadius(Long snapRadius)

The radius around the provided tracepoint that is considered for snapping.

Unit: meters

Default value: 300

Parameters:

snapRadius - The radius around the provided tracepoint that is considered for snapping.

Unit: meters

Default value: 300

Returns:

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

tracePoints

SnapToRoadsRequest.Builder tracePoints(Collection<RoadSnapTracePoint> tracePoints)

List of trace points to be snapped onto the road network.

Parameters:

tracePoints - List of trace points to be snapped onto the road network.

Returns:

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

tracePoints

SnapToRoadsRequest.Builder tracePoints(RoadSnapTracePoint... tracePoints)

List of trace points to be snapped onto the road network.

Parameters:

tracePoints - List of trace points to be snapped onto the road network.

Returns:

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

tracePoints

SnapToRoadsRequest.Builder tracePoints(Consumer<RoadSnapTracePoint.Builder>... tracePoints)

List of trace points to be snapped onto the road network.

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

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

Parameters:

tracePoints - a consumer that will call methods on RoadSnapTracePoint.Builder

Returns:

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

See Also:

#tracePoints(java.util.Collection)

travelMode

SnapToRoadsRequest.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:

RoadSnapTravelMode, RoadSnapTravelMode

travelMode

SnapToRoadsRequest.Builder travelMode(RoadSnapTravelMode 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:

RoadSnapTravelMode, RoadSnapTravelMode

travelModeOptions

SnapToRoadsRequest.Builder travelModeOptions(RoadSnapTravelModeOptions 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 SnapToRoadsRequest.Builder travelModeOptions(Consumer<RoadSnapTravelModeOptions.Builder> travelModeOptions)

Travel mode related options for the provided travel mode.

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

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

Parameters:

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

Returns:

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

See Also:

travelModeOptions(RoadSnapTravelModeOptions)

overrideConfiguration

SnapToRoadsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder