Class Device

    • Method Detail

      • brandAsString

        public final String brandAsString()

        The device's maker.

        If the service returns an enum value that is not available in the current SDK version, brand will return DeviceBrand.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from brandAsString().

        Returns:
        The device's maker.
        See Also:
        DeviceBrand
      • createdTime

        public final Instant createdTime()

        When the device was created.

        Returns:
        When the device was created.
      • currentSoftware

        public final String currentSoftware()

        A device's current software.

        Returns:
        A device's current software.
      • description

        public final String description()

        A description for the device.

        Returns:
        A description for the device.
      • deviceAggregatedStatus

        public final DeviceAggregatedStatus deviceAggregatedStatus()

        A device's aggregated status. Including the device's connection status, provisioning status, and lease status.

        If the service returns an enum value that is not available in the current SDK version, deviceAggregatedStatus will return DeviceAggregatedStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deviceAggregatedStatusAsString().

        Returns:
        A device's aggregated status. Including the device's connection status, provisioning status, and lease status.
        See Also:
        DeviceAggregatedStatus
      • deviceAggregatedStatusAsString

        public final String deviceAggregatedStatusAsString()

        A device's aggregated status. Including the device's connection status, provisioning status, and lease status.

        If the service returns an enum value that is not available in the current SDK version, deviceAggregatedStatus will return DeviceAggregatedStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deviceAggregatedStatusAsString().

        Returns:
        A device's aggregated status. Including the device's connection status, provisioning status, and lease status.
        See Also:
        DeviceAggregatedStatus
      • deviceId

        public final String deviceId()

        The device's ID.

        Returns:
        The device's ID.
      • lastUpdatedTime

        public final Instant lastUpdatedTime()

        When the device was updated.

        Returns:
        When the device was updated.
      • latestDeviceJob

        public final LatestDeviceJob latestDeviceJob()

        A device's latest job. Includes the target image version, and the update job status.

        Returns:
        A device's latest job. Includes the target image version, and the update job status.
      • leaseExpirationTime

        public final Instant leaseExpirationTime()

        The device's lease expiration time.

        Returns:
        The device's lease expiration time.
      • name

        public final String name()

        The device's name.

        Returns:
        The device's name.
      • provisioningStatusAsString

        public final String provisioningStatusAsString()

        The device's provisioning status.

        If the service returns an enum value that is not available in the current SDK version, provisioningStatus will return DeviceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from provisioningStatusAsString().

        Returns:
        The device's provisioning status.
        See Also:
        DeviceStatus
      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags 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.
      • tags

        public final Map<String,​String> tags()

        The device's tags.

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

        Returns:
        The device's tags.
      • typeAsString

        public final String typeAsString()

        The device's type.

        If the service returns an enum value that is not available in the current SDK version, type will return DeviceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

        Returns:
        The device's type.
        See Also:
        DeviceType
      • serializableBuilderClass

        public static Class<? extends Device.Builder> serializableBuilderClass()
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)