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

Class WaypointOptimizationSideOfStreetOptions

java.lang.Object

software.amazon.awssdk.services.georoutes.model.WaypointOptimizationSideOfStreetOptions

All Implemented Interfaces:

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

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

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WaypointOptimizationSideOfStreetOptions.Builder

Method Summary

Modifier and Type	Method	Description
static WaypointOptimizationSideOfStreetOptions.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPosition()	For responses, this returns true if the service returned a value for the Position property.
List<Double>	position()	Position defined as [longitude, latitude].
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends WaypointOptimizationSideOfStreetOptions.Builder>	serializableBuilderClass()
WaypointOptimizationSideOfStreetOptions.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
SideOfStreetMatchingStrategy	useWith()	Strategy that defines when the side of street position should be used.
String	useWithAsString()	Strategy that defines when the side of street position should be used.

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

hasPosition

public final boolean hasPosition()

For responses, this returns true if the service returned a value for the Position 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.

position

public final List<Double> position()

Position defined as [longitude, latitude].

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 hasPosition() method.

Returns:

Position defined as [longitude, latitude].

useWith

public final SideOfStreetMatchingStrategy useWith()

Strategy that defines when the side of street position should be used. AnyStreet will always use the provided position.

Default Value: DividedStreetOnly

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

Returns:

Strategy that defines when the side of street position should be used. AnyStreet will always use the provided position.

Default Value: DividedStreetOnly

See Also:

SideOfStreetMatchingStrategy

useWithAsString

public final String useWithAsString()

Strategy that defines when the side of street position should be used. AnyStreet will always use the provided position.

Default Value: DividedStreetOnly

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

Returns:

Strategy that defines when the side of street position should be used. AnyStreet will always use the provided position.

Default Value: DividedStreetOnly

See Also:

SideOfStreetMatchingStrategy

toBuilder

public WaypointOptimizationSideOfStreetOptions.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<WaypointOptimizationSideOfStreetOptions.Builder,WaypointOptimizationSideOfStreetOptions>

builder

public static WaypointOptimizationSideOfStreetOptions.Builder builder()

serializableBuilderClass

public static Class<? extends WaypointOptimizationSideOfStreetOptions.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