ReceivedEventData interface
Interfaz que describe la estructura del evento recibido del centro de eventos.
Úselo como referencia al crear la función processEvents
para procesar los eventos recibidos de un centro de eventos al usar el EventHubConsumerClient
.
Propiedades
body | Cuerpo del mensaje que debe enviarse o recibirse. |
content |
Tipo de contenido del mensaje. Opcionalmente, describe la carga del mensaje, con un descriptor que sigue el formato de RFC2045, sección 5, por ejemplo "application/json". |
correlation |
Identificador de correlación que permite a una aplicación especificar un contexto para el mensaje con fines de correlación, por ejemplo, reflejando el MessageId de un mensaje al que se va a responder. |
enqueued |
Hora puesta en cola del evento. |
message |
El identificador del mensaje es un valor definido por la aplicación que identifica de forma única el mensaje y su carga. |
offset | Desplazamiento del evento. |
partition |
Cuando se especifica Event Hubs, se aplica un hash a un partitionId. Garantiza que los mensajes terminan en una partición específica en el centro de eventos. |
properties | Propiedades específicas de la aplicación. |
sequence |
Número de secuencia del evento. |
system |
Propiedades establecidas por el servicio. |
Métodos
get |
Devuelve el mensaje amqp sin formato subyacente. |
Detalles de las propiedades
body
Cuerpo del mensaje que debe enviarse o recibirse.
body: any
Valor de propiedad
any
contentType
Tipo de contenido del mensaje. Opcionalmente, describe la carga del mensaje, con un descriptor que sigue el formato de RFC2045, sección 5, por ejemplo "application/json".
contentType?: string
Valor de propiedad
string
correlationId
Identificador de correlación que permite a una aplicación especificar un contexto para el mensaje con fines de correlación, por ejemplo, reflejando el MessageId de un mensaje al que se va a responder.
correlationId?: string | number | Buffer
Valor de propiedad
string | number | Buffer
enqueuedTimeUtc
Hora puesta en cola del evento.
enqueuedTimeUtc: Date
Valor de propiedad
Date
messageId
El identificador del mensaje es un valor definido por la aplicación que identifica de forma única el mensaje y su carga.
messageId?: string | number | Buffer
Valor de propiedad
string | number | Buffer
offset
Desplazamiento del evento.
offset: number
Valor de propiedad
number
partitionKey
Cuando se especifica Event Hubs, se aplica un hash a un partitionId. Garantiza que los mensajes terminan en una partición específica en el centro de eventos.
partitionKey: null | string
Valor de propiedad
null | string
properties
Propiedades específicas de la aplicación.
properties?: {[key: string]: any}
Valor de propiedad
{[key: string]: any}
sequenceNumber
Número de secuencia del evento.
sequenceNumber: number
Valor de propiedad
number
systemProperties
Propiedades establecidas por el servicio.
systemProperties?: {[key: string]: any}
Valor de propiedad
{[key: string]: any}
Detalles del método
getRawAmqpMessage()
Devuelve el mensaje amqp sin formato subyacente.
function getRawAmqpMessage(): AmqpAnnotatedMessage