java.lang.Object
- software.amazon.awssdk.services.location.model.DevicePositionUpdate

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<DevicePositionUpdate.Builder,DevicePositionUpdate>

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

Contains the position update details for a device.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DevicePositionUpdate.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`PositionalAccuracy`	`accuracy()`	The accuracy of the device position.
`static DevicePositionUpdate.Builder`	`builder()`
`String`	`deviceId()`	The device associated to the position update.
`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 latest device position defined in WGS 84 format: `[X or longitude, Y or latitude]`.
`Map<String,String>`	`positionProperties()`	Associates one of more properties with the position update.
`Instant`	`sampleTime()`	The timestamp at which the device's position was determined.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DevicePositionUpdate.Builder>`	`serializableBuilderClass()`
`DevicePositionUpdate.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
  - deviceId
```
public final String deviceId()
```
    The device associated to the position update.
    
    Returns:
    
    The device associated to the position update.
  - 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
  - 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 latest device position defined in WGS 84 format: [X or longitude, Y or 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:
    
    The latest device position defined in WGS 84 format: [X or longitude, Y or latitude].
  - accuracy
```
public final PositionalAccuracy accuracy()
```
    The accuracy of the device position.
    
    Returns:
    
    The accuracy of the 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()
```
    Associates one of more properties with the position update. A property is a key-value pair stored with the position update and added to any geofence event the update may trigger.
    
    Format: "key" : "value"
    
    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:
    
    Associates one of more properties with the position update. A property is a key-value pair stored with the position update and added to any geofence event the update may trigger.
    
    Format: "key" : "value"
  - toBuilder
```
public DevicePositionUpdate.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DevicePositionUpdate.Builder,DevicePositionUpdate>
  - builder
```
public static DevicePositionUpdate.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DevicePositionUpdate.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

Class DevicePositionUpdate

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

deviceId

sampleTime

hasPosition

position

accuracy

hasPositionProperties

positionProperties

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields