com.microsoft.azure.eventgrid.models

Class DeviceLifeCycleEventProperties

java.lang.Object

com.microsoft.azure.eventgrid.models.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 and Description
DeviceLifeCycleEventProperties()

Method Summary

Modifier and Type	Method and Description
String	deviceId() Get the unique identifier of the device.
String	hubName() Get name of the IoT Hub where the device was created or deleted.
String	operationTimestamp() Get the ISO8601 timestamp of the operation.
String	opType() Get the event type specified for this operation by the IoT Hub.
DeviceTwinInfo	twin() Get information about the device twin, which is the cloud represenation of application device metadata.
DeviceLifeCycleEventProperties	withDeviceId(String deviceId) Set the unique identifier of the device.
DeviceLifeCycleEventProperties	withHubName(String hubName) Set name of the IoT Hub where the device was created or deleted.
DeviceLifeCycleEventProperties	withOperationTimestamp(String operationTimestamp) Set the ISO8601 timestamp of the operation.
DeviceLifeCycleEventProperties	withOpType(String opType) Set the event type specified for this operation by the IoT Hub.
DeviceLifeCycleEventProperties	withTwin(DeviceTwinInfo twin) Set information about the device twin, which is the cloud represenation 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

deviceId

public String deviceId()

Get 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

withDeviceId

public DeviceLifeCycleEventProperties withDeviceId(String deviceId)

Set 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.

hubName

public String hubName()

Get name of the IoT Hub where the device was created or deleted.

Returns:

the hubName value

withHubName

public DeviceLifeCycleEventProperties withHubName(String hubName)

Set name of the IoT Hub where the device was created or deleted.

Parameters:

hubName - the hubName value to set

Returns:

the DeviceLifeCycleEventProperties object itself.

opType

public String opType()

Get the event type specified for this operation by the IoT Hub.

Returns:

the opType value

withOpType

public DeviceLifeCycleEventProperties withOpType(String opType)

Set the event type specified for this operation by the IoT Hub.

Parameters:

opType - the opType value to set

Returns:

the DeviceLifeCycleEventProperties object itself.

operationTimestamp

public String operationTimestamp()

Get the ISO8601 timestamp of the operation.

Returns:

the operationTimestamp value

withOperationTimestamp

public DeviceLifeCycleEventProperties withOperationTimestamp(String operationTimestamp)

Set the ISO8601 timestamp of the operation.

Parameters:

operationTimestamp - the operationTimestamp value to set

Returns:

the DeviceLifeCycleEventProperties object itself.

twin

public DeviceTwinInfo twin()

Get information about the device twin, which is the cloud represenation of application device metadata.

Returns:

the twin value

withTwin

public DeviceLifeCycleEventProperties withTwin(DeviceTwinInfo twin)

Set information about the device twin, which is the cloud represenation of application device metadata.

Parameters:

twin - the twin value to set

Returns:

the DeviceLifeCycleEventProperties object itself.