Class DeviceTwinInfo


  • public class DeviceTwinInfo
    extends Object
    Information about the device twin, which is the cloud representation of application device metadata.
    • Constructor Detail

      • DeviceTwinInfo

        public DeviceTwinInfo()
    • Method Detail

      • authenticationType

        public String authenticationType()
        Get authentication type used for this device: either SAS, SelfSigned, or CertificateAuthority.
        Returns:
        the authenticationType value
      • withAuthenticationType

        public DeviceTwinInfo withAuthenticationType​(String authenticationType)
        Set authentication type used for this device: either SAS, SelfSigned, or CertificateAuthority.
        Parameters:
        authenticationType - the authenticationType value to set
        Returns:
        the DeviceTwinInfo object itself.
      • cloudToDeviceMessageCount

        public Double cloudToDeviceMessageCount()
        Get count of cloud to device messages sent to this device.
        Returns:
        the cloudToDeviceMessageCount value
      • withCloudToDeviceMessageCount

        public DeviceTwinInfo withCloudToDeviceMessageCount​(Double cloudToDeviceMessageCount)
        Set count of cloud to device messages sent to this device.
        Parameters:
        cloudToDeviceMessageCount - the cloudToDeviceMessageCount value to set
        Returns:
        the DeviceTwinInfo object itself.
      • connectionState

        public String connectionState()
        Get whether the device is connected or disconnected.
        Returns:
        the connectionState value
      • withConnectionState

        public DeviceTwinInfo withConnectionState​(String connectionState)
        Set whether the device is connected or disconnected.
        Parameters:
        connectionState - the connectionState value to set
        Returns:
        the DeviceTwinInfo object itself.
      • deviceId

        public String deviceId()
        Get the unique identifier of the device twin.
        Returns:
        the deviceId value
      • withDeviceId

        public DeviceTwinInfo withDeviceId​(String deviceId)
        Set the unique identifier of the device twin.
        Parameters:
        deviceId - the deviceId value to set
        Returns:
        the DeviceTwinInfo object itself.
      • etag

        public String etag()
        Get a piece of information that describes the content of the device twin. Each etag is guaranteed to be unique per device twin.
        Returns:
        the etag value
      • withEtag

        public DeviceTwinInfo withEtag​(String etag)
        Set a piece of information that describes the content of the device twin. Each etag is guaranteed to be unique per device twin.
        Parameters:
        etag - the etag value to set
        Returns:
        the DeviceTwinInfo object itself.
      • lastActivityTime

        public String lastActivityTime()
        Get the ISO8601 timestamp of the last activity.
        Returns:
        the lastActivityTime value
      • withLastActivityTime

        public DeviceTwinInfo withLastActivityTime​(String lastActivityTime)
        Set the ISO8601 timestamp of the last activity.
        Parameters:
        lastActivityTime - the lastActivityTime value to set
        Returns:
        the DeviceTwinInfo object itself.
      • withProperties

        public DeviceTwinInfo withProperties​(DeviceTwinInfoProperties properties)
        Set properties JSON element.
        Parameters:
        properties - the properties value to set
        Returns:
        the DeviceTwinInfo object itself.
      • status

        public String status()
        Get whether the device twin is enabled or disabled.
        Returns:
        the status value
      • withStatus

        public DeviceTwinInfo withStatus​(String status)
        Set whether the device twin is enabled or disabled.
        Parameters:
        status - the status value to set
        Returns:
        the DeviceTwinInfo object itself.
      • statusUpdateTime

        public String statusUpdateTime()
        Get the ISO8601 timestamp of the last device twin status update.
        Returns:
        the statusUpdateTime value
      • withStatusUpdateTime

        public DeviceTwinInfo withStatusUpdateTime​(String statusUpdateTime)
        Set the ISO8601 timestamp of the last device twin status update.
        Parameters:
        statusUpdateTime - the statusUpdateTime value to set
        Returns:
        the DeviceTwinInfo object itself.
      • version

        public Double version()
        Get an integer that is incremented by one each time the device twin is updated.
        Returns:
        the version value
      • withVersion

        public DeviceTwinInfo withVersion​(Double version)
        Set an integer that is incremented by one each time the device twin is updated.
        Parameters:
        version - the version value to set
        Returns:
        the DeviceTwinInfo object itself.
      • x509Thumbprint

        public DeviceTwinInfoX509Thumbprint x509Thumbprint()
        Get the thumbprint is a unique value for the x509 certificate, commonly used to find a particular certificate in a certificate store. The thumbprint is dynamically generated using the SHA1 algorithm, and does not physically exist in the certificate.
        Returns:
        the x509Thumbprint value
      • withX509Thumbprint

        public DeviceTwinInfo withX509Thumbprint​(DeviceTwinInfoX509Thumbprint x509Thumbprint)
        Set the thumbprint is a unique value for the x509 certificate, commonly used to find a particular certificate in a certificate store. The thumbprint is dynamically generated using the SHA1 algorithm, and does not physically exist in the certificate.
        Parameters:
        x509Thumbprint - the x509Thumbprint value to set
        Returns:
        the DeviceTwinInfo object itself.