ServiceBusMessageBatch interface

Paket:

@azure/service-bus

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

Eigenschaften

count	Die Anzahl der Nachrichten, die dem Batch hinzugefügt wurden.
maxSizeInBytes	Die maximale Größe des Batches in Byte. Die tryAddMessage-Funktion im Batch gibt false zurück, wenn die hinzugefügte Nachricht bewirkt, dass die Größe des Batches diesen Grenzwert überschreitet. Verwenden Sie die createMessageBatch()-Methode für die Sender, um die maxSizeInBytes festzulegen.
sizeInBytes	Größe des Batches in Byte, nachdem die ereignisse, die ihr hinzugefügt wurden, in eine einzelne 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 ihn erneut für das nächste Ereignis aufrufen.

Details zur Eigenschaft

count

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

count: number

Eigenschaftswert

number

maxSizeInBytes

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

maxSizeInBytes: number

Eigenschaftswert

number

sizeInBytes

Größe des Batches in Byte, nachdem die ereignisse, die ihr hinzugefügt wurden, in eine einzelne 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 ihn erneut für das nächste Ereignis aufrufen.

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

Parameter

message

ServiceBusMessage | AmqpAnnotatedMessage

Die Nachricht, 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.