CheckpointStore interface
チェックポイント ストアは、イベント ハブ インスタンスの特定のコンシューマー グループ内の各パーティションのパーティション所有権情報とチェックポイントの詳細を格納および取得します。
ユーザーは を CheckpointStore実装するためのものではありません。
ユーザーは、このインターフェイスの既存の実装を選択し、インスタンス化し、クライアントを EventHubConsumerClient インスタンス化するときにクラス コンストラクターに渡す必要があります。
ユーザーはチェックポイント ストアでメソッドを使用することは想定されていません。これらはクライアントによって内部的に使用されます。
の CheckpointStore 実装は、プレフィックス @azure/eventhub-checkpointstore-を持つパッケージを検索することで npm で見つけることができます。
メソッド
| claim |
パーティションの一覧の所有権を要求するために呼び出されます。 これにより、正常に所有されたパーティションの一覧が返されます。 |
| list |
特定の名前空間、eventhub、コンシューマー グループのデータ ストア内のすべてのチェックポイントを一覧表示します。 |
| list |
基になるデータ ストアから既存のすべてのパーティション所有権の一覧を取得するために呼び出されます。 既存の所有権情報がない場合は、空の結果を返す可能性があります。 |
| update |
パーティションのデータ ストア内のチェックポイントを更新します。 |
メソッドの詳細
claimOwnership(PartitionOwnership[], OperationOptions)
パーティションの一覧の所有権を要求するために呼び出されます。 これにより、正常に所有されたパーティションの一覧が返されます。
function claimOwnership(partitionOwnership: PartitionOwnership[], options?: OperationOptions): Promise<PartitionOwnership[]>パラメーター
- partitionOwnership
このインスタンスが所有を要求しているパーティション所有権の一覧。
- options
- OperationOptions
このメソッドの動作に影響を与えるために指定できる一連のオプション。
-
abortSignal: 操作の取り消しを要求するために使用されるシグナル。 -
tracingOptions: トレースを構成するためのオプション。
戻り値
Promise<PartitionOwnership[]>
このインスタンスが正常に所有権を要求したパーティションの一覧。
listCheckpoints(string, string, string, OperationOptions)
特定の名前空間、eventhub、コンシューマー グループのデータ ストア内のすべてのチェックポイントを一覧表示します。
function listCheckpoints(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<Checkpoint[]>パラメーター
- fullyQualifiedNamespace
-
string
完全修飾 Event Hubs の名前空間。 これは.servicebus.windows.net に似ている可能性があります。
- eventHubName
-
string
イベント ハブ名。
- consumerGroup
-
string
コンシューマー グループ名。
- options
- OperationOptions
このメソッドの動作に影響を与えるために指定できる一連のオプション。
-
abortSignal: 操作の取り消しを要求するために使用されるシグナル。 -
tracingOptions: トレースを構成するためのオプション。
戻り値
Promise<Checkpoint[]>
特定の名前空間、イベント ハブ、コンシューマー グループのチェックポイントの一覧。
listOwnership(string, string, string, OperationOptions)
基になるデータ ストアから既存のすべてのパーティション所有権の一覧を取得するために呼び出されます。 既存の所有権情報がない場合は、空の結果を返す可能性があります。
function listOwnership(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<PartitionOwnership[]>パラメーター
- fullyQualifiedNamespace
-
string
完全修飾 Event Hubs の名前空間。 これは.servicebus.windows.net に似ている可能性があります。
- eventHubName
-
string
イベント ハブ名。
- consumerGroup
-
string
コンシューマー グループ名。
- options
- OperationOptions
このメソッドの動作に影響を与えるために指定できる一連のオプション。
-
abortSignal: 操作の取り消しを要求するために使用されるシグナル。 -
tracingOptions: トレースを構成するためのオプション。
戻り値
Promise<PartitionOwnership[]>
所有者が存在する/持っていたすべてのパーティションのパーティション所有権の詳細の一覧。
updateCheckpoint(Checkpoint, OperationOptions)
パーティションのデータ ストア内のチェックポイントを更新します。
function updateCheckpoint(checkpoint: Checkpoint, options?: OperationOptions): Promise<void>パラメーター
- checkpoint
- Checkpoint
チェックポイント。
- options
- OperationOptions
このメソッドの動作に影響を与えるために指定できる一連のオプション。
-
abortSignal: 操作の取り消しを要求するために使用されるシグナル。 -
tracingOptions: トレースを構成するためのオプション。
戻り値
Promise<void>