EventDataBatch interface
Uma interface que representa um lote de eventos que podem ser utilizados para enviar eventos para o Hub de Eventos.
Para criar o lote, utilize o createBatch() método no EventHubProducerClient.
Para enviar o lote, utilize o sendBatch() método no mesmo cliente.
Para preencher o lote, utilize 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 após os eventos adicionados à mesma terem sido codificados numa única mensagem AMQP. |
Métodos
| try |
Adiciona um evento ao lote, se permitido pelo limite de tamanho do lote. NOTA: lembre-se sempre de verificar o valor devolvido deste método antes de o chamar novamente para o evento seguinte. |
Detalhes de Propriedade
count
Número de eventos adicionados ao lote.
count: numberValor de Propriedade
number
maxSizeInBytes
O tamanho máximo do lote, em bytes. A tryAdd função no lote será devolvida false se o evento que está a ser adicionado fizer com que o tamanho do lote exceda este limite. Utilize o createBatch() método no EventHubProducerClient para definir maxSizeInBytes.
maxSizeInBytes: numberValor de Propriedade
number
sizeInBytes
Tamanho do lote em bytes após os eventos adicionados à mesma terem sido codificados numa única mensagem AMQP.
sizeInBytes: numberValor 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 devolvido deste método antes de o chamar novamente para o evento seguinte.
function tryAdd(eventData: EventData | AmqpAnnotatedMessage, options?: TryAddOptions): booleanParâmetros
- eventData
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.