Package com.azure.messaging.eventgrid.systemevents

Class DeviceTwinInfo

  • public final 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

      • getAuthenticationType

        public String getAuthenticationType()
        Get the authenticationType property: Authentication type used for this device: either SAS, SelfSigned, or CertificateAuthority.
        Returns:
        the authenticationType value.

      • setAuthenticationType

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

      • getCloudToDeviceMessageCount

        public Float getCloudToDeviceMessageCount()
        Get the cloudToDeviceMessageCount property: Count of cloud to device messages sent to this device.
        Returns:
        the cloudToDeviceMessageCount value.

      • setCloudToDeviceMessageCount

        public DeviceTwinInfo setCloudToDeviceMessageCount​(Float cloudToDeviceMessageCount)
        Set the cloudToDeviceMessageCount property: Count of cloud to device messages sent to this device.
        Parameters:
        cloudToDeviceMessageCount - the cloudToDeviceMessageCount value to set.
        Returns:
        the DeviceTwinInfo object itself.

      • getConnectionState

        public String getConnectionState()
        Get the connectionState property: Whether the device is connected or disconnected.
        Returns:
        the connectionState value.

      • setConnectionState

        public DeviceTwinInfo setConnectionState​(String connectionState)
        Set the connectionState property: Whether the device is connected or disconnected.
        Parameters:
        connectionState - the connectionState value to set.
        Returns:
        the DeviceTwinInfo object itself.

      • getDeviceId

        public String getDeviceId()
        Get the deviceId property: The unique identifier of the device twin.
        Returns:
        the deviceId value.

      • setDeviceId

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

      • getEtag

        public String getEtag()
        Get the etag property: 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.

      • setEtag

        public DeviceTwinInfo setEtag​(String etag)
        Set the etag property: 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.

      • getLastActivityTime

        public String getLastActivityTime()
        Get the lastActivityTime property: The ISO8601 timestamp of the last activity.
        Returns:
        the lastActivityTime value.

      • setLastActivityTime

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

      • getProperties

        public DeviceTwinInfoProperties getProperties()
        Get the properties property: Properties JSON element.
        Returns:
        the properties value.

      • setProperties

        public DeviceTwinInfo setProperties​(DeviceTwinInfoProperties properties)
        Set the properties property: Properties JSON element.
        Parameters:
        properties - the properties value to set.
        Returns:
        the DeviceTwinInfo object itself.

      • getStatus

        public String getStatus()
        Get the status property: Whether the device twin is enabled or disabled.
        Returns:
        the status value.

      • setStatus

        public DeviceTwinInfo setStatus​(String status)
        Set the status property: Whether the device twin is enabled or disabled.
        Parameters:
        status - the status value to set.
        Returns:
        the DeviceTwinInfo object itself.

      • getStatusUpdateTime

        public String getStatusUpdateTime()
        Get the statusUpdateTime property: The ISO8601 timestamp of the last device twin status update.
        Returns:
        the statusUpdateTime value.

      • setStatusUpdateTime

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

      • getVersion

        public Float getVersion()
        Get the version property: An integer that is incremented by one each time the device twin is updated.
        Returns:
        the version value.

      • setVersion

        public DeviceTwinInfo setVersion​(Float version)
        Set the version property: 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.

      • getX509Thumbprint

        public DeviceTwinInfoX509Thumbprint getX509Thumbprint()
        Get the x509Thumbprint property: 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.

      • setX509Thumbprint

        public DeviceTwinInfo setX509Thumbprint​(DeviceTwinInfoX509Thumbprint x509Thumbprint)
        Set the x509Thumbprint property: 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.