EventDataBatch interface

Pacote:

@azure/event-hubs

Uma interface que representa um lote de eventos que pode ser usado para enviar eventos para o Hub de Eventos.

Para criar o lote, use o método createBatch() no EventHubProducerClient. Para enviar o lote, use o método sendBatch() no mesmo cliente. Para encher o lote, use o método tryAdd() no próprio lote.

Propriedades

count	Número de eventos adicionados ao lote.
maxSizeInBytes	O tamanho máximo do lote, em bytes. A função tryAdd no lote retornará false se o evento que está sendo adicionado fizer com que o tamanho do lote exceda esse limite. Use o método createBatch() no EventHubProducerClient para definir maxSizeInBytes.
sizeInBytes	Tamanho do lote em bytes depois que os eventos adicionados a ele foram codificados em uma única mensagem AMQP.

Métodos

tryAdd(EventData | AmqpAnnotatedMessage, TryAddOptions)

Adiciona um evento ao lote se permitido pelo limite de tamanho do lote. NOTA: Lembre-se sempre de verificar o valor de retorno deste método, antes de chamá-lo novamente para o próximo evento.

Detalhes de Propriedade

count

Número de eventos adicionados ao lote.

count: number

Valor de Propriedade

number

maxSizeInBytes

O tamanho máximo do lote, em bytes. A função tryAdd no lote retornará false se o evento que está sendo adicionado fizer com que o tamanho do lote exceda esse limite. Use o método createBatch() no EventHubProducerClient para definir maxSizeInBytes.

maxSizeInBytes: number

Valor de Propriedade

number

sizeInBytes

Tamanho do lote em bytes depois que os eventos adicionados a ele foram codificados em uma única mensagem AMQP.

sizeInBytes: number

Valor de Propriedade

number

Detalhes de Método

tryAdd(EventData | AmqpAnnotatedMessage, TryAddOptions)

Adiciona um evento ao lote se permitido pelo limite de tamanho do lote. NOTA: Lembre-se sempre de verificar o valor de retorno deste método, antes de chamá-lo novamente para o próximo evento.

function tryAdd(eventData: EventData | AmqpAnnotatedMessage, options?: TryAddOptions): boolean

Parâmetros

eventData

EventData | AmqpAnnotatedMessage

Um objeto de dados de evento individual ou AmqpAnnotatedMessage.

options

TryAddOptions

Devoluções

boolean

Um valor booleano que indica se os dados do evento foram adicionados ao lote ou não.