ReceivedEventData interface

Pacote:

@azure/event-hubs

A interface que descreve a estrutura do evento recebido do Hub de Eventos. Use isso como uma referência ao criar a função processEvents para processar os eventos recebidos de um Hub de Eventos ao usar o EventHubConsumerClient.

Propriedades

body	O corpo da mensagem que precisa ser enviada ou recebida.
contentType	O tipo de conteúdo da mensagem. Opcionalmente, descreve a carga útil da mensagem, com um descritor seguindo o formato de RFC2045, Seção 5, por exemplo, "application/json".
correlationId	O identificador de correlação que permite que um aplicativo especifique um contexto para a mensagem para fins de correlação, por exemplo, refletindo o MessageId de uma mensagem que está sendo respondida.
enqueuedTimeUtc	O tempo enfileirado do evento.
messageId	O identificador de mensagem é um valor definido pelo aplicativo que identifica exclusivamente a mensagem e sua carga útil.
offset	O deslocamento do evento.
partitionKey	Quando especificado, o Hub de Eventos fará hash para um partitionId. Ele garante que as mensagens acabem em uma partição específica no hub de eventos.
properties	As propriedades específicas do aplicativo.
sequenceNumber	O número de sequência do evento.
systemProperties	As propriedades definidas pelo serviço.

Métodos

getRawAmqpMessage()

Retorna a mensagem amqp bruta subjacente.

Detalhes de Propriedade

body

O corpo da mensagem que precisa ser enviada ou recebida.

body: any

Valor de Propriedade

any

contentType

O tipo de conteúdo da mensagem. Opcionalmente, descreve a carga útil da mensagem, com um descritor seguindo o formato de RFC2045, Seção 5, por exemplo, "application/json".

contentType?: string

Valor de Propriedade

string

correlationId

O identificador de correlação que permite que um aplicativo especifique um contexto para a mensagem para fins de correlação, por exemplo, refletindo o MessageId de uma mensagem que está sendo respondida.

correlationId?: string | number | Buffer

Valor de Propriedade

string | number | Buffer

enqueuedTimeUtc

O tempo enfileirado do evento.

enqueuedTimeUtc: Date

Valor de Propriedade

Date

messageId

O identificador de mensagem é um valor definido pelo aplicativo que identifica exclusivamente a mensagem e sua carga útil.

messageId?: string | number | Buffer

Valor de Propriedade

string | number | Buffer

offset

O deslocamento do evento.

offset: number

Valor de Propriedade

number

partitionKey

Quando especificado, o Hub de Eventos fará hash para um partitionId. Ele garante que as mensagens acabem em uma partição específica no hub de eventos.

partitionKey: null | string

Valor de Propriedade

null | string

properties

As propriedades específicas do aplicativo.

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

Valor de Propriedade

{[key: string]: any}

sequenceNumber

O número de sequência do evento.

sequenceNumber: number

Valor de Propriedade

number

systemProperties

As propriedades definidas pelo serviço.

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

Valor de Propriedade

{[key: string]: any}

Detalhes de Método

getRawAmqpMessage()

Retorna a mensagem amqp bruta subjacente.

function getRawAmqpMessage(): AmqpAnnotatedMessage

Devoluções

AmqpAnnotatedMessage