Package com.azure.messaging.eventgrid.systemevents

Class DeviceLifeCycleEventProperties

java.lang.Object

com.azure.messaging.eventgrid.systemevents.DeviceLifeCycleEventProperties

Direct Known Subclasses:

IotHubDeviceCreatedEventData, IotHubDeviceDeletedEventData

public class DeviceLifeCycleEventProperties
extends Object

Schema of the Data property of an EventGridEvent for a device life cycle event (DeviceCreated, DeviceDeleted).

Constructor Summary

Constructors

Constructor	Description
DeviceLifeCycleEventProperties()

Method Summary

Modifier and Type	Method	Description
String	getDeviceId()	Get the deviceId property: The unique identifier of the device.
String	getHubName()	Get the hubName property: Name of the IoT Hub where the device was created or deleted.
DeviceTwinInfo	getTwin()	Get the twin property: Information about the device twin, which is the cloud representation of application device metadata.
DeviceLifeCycleEventProperties	setDeviceId(String deviceId)	Set the deviceId property: The unique identifier of the device.
DeviceLifeCycleEventProperties	setHubName(String hubName)	Set the hubName property: Name of the IoT Hub where the device was created or deleted.
DeviceLifeCycleEventProperties	setTwin(DeviceTwinInfo twin)	Set the twin property: Information about the device twin, which is the cloud representation of application device metadata.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeviceLifeCycleEventProperties

public DeviceLifeCycleEventProperties()

Method Detail

getDeviceId

public String getDeviceId()

Get the deviceId property: The unique identifier of the device. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ '.

Returns:

the deviceId value.

setDeviceId

public DeviceLifeCycleEventProperties setDeviceId(String deviceId)

Set the deviceId property: The unique identifier of the device. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = @ ; $ '.

Parameters:

deviceId - the deviceId value to set.

Returns:

the DeviceLifeCycleEventProperties object itself.

getHubName

public String getHubName()

Get the hubName property: Name of the IoT Hub where the device was created or deleted.

Returns:

the hubName value.

setHubName

public DeviceLifeCycleEventProperties setHubName(String hubName)

Set the hubName property: Name of the IoT Hub where the device was created or deleted.

Parameters:

hubName - the hubName value to set.

Returns:

the DeviceLifeCycleEventProperties object itself.

getTwin

public DeviceTwinInfo getTwin()

Get the twin property: Information about the device twin, which is the cloud representation of application device metadata.

Returns:

the twin value.

setTwin

public DeviceLifeCycleEventProperties setTwin(DeviceTwinInfo twin)

Set the twin property: Information about the device twin, which is the cloud representation of application device metadata.

Parameters:

twin - the twin value to set.

Returns:

the DeviceLifeCycleEventProperties object itself.