com.microsoft.azure.sdk.iot.provisioning.service.configs

Class DeviceRegistrationState

java.lang.Object

com.microsoft.azure.sdk.iot.provisioning.service.configs.DeviceRegistrationState

public class DeviceRegistrationState
extends Object

Representation of a single Device Provisioning Service device registration state with a JSON deserializer.

Example of JSON format:

 
 {
     "registrationId":"validRegistrationId",
     "createdDateTimeUtc": "2017-09-28T16:29:42.3447817Z",
     "assignedHub":"ContosoIoTHub.azure-devices.net",
     "deviceId":"ContosoDevice-123",
     "status":"assigned"
     "lastUpdatedDateTimeUtc": "2017-09-28T16:29:42.3447817Z",
     "errorCode":200
     "errorMessage":"Succeeded"
     "etag": "\"00000000-0000-0000-0000-00000000000\""
 }
 
 

See Also:

Device Enrollment

Constructor Summary

Constructors

Constructor and Description
DeviceRegistrationState(String json) CONSTRUCTOR

Method Summary

Modifier and Type	Method and Description
String	getAssignedHub() Getter for the assignedHub.
Date	getCreatedDateTimeUtc() Getter for the createdDateTimeUtc.
String	getDeviceId() Getter for the deviceId.
Integer	getErrorCode() Getter for the errorCode.
String	getErrorMessage() Getter for the errorMessage.
String	getEtag() Getter for the etag.
Date	getLastUpdatedDateTimeUtc() Getter for the lastUpdatedDateTimeUtc.
String	getRegistrationId() Getter for the registrationId.
EnrollmentStatus	getStatus() Getter for the status.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DeviceRegistrationState

public DeviceRegistrationState(String json)

CONSTRUCTOR

This constructor creates an instance of the device registration state filling the class with the information provided in the JSON.

Parameters:

json - the String with the JSON received from the provisioning service.

Throws:

IllegalArgumentException - If the provided JSON is null, empty, or invalid.

Method Detail

getRegistrationId

public String getRegistrationId()

Getter for the registrationId.

Returns:

The String with the registrationID content. It cannot be null or empty.

getDeviceId

public String getDeviceId()

Getter for the deviceId.

Returns:

The String with the deviceID content. It can be null.

getCreatedDateTimeUtc

public Date getCreatedDateTimeUtc()

Getter for the createdDateTimeUtc.

Returns:

The Date with the createdDateTimeUtc content. It can be null.

getLastUpdatedDateTimeUtc

public Date getLastUpdatedDateTimeUtc()

Getter for the lastUpdatedDateTimeUtc.

Returns:

The Date with the lastUpdatedDateTimeUtc content. It can be null.

getAssignedHub

public String getAssignedHub()

Getter for the assignedHub.

Returns:

The String with the assignedHub content. It can be null.

getStatus

public EnrollmentStatus getStatus()

Getter for the status.

Returns:

The EnrollmentStatus with the status content. It can be null.

getErrorCode

public Integer getErrorCode()

Getter for the errorCode.

Returns:

The Integer with the errorCode content. It can be null.

getErrorMessage

public String getErrorMessage()

Getter for the errorMessage.

Returns:

The String with the errorMessage content. It can be null.

getEtag

public String getEtag()

Getter for the etag.

Returns:

The String with the etag content. It can be null.