Share via

CreateBatchOptions interface

  • Odwołanie
Pakiet:
@azure/event-hubs

Opcje konfigurowania createBatch metody w obiekcie EventHubProducerClient.

  • partitionKey : wartość, która jest skrótem w celu utworzenia przypisania partycji.
  • maxSizeInBytes: górny limit rozmiaru partii.
  • abortSignal : sygnał żądania anulowania operacji wysyłania.

Przykład użycia: 

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

Właściwości

maxSizeInBytes

Górny limit rozmiaru partii. Funkcja zostanie zwrócona tryAddfalse po osiągnięciu tego limitu.
partitionId

Partycja, do tej partii zostanie wysłana. Jeśli ta wartość jest ustawiona, nie można ustawić klucza partycji.
partitionKey

Wartość, która jest skrótem w celu utworzenia przypisania partycji. Gwarantuje to, że komunikaty o tej samej partycjiKey kończą się na tej samej partycji. Jeśli ta wartość jest ustawiona, nie można ustawić identyfikatora partitionId.

Właściwości dziedziczone

abortSignal

Sygnał, który może służyć do przerwania żądań.
tracingOptions

Opcje konfigurowania śledzenia.

Szczegóły właściwości

maxSizeInBytes

Górny limit rozmiaru partii. Funkcja zostanie zwrócona tryAddfalse po osiągnięciu tego limitu.

maxSizeInBytes?: number

Wartość właściwości

number

partitionId

Partycja, do tej partii zostanie wysłana. Jeśli ta wartość jest ustawiona, nie można ustawić klucza partycji.

partitionId?: string

Wartość właściwości

string

partitionKey

Wartość, która jest skrótem w celu utworzenia przypisania partycji. Gwarantuje to, że komunikaty o tej samej partycjiKey kończą się na tej samej partycji. Jeśli ta wartość jest ustawiona, nie można ustawić identyfikatora partitionId.

partitionKey?: string

Wartość właściwości

string

Szczegóły właściwości dziedziczonej

abortSignal

Sygnał, który może służyć do przerwania żądań.

abortSignal?: AbortSignalLike

Wartość właściwości

AbortSignalLike

Dziedziczone zelementu OperationOptions.abortSignal

tracingOptions

Opcje konfigurowania śledzenia.

tracingOptions?: OperationTracingOptions

Wartość właściwości

OperationTracingOptions

Dziedziczone zelementu OperationOptions.tracingOptions