CreateBatchOptions interface

Paquet:

@azure/event-hubs

Options permettant de configurer la méthode createBatch sur la EventHubProducerClient.

• partitionKey : valeur hachée pour produire une affectation de partition.
• maxSizeInBytes: limite supérieure pour la taille du lot.
• abortSignal : signalez la demande d’annulation de l’opération d’envoi.

Exemple d’utilisation :

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

Extends

OperationOptions

Propriétés

maxSizeInBytes	Limite supérieure pour la taille du lot. La fonction tryAdd retourne false une fois cette limite atteinte.
partitionId	La partition à laquelle ce lot sera envoyé. Si cette valeur est définie, partitionKey ne peut pas être définie.
partitionKey	Valeur hachée pour produire une affectation de partition. Il garantit que les messages avec la même partitionKey se retrouvent dans la même partition. Si cette valeur est définie, partitionId ne peut pas être défini.

Propriétés héritées

abortSignal	Signal qui peut être utilisé pour abandonner les demandes.
tracingOptions	Options de configuration du suivi.

Détails de la propriété

maxSizeInBytes

Limite supérieure pour la taille du lot. La fonction tryAdd retourne false une fois cette limite atteinte.

maxSizeInBytes?: number

Valeur de propriété

number

partitionId

La partition à laquelle ce lot sera envoyé. Si cette valeur est définie, partitionKey ne peut pas être définie.

partitionId?: string

Valeur de propriété

string

partitionKey

Valeur hachée pour produire une affectation de partition. Il garantit que les messages avec la même partitionKey se retrouvent dans la même partition. Si cette valeur est définie, partitionId ne peut pas être défini.

partitionKey?: string

Valeur de propriété

string

Détails de la propriété héritée

abortSignal

Signal qui peut être utilisé pour abandonner les demandes.

abortSignal?: AbortSignalLike

Valeur de propriété

AbortSignalLike

héritée deOperationOptions.abortSignal

tracingOptions

Options de configuration du suivi.

tracingOptions?: OperationTracingOptions

Valeur de propriété

OperationTracingOptions

héritée deOperationOptions.tracingOptions