EventHubBufferedProducerClient.EnqueueEventsAsync メソッド

定義

名前空間:

Azure.Messaging.EventHubs.Producer

アセンブリ:

Azure.Messaging.EventHubs.dll

パッケージ:

Azure.Messaging.EventHubs v5.10.0

オーバーロード

EnqueueEventsAsync(IEnumerable<EventData>, CancellationToken)	イベント ハブに発行するバッファーに の EventData セットをエンキューします。 このメソッドが呼び出されたときにバッファーに十分な容量がない場合は、空き領域が使用可能になるまで待機し、セット内eventsのすべてのeventsがエンキューされていることを確認します。 この呼び出しが返されると、 events はバッファーに受け入れられますが、まだ発行されていない可能性があります。 発行は、バッファーが処理されるときに、将来、非決定的な時点で行われます。
EnqueueEventsAsync(IEnumerable<EventData>, EnqueueEventOptions, CancellationToken)	イベント ハブに発行するバッファーに の EventData セットをエンキューします。 このメソッドが呼び出されたときにバッファーに十分な容量がない場合は、空き領域が使用可能になるまで待機し、セット内eventsのすべてのeventsがエンキューされていることを確認します。 この呼び出しが返されると、 events はバッファーに受け入れられますが、まだ発行されていない可能性があります。 発行は、バッファーが処理されるときに、将来、非決定的な時点で行われます。

EnqueueEventsAsync(IEnumerable<EventData>, CancellationToken)

イベント ハブに発行するバッファーに の EventData セットをエンキューします。 このメソッドが呼び出されたときにバッファーに十分な容量がない場合は、空き領域が使用可能になるまで待機し、セット内eventsのすべてのeventsがエンキューされていることを確認します。

この呼び出しが返されると、 events はバッファーに受け入れられますが、まだ発行されていない可能性があります。 発行は、バッファーが処理されるときに、将来、非決定的な時点で行われます。

public virtual System.Threading.Tasks.Task<int> EnqueueEventsAsync (System.Collections.Generic.IEnumerable<Azure.Messaging.EventHubs.EventData> events, System.Threading.CancellationToken cancellationToken = default);

abstract member EnqueueEventsAsync : seq<Azure.Messaging.EventHubs.EventData> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>
override this.EnqueueEventsAsync : seq<Azure.Messaging.EventHubs.EventData> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>

Public Overridable Function EnqueueEventsAsync (events As IEnumerable(Of EventData), Optional cancellationToken As CancellationToken = Nothing) As Task(Of Integer)

パラメーター

events

IEnumerable<EventData>

バッファーにエンキューされ、後で発行されるイベントのセット。

cancellationToken

CancellationToken

操作を取り消す要求を通知する省略可能 CancellationToken なインスタンス。

戻り値

Task<Int32>

現在バッファーに格納され、すべてのパーティションでパブリッシュされるのを待機しているイベントの合計数。

例外

InvalidOperationException

ハンドラーが現在登録されていない SendEventBatchFailedAsync 場合に発生します。

注釈

取り消しまたは予期しない例外が発生した場合、このメソッドを呼び出すと、一部 (すべてではなく) events がエンキューされた部分的なエラーが発生する可能性があります。 個々のイベントがエンキューされているかどうかを理解することが重要なシナリオでは、このメソッドの代わりに see EnqueueEventAsync(EventData, EnqueueEventOptions, CancellationToken) または EnqueueEventAsync(EventData, CancellationToken) オーバーロードを呼び出することをお勧めします。

イベントを最初にエンキューしようとすると、 SendEventBatchSucceededAsync ハンドラーと SendEventBatchFailedAsync ハンドラーを変更できなくなります。

EnqueueEventsAsync(IEnumerable<EventData>, EnqueueEventOptions, CancellationToken)

イベント ハブに発行するバッファーに の EventData セットをエンキューします。 このメソッドが呼び出されたときにバッファーに十分な容量がない場合は、空き領域が使用可能になるまで待機し、セット内eventsのすべてのeventsがエンキューされていることを確認します。

この呼び出しが返されると、 events はバッファーに受け入れられますが、まだ発行されていない可能性があります。 発行は、バッファーが処理されるときに、将来、非決定的な時点で行われます。

public virtual System.Threading.Tasks.Task<int> EnqueueEventsAsync (System.Collections.Generic.IEnumerable<Azure.Messaging.EventHubs.EventData> events, Azure.Messaging.EventHubs.Producer.EnqueueEventOptions options, System.Threading.CancellationToken cancellationToken = default);

abstract member EnqueueEventsAsync : seq<Azure.Messaging.EventHubs.EventData> * Azure.Messaging.EventHubs.Producer.EnqueueEventOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>
override this.EnqueueEventsAsync : seq<Azure.Messaging.EventHubs.EventData> * Azure.Messaging.EventHubs.Producer.EnqueueEventOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>

Public Overridable Function EnqueueEventsAsync (events As IEnumerable(Of EventData), options As EnqueueEventOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Integer)

パラメーター

events

IEnumerable<EventData>

バッファーにエンキューされ、後で発行されるイベントのセット。

options

EnqueueEventOptions

これらのイベントを発行するときに適用するオプションのセット。

cancellationToken

CancellationToken

操作を取り消す要求を通知する省略可能 CancellationToken なインスタンス。

戻り値

Task<Int32>

現在バッファーに格納され、すべてのパーティションでパブリッシュされるのを待機しているイベントの合計数。

例外

InvalidOperationException

で無効なパーティション識別子が指定されている場合に発生します options。

注釈

取り消しまたは予期しない例外が発生した場合、このメソッドを呼び出すと、一部 (すべてではなく) events がエンキューされた部分的なエラーが発生する可能性があります。 個々のイベントがエンキューされているかどうかを理解することが重要なシナリオでは、このメソッドの代わりに see EnqueueEventAsync(EventData, EnqueueEventOptions, CancellationToken) または EnqueueEventAsync(EventData, CancellationToken) オーバーロードを呼び出することをお勧めします。

イベントを最初にエンキューしようとすると、 SendEventBatchSucceededAsync ハンドラーと SendEventBatchFailedAsync ハンドラーを変更できなくなります。