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

Class DeviceState

java.lang.Object

software.amazon.awssdk.services.location.model.DeviceState

All Implemented Interfaces:

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

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

The device's position, IP address, and Wi-Fi access points.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DeviceState.Builder

Method Summary

Modifier and Type	Method	Description
PositionalAccuracy	accuracy()	Returns the value of the Accuracy property for this object.
static DeviceState.Builder	builder()
CellSignals	cellSignals()	The cellular network infrastructure that the device is connected to.
String	deviceId()	The device identifier.
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	hasWiFiAccessPoints()	For responses, this returns true if the service returned a value for the WiFiAccessPoints property.
String	ipv4Address()	The device's Ipv4 address.
List<Double>	position()	The last known device position.
Instant	sampleTime()	The timestamp at which the device's position was determined.
List<SdkField<?>>	sdkFields()
static Class<? extends DeviceState.Builder>	serializableBuilderClass()
DeviceState.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<WiFiAccessPoint>	wiFiAccessPoints()	The Wi-Fi access points the device is using.

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

Returns:

The device identifier.

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

accuracy

public final PositionalAccuracy accuracy()

Returns the value of the Accuracy property for this object.

Returns:

The value of the Accuracy property for this object.

ipv4Address

public final String ipv4Address()

The device's Ipv4 address.

Returns:

The device's Ipv4 address.

hasWiFiAccessPoints

public final boolean hasWiFiAccessPoints()

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

wiFiAccessPoints

public final List<WiFiAccessPoint> wiFiAccessPoints()

The Wi-Fi access points the device is using.

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

Returns:

The Wi-Fi access points the device is using.

cellSignals

public final CellSignals cellSignals()

The cellular network infrastructure that the device is connected to.

Returns:

The cellular network infrastructure that the device is connected to.

toBuilder

public DeviceState.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DeviceState.Builder,DeviceState>

builder

public static DeviceState.Builder builder()

serializableBuilderClass

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