Package software.amazon.awssdk.services.location.model

Class DevicePosition

java.lang.Object

software.amazon.awssdk.services.location.model.DevicePosition

All Implemented Interfaces:

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

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

Contains the device position details.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DevicePosition.Builder

Method Summary

Modifier and Type	Method	Description
PositionalAccuracy	accuracy()	The accuracy of the device position.
static DevicePosition.Builder	builder()
String	deviceId()	The device whose position you retrieved.
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.
boolean	hasPositionProperties()	For responses, this returns true if the service returned a value for the PositionProperties property.
List<Double>	position()	The last known device position.
Map<String,String>	positionProperties()	The properties associated with the position.
Instant	receivedTime()	The timestamp for when the tracker resource received the device position in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
Instant	sampleTime()	The timestamp at which the device's position was determined.
List<SdkField<?>>	sdkFields()
static Class<? extends DevicePosition.Builder>	serializableBuilderClass()
DevicePosition.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

accuracy

public final PositionalAccuracy accuracy()

The accuracy of the device position.

Returns:

The accuracy of the device position.

deviceId

public final String deviceId()

The device whose position you retrieved.

Returns:

The device whose position you retrieved.

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()

The last known device position.

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:

The last known device position.

hasPositionProperties

public final boolean hasPositionProperties()

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

positionProperties

public final Map<String,String> positionProperties()

The properties associated with the position.

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

Returns:

The properties associated with the position.

receivedTime

public final Instant receivedTime()

The timestamp for when the tracker resource received the device position in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Returns:

The timestamp for when the tracker resource received the device position in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

sampleTime

public final Instant sampleTime()

The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Returns:

The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

toBuilder

public DevicePosition.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DevicePosition.Builder,DevicePosition>

builder

public static DevicePosition.Builder builder()

serializableBuilderClass

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