Compartilhar via

ReceivedEventData interface

  • Referência
Pacote:
@azure/event-hubs

A interface que descreve a estrutura do evento recebido do Hub de Eventos. Use isso como 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 enviado ou recebido.
contentType

O tipo de conteúdo da mensagem. Opcionalmente, descreve o conteúdo 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 a MessageId de uma mensagem que está sendo respondeda.
enqueuedTimeUtc

A hora enfileirada do evento.
messageId

O identificador de mensagem é um valor definido pelo aplicativo que identifica exclusivamente a mensagem e seu conteúdo.
offset

O deslocamento do evento.
partitionKey

Quando especificado, o Hub de Eventos fará hash disso em uma 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 da propriedade

body

O corpo da mensagem que precisa ser enviado ou recebido.

body: any

Valor da propriedade

any

contentType

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

contentType?: string

Valor da 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 a MessageId de uma mensagem que está sendo respondeda.

correlationId?: string | number | Buffer

Valor da propriedade

string | number | Buffer

enqueuedTimeUtc

A hora enfileirada do evento.

enqueuedTimeUtc: Date

Valor da propriedade

Date

messageId

O identificador de mensagem é um valor definido pelo aplicativo que identifica exclusivamente a mensagem e seu conteúdo.

messageId?: string | number | Buffer

Valor da propriedade

string | number | Buffer

offset

O deslocamento do evento.

offset: number

Valor da propriedade

number

partitionKey

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

partitionKey: null | string

Valor da propriedade

null | string

properties

As propriedades específicas do aplicativo.

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

Valor da propriedade

{[key: string]: any}

sequenceNumber

O número de sequência do evento.

sequenceNumber: number

Valor da propriedade

number

systemProperties

As propriedades definidas pelo serviço.

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

Valor da propriedade

{[key: string]: any}

Detalhes do método

getRawAmqpMessage()

Retorna a mensagem amqp bruta subjacente.

function getRawAmqpMessage(): AmqpAnnotatedMessage

Retornos

AmqpAnnotatedMessage