CreateBatchOptions interface

Pakiet:

@azure/event-hubs

Opcje konfigurowania metody createBatch w EventHubProducerClient.

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

Przykładowe użycie:

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

Rozszerzenie

OperationOptions

Właściwości

maxSizeInBytes	Górny limit rozmiaru partii. Funkcja tryAdd zwróci false 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ść skrótu w celu utworzenia przypisania partycji. Gwarantuje to, że komunikaty z tym samym kluczem partycji 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 tryAdd zwróci false 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ść skrótu w celu utworzenia przypisania partycji. Gwarantuje to, że komunikaty z tym samym kluczem partycji 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 zOperationOptions.abortSignal

tracingOptions

Opcje konfigurowania śledzenia.

tracingOptions?: OperationTracingOptions

Wartość właściwości

OperationTracingOptions

dziedziczone zOperationOptions.tracingOptions