ServiceBusMessageBatch interface

Paket:

@azure/service-bus

Ein Batch von Nachrichten, den Sie mit der <xref:createBatch> -Methode erstellen können.

Eigenschaften

count	Anzahl der Nachrichten, die dem Batch hinzugefügt wurden.
maxSizeInBytes	Die maximale Größe des Batches in Bytes. Die tryAddMessage Funktion für den Batch gibt zurück false , wenn die hinzugefügte Nachricht dazu führt, dass die Größe des Batches diesen Grenzwert überschreitet. Verwenden Sie die createMessageBatch() -Methode für , Sender um maxSizeInBytes festzulegen.
sizeInBytes	Größe des Batches in Byte, nachdem die dem Batch hinzugefügten Ereignisse in einer einzelnen AMQP-Nachricht codiert wurden.

Methoden

tryAddMessage(ServiceBusMessage | AmqpAnnotatedMessage, TryAddOptions)

Fügt dem Batch eine Nachricht hinzu, sofern dies durch die Größenbeschränkung des Batches zulässig ist. HINWEIS: Denken Sie immer daran, den Rückgabewert dieser Methode zu überprüfen, bevor Sie sie für das nächste Ereignis erneut aufrufen.

Details zur Eigenschaft

count

Anzahl der Nachrichten, die dem Batch hinzugefügt wurden.

count: number

Eigenschaftswert

number

maxSizeInBytes

Die maximale Größe des Batches in Bytes. Die tryAddMessage Funktion für den Batch gibt zurück false , wenn die hinzugefügte Nachricht dazu führt, dass die Größe des Batches diesen Grenzwert überschreitet. Verwenden Sie die createMessageBatch() -Methode für , Sender um maxSizeInBytes festzulegen.

maxSizeInBytes: number

Eigenschaftswert

number

sizeInBytes

Größe des Batches in Byte, nachdem die dem Batch hinzugefügten Ereignisse in einer einzelnen AMQP-Nachricht codiert wurden.

sizeInBytes: number

Eigenschaftswert

number

Details zur Methode

tryAddMessage(ServiceBusMessage | AmqpAnnotatedMessage, TryAddOptions)

Fügt dem Batch eine Nachricht hinzu, sofern dies durch die Größenbeschränkung des Batches zulässig ist. HINWEIS: Denken Sie immer daran, den Rückgabewert dieser Methode zu überprüfen, bevor Sie sie für das nächste Ereignis erneut aufrufen.

function tryAddMessage(message: ServiceBusMessage | AmqpAnnotatedMessage, options?: TryAddOptions): boolean

Parameter

message

ServiceBusMessage | AmqpAnnotatedMessage

Die Meldung, die dem Batch hinzugefügt werden soll.

options

TryAddOptions

Gibt zurück

boolean

Ein boolescher Wert, der angibt, ob die Nachricht dem Batch hinzugefügt wurde oder nicht.