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

Class RouteMatrixMatchingOptions

java.lang.Object

software.amazon.awssdk.services.georoutes.model.RouteMatrixMatchingOptions

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RouteMatrixMatchingOptions.Builder,RouteMatrixMatchingOptions>

@Generated("software.amazon.awssdk:codegen")
public final class RouteMatrixMatchingOptions
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RouteMatrixMatchingOptions.Builder,RouteMatrixMatchingOptions>

Matching options.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RouteMatrixMatchingOptions.Builder

Method Summary

Modifier and Type	Method	Description
static RouteMatrixMatchingOptions.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	nameHint()	Attempts to match the provided position to a road similar to the provided name.
Long	onRoadThreshold()	If the distance to a highway/bridge/tunnel/sliproad is within threshold, the waypoint will be snapped to the highway/bridge/tunnel/sliproad.
Long	radius()	Considers all roads within the provided radius to match the provided destination to.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RouteMatrixMatchingOptions.Builder>	serializableBuilderClass()
MatchingStrategy	strategy()	Strategy that defines matching of the position onto the road network.
String	strategyAsString()	Strategy that defines matching of the position onto the road network.
RouteMatrixMatchingOptions.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

nameHint

public final String nameHint()

Attempts to match the provided position to a road similar to the provided name.

Returns:

Attempts to match the provided position to a road similar to the provided name.

onRoadThreshold

public final Long onRoadThreshold()

If the distance to a highway/bridge/tunnel/sliproad is within threshold, the waypoint will be snapped to the highway/bridge/tunnel/sliproad.

Unit: meters

Returns:

If the distance to a highway/bridge/tunnel/sliproad is within threshold, the waypoint will be snapped to the highway/bridge/tunnel/sliproad.

Unit: meters

radius

public final Long radius()

Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.

Unit: Meters

Returns:

Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.

Unit: Meters

strategy

public final MatchingStrategy strategy()

Strategy that defines matching of the position onto the road network. MatchAny considers all roads possible, whereas MatchMostSignificantRoad matches to the most significant road.

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

Returns:

Strategy that defines matching of the position onto the road network. MatchAny considers all roads possible, whereas MatchMostSignificantRoad matches to the most significant road.

See Also:

MatchingStrategy

strategyAsString

public final String strategyAsString()

Strategy that defines matching of the position onto the road network. MatchAny considers all roads possible, whereas MatchMostSignificantRoad matches to the most significant road.

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

Returns:

Strategy that defines matching of the position onto the road network. MatchAny considers all roads possible, whereas MatchMostSignificantRoad matches to the most significant road.

See Also:

MatchingStrategy

toBuilder

public RouteMatrixMatchingOptions.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RouteMatrixMatchingOptions.Builder,RouteMatrixMatchingOptions>

builder

public static RouteMatrixMatchingOptions.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

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