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

Class RouteWaypoint

java.lang.Object

software.amazon.awssdk.services.georoutes.model.RouteWaypoint

All Implemented Interfaces:

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

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

Waypoint between the Origin and Destination.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RouteWaypoint.Builder

Method Summary

Modifier and Type	Method	Description
Long	avoidActionsForDistance()	Avoids actions for the provided distance.
Boolean	avoidUTurns()	Avoid U-turns for calculation on highways and motorways.
static RouteWaypoint.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.
Double	heading()	GPS Heading at the position.
RouteMatchingOptions	matching()	Options to configure matching the provided position to the road network.
Boolean	passThrough()	If the waypoint should not be treated as a stop.
List<Double>	position()	Position defined as [longitude, latitude].
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RouteWaypoint.Builder>	serializableBuilderClass()
RouteSideOfStreetOptions	sideOfStreet()	Options to configure matching the provided position to a side of the street.
Long	stopDuration()	Duration of the stop.
RouteWaypoint.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

avoidActionsForDistance

public final Long avoidActionsForDistance()

Avoids actions for the provided distance. This is typically to consider for users in moving vehicles who may not have sufficient time to make an action at an origin or a destination.

Returns:

Avoids actions for the provided distance. This is typically to consider for users in moving vehicles who may not have sufficient time to make an action at an origin or a destination.

avoidUTurns

public final Boolean avoidUTurns()

Avoid U-turns for calculation on highways and motorways.

Returns:

Avoid U-turns for calculation on highways and motorways.

heading

public final Double heading()

GPS Heading at the position.

Returns:

GPS Heading at the position.

matching

public final RouteMatchingOptions matching()

Options to configure matching the provided position to the road network.

Returns:

Options to configure matching the provided position to the road network.

passThrough

public final Boolean passThrough()

If the waypoint should not be treated as a stop. If yes, the waypoint is passed through and doesn't split the route into different legs.

Returns:

If the waypoint should not be treated as a stop. If yes, the waypoint is passed through and doesn't split the route into different legs.

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

sideOfStreet

public final RouteSideOfStreetOptions sideOfStreet()

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

Returns:

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

stopDuration

public final Long stopDuration()

Duration of the stop.

Unit: seconds

Returns:

Duration of the stop.

Unit: seconds

toBuilder

public RouteWaypoint.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RouteWaypoint.Builder,RouteWaypoint>

builder

public static RouteWaypoint.Builder builder()

serializableBuilderClass

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