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

Class SnapToRoadsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.georoutes.model.GeoRoutesRequest

software.amazon.awssdk.services.georoutes.model.SnapToRoadsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SnapToRoadsRequest.Builder,SnapToRoadsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class SnapToRoadsRequest
extends GeoRoutesRequest
implements ToCopyableBuilder<SnapToRoadsRequest.Builder,SnapToRoadsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SnapToRoadsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static SnapToRoadsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTracePoints()	For responses, this returns true if the service returned a value for the TracePoints property.
String	key()	Optional: The API key to be used for authorization.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends SnapToRoadsRequest.Builder>	serializableBuilderClass()
GeometryFormat	snappedGeometryFormat()	Chooses what the returned SnappedGeometry format should be.
String	snappedGeometryFormatAsString()	Chooses what the returned SnappedGeometry format should be.
Long	snapRadius()	The radius around the provided tracepoint that is considered for snapping.
SnapToRoadsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<RoadSnapTracePoint>	tracePoints()	List of trace points to be snapped onto the road network.
RoadSnapTravelMode	travelMode()	Specifies the mode of transport when calculating a route.
String	travelModeAsString()	Specifies the mode of transport when calculating a route.
RoadSnapTravelModeOptions	travelModeOptions()	Travel mode related options for the provided travel mode.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

key

public final 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.

Returns:

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

snappedGeometryFormat

public final GeometryFormat snappedGeometryFormat()

Chooses what the returned SnappedGeometry format should be.

Default Value: FlexiblePolyline

If the service returns an enum value that is not available in the current SDK version, snappedGeometryFormat will return GeometryFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from snappedGeometryFormatAsString().

Returns:

Chooses what the returned SnappedGeometry format should be.

Default Value: FlexiblePolyline

See Also:

GeometryFormat

snappedGeometryFormatAsString

public final String snappedGeometryFormatAsString()

Chooses what the returned SnappedGeometry format should be.

Default Value: FlexiblePolyline

If the service returns an enum value that is not available in the current SDK version, snappedGeometryFormat will return GeometryFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from snappedGeometryFormatAsString().

Returns:

Chooses what the returned SnappedGeometry format should be.

Default Value: FlexiblePolyline

See Also:

GeometryFormat

snapRadius

public final Long snapRadius()

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

Unit: meters

Default value: 300

Returns:

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

Unit: meters

Default value: 300

hasTracePoints

public final boolean hasTracePoints()

For responses, this returns true if the service returned a value for the TracePoints property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tracePoints

public final List<RoadSnapTracePoint> tracePoints()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTracePoints() method.

Returns:

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

travelMode

public final RoadSnapTravelMode travelMode()

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

Default Value: Car

If the service returns an enum value that is not available in the current SDK version, travelMode will return RoadSnapTravelMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from travelModeAsString().

Returns:

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

Default Value: Car

See Also:

RoadSnapTravelMode

travelModeAsString

public final String travelModeAsString()

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

Default Value: Car

If the service returns an enum value that is not available in the current SDK version, travelMode will return RoadSnapTravelMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from travelModeAsString().

Returns:

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

Default Value: Car

See Also:

RoadSnapTravelMode

travelModeOptions

public final RoadSnapTravelModeOptions travelModeOptions()

Travel mode related options for the provided travel mode.

Returns:

Travel mode related options for the provided travel mode.

toBuilder

public SnapToRoadsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SnapToRoadsRequest.Builder,SnapToRoadsRequest>

Specified by:

toBuilder in class GeoRoutesRequest

builder

public static SnapToRoadsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends SnapToRoadsRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo