ServiceBusMessageBatch interface

パッケージ:

@azure/service-bus

メソッドを使用して作成できるメッセージの <xref:createBatch> バッチ。

プロパティ

count	バッチに追加されたメッセージの数。
maxSizeInBytes	バッチの最大サイズ (バイト単位)。 追加されるメッセージによってバッチのサイズがこの制限を超えた場合、バッチの関数は tryAddMessage を返 false します。 createMessageBatch() maxSizeInBytes を設定するには、 の メソッドSenderを使用します。
sizeInBytes	追加されたイベントが 1 つの AMQP メッセージにエンコードされた後のバッチのサイズ (バイト単位)。

メソッド

tryAddMessage(ServiceBusMessage | AmqpAnnotatedMessage, TryAddOptions)

バッチのサイズ制限で許可されている場合は、メッセージをバッチに追加します。 注: 次のイベントに対して再度呼び出す前に、必ずこのメソッドの戻り値を確認してください。

プロパティの詳細

count

バッチに追加されたメッセージの数。

count: number

プロパティ値

number

maxSizeInBytes

バッチの最大サイズ (バイト単位)。 追加されるメッセージによってバッチのサイズがこの制限を超えた場合、バッチの関数は tryAddMessage を返 false します。 createMessageBatch() maxSizeInBytes を設定するには、 の メソッドSenderを使用します。

maxSizeInBytes: number

プロパティ値

number

sizeInBytes

追加されたイベントが 1 つの AMQP メッセージにエンコードされた後のバッチのサイズ (バイト単位)。

sizeInBytes: number

プロパティ値

number

メソッドの詳細

tryAddMessage(ServiceBusMessage | AmqpAnnotatedMessage, TryAddOptions)

バッチのサイズ制限で許可されている場合は、メッセージをバッチに追加します。 注: 次のイベントに対して再度呼び出す前に、必ずこのメソッドの戻り値を確認してください。

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

パラメーター

message

ServiceBusMessage | AmqpAnnotatedMessage

バッチに追加するメッセージ。

options

TryAddOptions

戻り値

boolean

メッセージがバッチに追加されたかどうかを示すブール値。