com.microsoft.azure.sdk.iot.service

Class ExportImportDevice

java.lang.Object

com.microsoft.azure.sdk.iot.service.ExportImportDevice

public class ExportImportDevice
extends Object

Constructor Summary

Constructors

Constructor and Description
ExportImportDevice() Default constructor for an ExportImportDevice object.
ExportImportDevice(String deviceId, AuthenticationType authenticationType) Constructor for an ExportImportDevice object.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
AuthenticationMechanism	getAuthenticationFinal() Getter for device authentication mechanism.
com.microsoft.azure.sdk.iot.deps.twin.TwinCollection	getDesiredProperties()
String	geteTag() Getter for device eTag.
String	getId() Getter for device id.
ImportMode	getImportMode() Getter for device import mode.
com.microsoft.azure.sdk.iot.deps.twin.TwinCollection	getReportedProperties()
DeviceStatus	getStatus() Getter for device status.
String	getStatusReason() Getter for device status reason.
com.microsoft.azure.sdk.iot.deps.twin.TwinCollection	getTags()
int	hashCode()
void	setAuthentication(AuthenticationMechanism authentication) Setter for device authentication mechanism.
void	setDesiredProperties(com.microsoft.azure.sdk.iot.deps.twin.TwinCollection desiredProperties)
void	seteTag(String eTag) Setter for device eTag.
void	setId(String id) Setter for device id.
void	setImportMode(ImportMode importMode) Setter for device import mode.
void	setReportedProperties(com.microsoft.azure.sdk.iot.deps.twin.TwinCollection reportedProperties)
void	setStatus(DeviceStatus status) Setter for device status.
void	setStatusReason(String statusReason) Setter for device status reason.
void	setTags(com.microsoft.azure.sdk.iot.deps.twin.TwinCollection tags)

Methods inherited from class java.lang.Object

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

Constructor Detail

ExportImportDevice

public ExportImportDevice()

Default constructor for an ExportImportDevice object. Randomly generates a device ID and uses a randomly generated shared access signature for authentication

ExportImportDevice

public ExportImportDevice(String deviceId,
                          AuthenticationType authenticationType)
                   throws IllegalArgumentException

Constructor for an ExportImportDevice object.

Parameters:

deviceId - the id of the new device

authenticationType - the type of authentication to be used. For shared access signature and self signed x.509, all keys shall be generated automatically.

Throws:

IllegalArgumentException - if the provided deviceId or authenticationType is null or empty

Method Detail

setId

public void setId(String id)
           throws IllegalArgumentException

Setter for device id.

Parameters:

id - The device id.

Throws:

IllegalArgumentException - if the provided id is null

getId

public String getId()

Getter for device id.

Returns:

The device id.

geteTag

public String geteTag()

Getter for device eTag.

Returns:

The device eTag.

seteTag

public void seteTag(String eTag)

Setter for device eTag.

Parameters:

eTag - The device eTag.

getImportMode

public ImportMode getImportMode()

Getter for device import mode.

Returns:

The device import mode.

setImportMode

public void setImportMode(ImportMode importMode)

Setter for device import mode.

Parameters:

importMode - The device import mode.

getStatus

public DeviceStatus getStatus()

Getter for device status.

Returns:

The device status.

setStatus

public void setStatus(DeviceStatus status)

Setter for device status.

Parameters:

status - The device status.

getStatusReason

public String getStatusReason()

Getter for device status reason.

Returns:

The device status reason.

setStatusReason

public void setStatusReason(String statusReason)

Setter for device status reason.

Parameters:

statusReason - The device status reason.

getAuthenticationFinal

public AuthenticationMechanism getAuthenticationFinal()

Getter for device authentication mechanism.

Returns:

The device authentication mechanism.

setAuthentication

public void setAuthentication(AuthenticationMechanism authentication)
                       throws IllegalArgumentException

Setter for device authentication mechanism.

Parameters:

authentication - The device authentication mechanism.

Throws:

IllegalArgumentException - if the provided authentication is null

getTags

public com.microsoft.azure.sdk.iot.deps.twin.TwinCollection getTags()

Returns:

the tags

setTags

public void setTags(com.microsoft.azure.sdk.iot.deps.twin.TwinCollection tags)

Parameters:

tags - the tags to set

getReportedProperties

public com.microsoft.azure.sdk.iot.deps.twin.TwinCollection getReportedProperties()

Returns:

the reportedProperties

setReportedProperties

public void setReportedProperties(com.microsoft.azure.sdk.iot.deps.twin.TwinCollection reportedProperties)

Parameters:

reportedProperties - the reportedProperties to set

getDesiredProperties

public com.microsoft.azure.sdk.iot.deps.twin.TwinCollection getDesiredProperties()

Returns:

the desiredProperties

setDesiredProperties

public void setDesiredProperties(com.microsoft.azure.sdk.iot.deps.twin.TwinCollection desiredProperties)

Parameters:

desiredProperties - the desiredProperties to set

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object