Compartilhar via

CreateBatchOptions interface

Pacote:
@azure/event-hubs

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

  • partitionKey: um valor que é hash para produzir uma atribuição de partição.
  • maxSizeInBytes: o limite superior para o tamanho do lote.
  • abortSignal: um sinal da solicitação para cancelar a operação de envio.

Uso de exemplo:

{
    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 depois que esse limite for 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 é hash para produzir uma atribuição de partição. Ele garante que as mensagens com a mesma partiçãoKey acabem na mesma partição. Se esse valor for definido, partitionId não poderá ser definido.

Propriedades herdadas

abortSignal

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

Opções para configurar o rastreamento.

Detalhes da propriedade

maxSizeInBytes

O limite superior para o tamanho do lote. A função tryAdd retornará false depois que esse limite for atingido.

maxSizeInBytes?: number

Valor da 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 da propriedade

string

partitionKey

Um valor que é hash para produzir uma atribuição de partição. Ele garante que as mensagens com a mesma partiçãoKey acabem na mesma partição. Se esse valor for definido, partitionId não poderá ser definido.

partitionKey?: string

Valor da propriedade

string

Detalhes das propriedades herdadas

abortSignal

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

abortSignal?: AbortSignalLike

Valor da propriedade

AbortSignalLike

Herdado deOperationOptions.abortSignal

tracingOptions

Opções para configurar o rastreamento.

tracingOptions?: OperationTracingOptions

Valor da propriedade

OperationTracingOptions

Herdado deOperationOptions.tracingOptions