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

Class ReprovisionPolicy

java.lang.Object

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

public class ReprovisionPolicy
extends Object

Settings for IoT Hub Device Reprovisioning

See Also:

IoT Hub Device reprovisioning concepts

Constructor Summary

Constructors

Constructor and Description
ReprovisionPolicy()

Method Summary

Modifier and Type	Method and Description
boolean	getMigrateDeviceData() Getter for the migrateDeviceData flag.
boolean	getUpdateHubAssignment() Getter for the updateHubAssignment flag.
void	setMigrateDeviceData(boolean migrateDeviceData) When set to true (default), the Device Provisioning Service will migrate the device's data (twin, device capabilities, and device ID) from one IoT hub to another during an IoT hub assignment update.
void	setUpdateHubAssignment(boolean updateHubAssignment) When set to true (default), the Device Provisioning Service will evaluate the device's IoT Hub assignment and update it if necessary for any provisioning requests beyond the first from a given device.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReprovisionPolicy

public ReprovisionPolicy()

Method Detail

getUpdateHubAssignment

public boolean getUpdateHubAssignment()

Getter for the updateHubAssignment flag.

Returns:

The boolean with the updateHubAssignment content.

setUpdateHubAssignment

public void setUpdateHubAssignment(boolean updateHubAssignment)

When set to true (default), the Device Provisioning Service will evaluate the device's IoT Hub assignment and update it if necessary for any provisioning requests beyond the first from a given device. If set to false, the device will stay assigned to its current IoT hub.

Parameters:

updateHubAssignment - the boolean with the flag for updateHubAssignment.

getMigrateDeviceData

public boolean getMigrateDeviceData()

Getter for the migrateDeviceData flag.

Returns:

The boolean with the migrateDeviceData content.

setMigrateDeviceData

public void setMigrateDeviceData(boolean migrateDeviceData)

When set to true (default), the Device Provisioning Service will migrate the device's data (twin, device capabilities, and device ID) from one IoT hub to another during an IoT hub assignment update. If set to false, the Device Provisioning Service will reset the device's data to the initial desired configuration stored in the provisioning service's enrollment list.

Parameters:

migrateDeviceData - the boolean with the flag for migrateDeviceData.