CreateBatchOptions interface

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

Opções para configurar o método createBatch no EventHubProducerClient.

  • partitionKey : Um valor que é colocado em hash para produzir uma atribuição de partição.
  • maxSizeInBytes: O limite superior para o tamanho do lote.
  • abortSignal : Um sinal do pedido para cancelar a operação de envio.

Exemplo de uso:

{
    partitionKey: 'foo',
    maxSizeInBytes: 1024 * 1024 // 1 MB
}
Extends
OperationOptions

Propriedades

maxSizeInBytes

O limite superior para o tamanho do lote. A função tryAdd retornará false após esse limite ser atingido.
partitionId

A partição para a qual este lote será enviado. Se esse valor for definido, partitionKey não poderá ser definido.
partitionKey

Um valor que é colocado em hash para produzir uma atribuição de partição. Ele garante que as mensagens com a mesma partitionKey acabem na mesma partição. Se este valor estiver definido, partitionId não pode ser definido.

Propriedades Herdadas

abortSignal

O sinal que pode ser usado para abortar solicitações.
tracingOptions

Opções para configurar o rastreamento.

Detalhes de Propriedade

maxSizeInBytes

O limite superior para o tamanho do lote. A função tryAdd retornará false após esse limite ser atingido.

maxSizeInBytes?: number

Valor de Propriedade

number

partitionId

A partição para a qual este lote será enviado. Se esse valor for definido, partitionKey não poderá ser definido.

partitionId?: string

Valor de Propriedade

string

partitionKey

Um valor que é colocado em hash para produzir uma atribuição de partição. Ele garante que as mensagens com a mesma partitionKey acabem na mesma partição. Se este valor estiver definido, partitionId não pode ser definido.

partitionKey?: string

Valor de Propriedade

string

Detalhes da Propriedade Herdada

abortSignal

O sinal que pode ser usado para abortar solicitações.

abortSignal?: AbortSignalLike

Valor de Propriedade

AbortSignalLike

herdado de OperationOptions.abortSignal

tracingOptions

Opções para configurar o rastreamento.

tracingOptions?: OperationTracingOptions

Valor de Propriedade

OperationTracingOptions

herdado doOperationOptions.tracingOptions