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

Class RouteFerryPlace

java.lang.Object

software.amazon.awssdk.services.georoutes.model.RouteFerryPlace

All Implemented Interfaces:

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

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

Position provided in the request.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RouteFerryPlace.Builder

Method Summary

Modifier and Type	Method	Description
static RouteFerryPlace.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasOriginalPosition()	For responses, this returns true if the service returned a value for the OriginalPosition property.
boolean	hasPosition()	For responses, this returns true if the service returned a value for the Position property.
String	name()	The name of the place.
List<Double>	originalPosition()	Position provided in the request.
List<Double>	position()	Position defined as [longitude, latitude].
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RouteFerryPlace.Builder>	serializableBuilderClass()
RouteFerryPlace.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Integer	waypointIndex()	Index of the waypoint in the request.

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

name

public final String name()

The name of the place.

Returns:

The name of the place.

hasOriginalPosition

public final boolean hasOriginalPosition()

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

originalPosition

public final List<Double> originalPosition()

Position provided in the request.

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

Returns:

Position provided in the request.

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

waypointIndex

public final Integer waypointIndex()

Index of the waypoint in the request.

Returns:

Index of the waypoint in the request.

toBuilder

public RouteFerryPlace.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RouteFerryPlace.Builder,RouteFerryPlace>

builder

public static RouteFerryPlace.Builder builder()

serializableBuilderClass

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