CreateBatchOptions interface

Balíček:

@azure/event-hubs

Možnosti konfigurace metody createBatch na EventHubProducerClient.

• partitionKey: Hodnota hash, která vytvoří přiřazení oddílu.
• maxSizeInBytes: Horní limit velikosti dávky.
• abortSignal: Signál žádosti o zrušení operace odeslání.

Příklad použití:

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

Extends

OperationOptions

Vlastnosti

maxSizeInBytes	Horní limit velikosti dávky. Funkce tryAdd vrátí false po dosažení tohoto limitu.
partitionId	Do oddílu se tato dávka odešle. Pokud je tato hodnota nastavená, nelze nastavit partitionKey.
partitionKey	Hodnota hash, která vytvoří přiřazení oddílu. Zaručuje, že zprávy se stejným klíčem partitionKey skončí ve stejném oddílu. Pokud je tato hodnota nastavená, id oddílu nelze nastavit.

Zděděné vlastnosti

abortSignal	Signál, který lze použít k přerušení požadavků.
tracingOptions	Možnosti konfigurace trasování

Podrobnosti vlastnosti

maxSizeInBytes

Horní limit velikosti dávky. Funkce tryAdd vrátí false po dosažení tohoto limitu.

maxSizeInBytes?: number

Hodnota vlastnosti

number

partitionId

Do oddílu se tato dávka odešle. Pokud je tato hodnota nastavená, nelze nastavit partitionKey.

partitionId?: string

Hodnota vlastnosti

string

partitionKey

Hodnota hash, která vytvoří přiřazení oddílu. Zaručuje, že zprávy se stejným klíčem partitionKey skončí ve stejném oddílu. Pokud je tato hodnota nastavená, id oddílu nelze nastavit.

partitionKey?: string

Hodnota vlastnosti

string

Podrobnosti zděděných vlastností

abortSignal

Signál, který lze použít k přerušení požadavků.

abortSignal?: AbortSignalLike

Hodnota vlastnosti

AbortSignalLike

zděděno zOperationOptions.abortSignal

tracingOptions

Možnosti konfigurace trasování

tracingOptions?: OperationTracingOptions

Hodnota vlastnosti

OperationTracingOptions

zděděno zOperationOptions.tracingOptions