Class DevicePositionUpdate
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DevicePositionUpdate.Builder,
DevicePositionUpdate>
Contains the position update details for a device.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal PositionalAccuracy
accuracy()
The accuracy of the device position.static DevicePositionUpdate.Builder
builder()
final String
deviceId()
The device associated to the position update.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Position property.final boolean
For responses, this returns true if the service returned a value for the PositionProperties property.position()
The latest device position defined in WGS 84 format:[X or longitude, Y or latitude]
.Associates one of more properties with the position update.final Instant
The timestamp at which the device's position was determined.static Class
<? extends DevicePositionUpdate.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
accuracy
The accuracy of the device position.
- Returns:
- The accuracy of the device position.
-
deviceId
The device associated to the position update.
- Returns:
- The device associated to the position update.
-
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 theisEmpty()
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
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]
.
-
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 theisEmpty()
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
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"
-
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<DevicePositionUpdate.Builder,
DevicePositionUpdate> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-