ExportImportDevice Class

Package:

com.microsoft.azure.sdk.iot.service

Maven Artifact:

com.microsoft.azure.sdk.iot:iot-service-client:1.30.0

• java.lang.Object
• • com.microsoft.azure.sdk.iot.service.ExportImportDevice

public class ExportImportDevice

Constructor Summary

Constructor	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.
TwinCollection	getDesiredProperties()
java.lang.String	getId() Getter for device id.
ImportMode	getImportMode() Getter for device import mode.
TwinCollection	getReportedProperties()
DeviceStatus	getStatus() Getter for device status.
java.lang.String	getStatusReason() Getter for device status reason.
TwinCollection	getTags()
java.lang.String	geteTag() Getter for device eTag.
int	hashCode()
void	setAuthentication(AuthenticationMechanism authentication) Setter for device authentication mechanism.
void	setDesiredProperties(TwinCollection desiredProperties)
void	setId(String id) Setter for device id.
void	setImportMode(ImportMode importMode) Setter for device import mode.
void	setReportedProperties(TwinCollection reportedProperties)
void	setStatus(DeviceStatus status) Setter for device status.
void	setStatusReason(String statusReason) Setter for device status reason.
void	setTags(TwinCollection tags)
void	seteTag(String eTag) Setter for device eTag.

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

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)

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:

java.lang.IllegalArgumentException - if the provided deviceId or authenticationType is null or empty

Method Details

equals

public boolean equals(Object other)

Overrides:

ExportImportDevice.equals(Object other)

Parameters:

other

getAuthenticationFinal

public AuthenticationMechanism getAuthenticationFinal()

Getter for device authentication mechanism.

Returns:

The device authentication mechanism.

getDesiredProperties

public TwinCollection getDesiredProperties()

Returns:

the desiredProperties

getId

public String getId()

Getter for device id.

Returns:

The device id.

getImportMode

public ImportMode getImportMode()

Getter for device import mode.

Returns:

The device import mode.

getReportedProperties

public TwinCollection getReportedProperties()

Returns:

the reportedProperties

getStatus

public DeviceStatus getStatus()

Getter for device status.

Returns:

The device status.

getStatusReason

public String getStatusReason()

Getter for device status reason.

Returns:

The device status reason.

getTags

public TwinCollection getTags()

Returns:

the tags

geteTag

public String geteTag()

Getter for device eTag.

Returns:

The device eTag.

hashCode

public int hashCode()

Overrides:

ExportImportDevice.hashCode()

setAuthentication

public void setAuthentication(AuthenticationMechanism authentication)

Setter for device authentication mechanism.

Parameters:

authentication - The device authentication mechanism.

Throws:

java.lang.IllegalArgumentException - if the provided authentication is null

setDesiredProperties

public void setDesiredProperties(TwinCollection desiredProperties)

Parameters:

desiredProperties - the desiredProperties to set

setId

public void setId(String id)

Setter for device id.

Parameters:

id - The device id.

Throws:

java.lang.IllegalArgumentException - if the provided id is null

setImportMode

public void setImportMode(ImportMode importMode)

Setter for device import mode.

Parameters:

importMode - The device import mode.

setReportedProperties

public void setReportedProperties(TwinCollection reportedProperties)

Parameters:

reportedProperties - the reportedProperties to set

setStatus

public void setStatus(DeviceStatus status)

Setter for device status.

Parameters:

status - The device status.

setStatusReason

public void setStatusReason(String statusReason)

Setter for device status reason.

Parameters:

statusReason - The device status reason.

setTags

public void setTags(TwinCollection tags)

Parameters:

tags - the tags to set

seteTag

public void seteTag(String eTag)

Setter for device eTag.

Parameters:

eTag - The device eTag.