Share via

EventDataAdapterParameters interface

  • Reference
Package:
@azure/event-hubs

Parameters to the createEventDataAdapter function that creates an event data adapter.

Properties

correlationId

The correlation identifier that allows an application to specify a context for the message for the purposes of correlation, for example reflecting the MessageId of a message that is being replied to.
messageId

The message identifier is an application-defined value that uniquely identifies the message and its payload.

Note: Numbers that are not whole integers are not allowed.
properties

Set of key value pairs that can be used to set properties specific to user application.

Property Details

correlationId

The correlation identifier that allows an application to specify a context for the message for the purposes of correlation, for example reflecting the MessageId of a message that is being replied to.

correlationId?: string | number | Buffer

Property Value

string | number | Buffer

messageId

The message identifier is an application-defined value that uniquely identifies the message and its payload.

Note: Numbers that are not whole integers are not allowed.

messageId?: string | number | Buffer

Property Value

string | number | Buffer

properties

Set of key value pairs that can be used to set properties specific to user application.

properties?: {[key: string]: any}

Property Value

{[key: string]: any}