Class AioCloudEventBuilder

Namespace

Azure.Iot.Operations.Connector.CloudEvents

Assembly

Azure.Iot.Operations.Connector.dll

Builds AIO CloudEvents according to the message_correlation.md specification.

public static class AioCloudEventBuilder

Inheritance

object

AioCloudEventBuilder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

Build(Device, string, string, Asset, AssetDataset, string, string?, MessageSchemaReference?)

Builds AIO CloudEvent for a specific asset and dataset combination.

public static AioCloudEvent Build(Device device, string deviceName, string endpointName, Asset asset, AssetDataset dataset, string assetName, string? protocolSpecificIdentifier = null, MessageSchemaReference? messageSchemaReference = null)

Parameters

device Device

ADR Device model.

deviceName string

Device name for fallback in source/subject generation.

endpointName string

Endpoint name from the asset's deviceRef.

asset Asset

ADR Asset model.

dataset AssetDataset

ADR AssetDataset model.

assetName string

Asset name.

protocolSpecificIdentifier string

Optional protocol specific identifier.

messageSchemaReference MessageSchemaReference

Optional message schema reference reported to ADR. Used to construct the aio-sr:// DataSchema URI.

Returns

AioCloudEvent

Generated AIO CloudEvent.

Build(Device, string, string, Asset, AssetEvent, string, string, string?, MessageSchemaReference?)

Builds AIO CloudEvent for a specific asset and event combination.

public static AioCloudEvent Build(Device device, string deviceName, string endpointName, Asset asset, AssetEvent assetEvent, string assetName, string eventGroupName, string? protocolSpecificIdentifier = null, MessageSchemaReference? messageSchemaReference = null)

Parameters

device Device

ADR Device model.

deviceName string

Device name for fallback in source/subject generation.

endpointName string

Endpoint name from the asset's deviceRef.

asset Asset

ADR Asset model.

assetEvent AssetEvent

ADR AssetEvent model.

assetName string

Asset name for fallback in subject generation.

eventGroupName string

Event group name.

protocolSpecificIdentifier string

Optional protocol specific identifier.

messageSchemaReference MessageSchemaReference

Optional message schema reference reported to ADR. Used to construct the aio-sr:// DataSchema URI.

Returns

AioCloudEvent

Generated AIO CloudEvent.