Class IncomingTelemetryMetadata

Namespace

Azure.Iot.Operations.Protocol.Telemetry

Assembly

Azure.Iot.Operations.Protocol.dll

The metadata associated with every message received by a TelemetryReceiver<T>.

public class IncomingTelemetryMetadata

Inheritance

object

IncomingTelemetryMetadata

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Some metadata should be expected if it was sent by a TelemetrySender<T> but may not be present if the message was sent by something else.

Properties

ContentType

The content type of the received message if it was sent with a content type.

public string? ContentType { get; }

Property Value

string

PacketId

The Id of the received MQTT packet.

public uint PacketId { get; }

Property Value

uint

PayloadFormatIndicator

The payload format indicator of the received message.

public MqttPayloadFormatIndicator PayloadFormatIndicator { get; }

Property Value

MqttPayloadFormatIndicator

SenderId

The MQTT client Id of the client that sent this telemetry.

public string? SenderId { get; }

Property Value

string

Remarks

This value is null if the received telemetry did not include the Azure.Iot.Operations.Protocol.AkriSystemProperties.SourceId header.

Timestamp

A timestamp attached to the telemetry message.

public HybridLogicalClock? Timestamp { get; }

Property Value

HybridLogicalClock

Remarks

This value is nullable only because a received message may not have sent it. Any message sent by TelemetrySender<T> will include a non-null timestamp. A message sent by anything else may or may not include this timestamp.

TopicTokens

public Dictionary<string, string> TopicTokens { get; }

Property Value

Dictionary<string, string>

UserData

A dictionary of user properties that are sent along with the telemetry message from the TelemetrySender.

public Dictionary<string, string> UserData { get; }

Property Value

Dictionary<string, string>

Methods

GetCloudEvent()

public CloudEvent GetCloudEvent()

Returns

CloudEvent