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

Class GetDevicePositionResponse

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

      • 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