EventProcessorClient.GetCheckpointAsync(String, CancellationToken) メソッド

定義

名前空間:

Azure.Messaging.EventHubs

アセンブリ:

Azure.Messaging.EventHubs.Processor.dll

パッケージ:

Azure.Messaging.EventHubs.Processor v5.11.3

ソース:

EventProcessorClient.cs

特定のパーティションの処理を適切に初期化できるように、イベント プロセッサ インスタンスに関連付けられているイベント ハブ、コンシューマー グループ、およびパーティション ID のチェックポイントを返します。

protected override System.Threading.Tasks.Task<Azure.Messaging.EventHubs.Primitives.EventProcessorCheckpoint> GetCheckpointAsync (string partitionId, System.Threading.CancellationToken cancellationToken);

override this.GetCheckpointAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Messaging.EventHubs.Primitives.EventProcessorCheckpoint>

Protected Overrides Function GetCheckpointAsync (partitionId As String, cancellationToken As CancellationToken) As Task(Of EventProcessorCheckpoint)

パラメーター

partitionId

String

チェックポイントを取得するパーティションの ID。

cancellationToken

CancellationToken

CancellationToken処理を取り消す要求を通知する インスタンス。 これは、プロセッサがシャットダウンするときに発生する可能性が最も高いです。

戻り値

Task<EventProcessorCheckpoint>

パーティションを初期化するときに考慮するプロセッサのチェックポイント。

注釈

パーティションに対応するチェックポイントがない場合は、ハンドラーによって設定された既定の PartitionInitializingAsync 開始位置が適用されます。 パーティション固有の開始点が指定されていない場合は、 DefaultStartingPosition を使用して、処理のためにパーティションを初期化します。