EventDataBatch interface
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 createBatch() método no EventHubProducerClient.
Para enviar o lote, use o sendBatch() método no mesmo cliente.
Para preencher o lote, use o tryAdd() método no próprio lote.
Propriedades
| count | Número de eventos adicionados ao lote. |
| max |
O tamanho máximo do lote, em bytes. A |
| size |
Tamanho do lote em bytes depois que os eventos adicionados a ele foram codificados em uma única mensagem AMQP. |
Métodos
| try |
Adiciona um evento ao lote, se permitido pelo limite de tamanho do lote. OBSERVAÇÃO: lembre-se sempre de verificar o valor retornado desse método, antes de chamá-lo novamente para o próximo evento. |
Detalhes da propriedade
count
Número de eventos adicionados ao lote.
count: numberValor da propriedade
number
maxSizeInBytes
O tamanho máximo do lote, em bytes. A tryAdd função no lote retornará false se o evento que está sendo adicionado fizer com que o tamanho do lote exceda esse limite. Use o createBatch() método no EventHubProducerClient para definir maxSizeInBytes.
maxSizeInBytes: numberValor da propriedade
number
sizeInBytes
Tamanho do lote em bytes depois que os eventos adicionados a ele foram codificados em uma única mensagem AMQP.
sizeInBytes: numberValor da propriedade
number
Detalhes do método
tryAdd(EventData | AmqpAnnotatedMessage, TryAddOptions)
Adiciona um evento ao lote, se permitido pelo limite de tamanho do lote. OBSERVAÇÃO: lembre-se sempre de verificar o valor retornado desse método, antes de chamá-lo novamente para o próximo evento.
function tryAdd(eventData: EventData | AmqpAnnotatedMessage, options?: TryAddOptions): booleanParâmetros
- eventData
Um objeto de dados de evento individual ou AmqpAnnotatedMessage.
- options
- TryAddOptions
Retornos
boolean
Um valor booliano que indica se os dados do evento foram adicionados ao lote ou não.