Interface SnapToRoadsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<SnapToRoadsRequest.Builder,,SnapToRoadsRequest> GeoRoutesRequest.Builder,SdkBuilder<SnapToRoadsRequest.Builder,,SnapToRoadsRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
SnapToRoadsRequest
@Mutable
@NotThreadSafe
public static interface SnapToRoadsRequest.Builder
extends GeoRoutesRequest.Builder, SdkPojo, CopyableBuilder<SnapToRoadsRequest.Builder,SnapToRoadsRequest>
-
Method Summary
Modifier and TypeMethodDescriptionOptional: The API key to be used for authorization.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.snappedGeometryFormat(String snappedGeometryFormat) Chooses what the returned SnappedGeometry format should be.snappedGeometryFormat(GeometryFormat snappedGeometryFormat) Chooses what the returned SnappedGeometry format should be.snapRadius(Long snapRadius) The radius around the provided tracepoint that is considered for snapping.tracePoints(Collection<RoadSnapTracePoint> tracePoints) List of trace points to be snapped onto the road network.tracePoints(Consumer<RoadSnapTracePoint.Builder>... tracePoints) List of trace points to be snapped onto the road network.tracePoints(RoadSnapTracePoint... tracePoints) List of trace points to be snapped onto the road network.travelMode(String travelMode) Specifies the mode of transport when calculating a route.travelMode(RoadSnapTravelMode travelMode) Specifies the mode of transport when calculating a route.default SnapToRoadsRequest.BuildertravelModeOptions(Consumer<RoadSnapTravelModeOptions.Builder> travelModeOptions) Travel mode related options for the provided travel mode.travelModeOptions(RoadSnapTravelModeOptions travelModeOptions) Travel mode related options for the provided travel mode.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.services.georoutes.model.GeoRoutesRequest.Builder
buildMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
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
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:
-
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:
-
snapRadius
The radius around the provided tracepoint that is considered for snapping.
Unit:
metersDefault value:
300- Parameters:
snapRadius- The radius around the provided tracepoint that is considered for snapping.Unit:
metersDefault value:
300- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
List of trace points to be snapped onto the road network.
This is a convenience method that creates an instance of theRoadSnapTracePoint.Builderavoiding the need to create one manually viaRoadSnapTracePoint.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed totracePoints(List<RoadSnapTracePoint>).- Parameters:
tracePoints- a consumer that will call methods onRoadSnapTracePoint.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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:
-
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:
-
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 theRoadSnapTravelModeOptions.Builderavoiding the need to create one manually viaRoadSnapTravelModeOptions.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed totravelModeOptions(RoadSnapTravelModeOptions).- Parameters:
travelModeOptions- a consumer that will call methods onRoadSnapTravelModeOptions.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
SnapToRoadsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
overrideConfiguration- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
SnapToRoadsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-