EventDataBatch interface
イベント ハブにイベントを送信するために使用できるイベントのバッチを表すインターフェイス。
バッチを作成するには、 の createBatch() メソッドを使用します EventHubProducerClient。
バッチを送信するには、同じクライアントで メソッドを使用 sendBatch() します。
バッチを入力するには、バッチ自体で tryAdd() メソッドを使用します。
プロパティ
| count | バッチに追加されたイベントの数。 |
| max |
バッチの最大サイズ (バイト単位)。 追加されるイベントによってバッチのサイズがこの制限を超えた場合、バッチの関数は |
| size |
追加されたイベントが 1 つの AMQP メッセージにエンコードされた後のバッチのサイズ (バイト単位)。 |
メソッド
| try |
バッチのサイズ制限で許可されている場合は、バッチにイベントを追加します。 注: 次のイベントに対して再度呼び出す前に、必ずこのメソッドの戻り値を確認してください。 |
プロパティの詳細
count
バッチに追加されたイベントの数。
count: numberプロパティ値
number
maxSizeInBytes
バッチの最大サイズ (バイト単位)。 追加されるイベントによってバッチのサイズがこの制限を超えた場合、バッチの関数は tryAdd を返 false します。
createBatch() maxSizeInBytes を設定するには、 の メソッドEventHubProducerClientを使用します。
maxSizeInBytes: numberプロパティ値
number
sizeInBytes
追加されたイベントが 1 つの AMQP メッセージにエンコードされた後のバッチのサイズ (バイト単位)。
sizeInBytes: numberプロパティ値
number
メソッドの詳細
tryAdd(EventData | AmqpAnnotatedMessage, TryAddOptions)
バッチのサイズ制限で許可されている場合は、バッチにイベントを追加します。 注: 次のイベントに対して再度呼び出す前に、必ずこのメソッドの戻り値を確認してください。
function tryAdd(eventData: EventData | AmqpAnnotatedMessage, options?: TryAddOptions): booleanパラメーター
- eventData
個々のイベント データ オブジェクトまたは AmqpAnnotatedMessage。
- options
- TryAddOptions
戻り値
boolean
イベント データがバッチに追加されているかどうかを示すブール値。