CheckpointStore interface
檢查點存放區會儲存並擷取事件中樞實例指定取用者群組中每個分割區的分割區擁有權資訊和檢查點詳細數據。
使用者不打算實作 CheckpointStore。
用戶預期會在具現化用戶端時，選擇此介面的現有實作、具現化，並將它傳遞給 EventHubConsumerClient 類別建構函式。
使用者不預期會在檢查點存放區上使用任何方法，用戶端會在內部使用這些方法。
您可以在 npm 上搜尋具有前置詞@azure/eventhub-checkpointstore-的套件，以找到 CheckpointStore 實作。
方法
| claim |
呼叫 以宣告數據分割清單的擁有權。 這會傳回已成功擁有的數據分割清單。 |
| list |
列出指定命名空間、eventhub 和取用者群組之數據存放區中的所有檢查點。 |
| list |
呼叫 以從基礎數據存放區取得所有現有數據分割擁有權的清單。 如果沒有現有的擁有權資訊，可能會傳回空的結果。 |
| update |
更新數據分割數據存放區中的檢查點。 |
方法詳細資料
claimOwnership(PartitionOwnership[], OperationOptions)
呼叫 以宣告數據分割清單的擁有權。 這會傳回已成功擁有的數據分割清單。
function claimOwnership(partitionOwnership: PartitionOwnership[], options?: OperationOptions): Promise<PartitionOwnership[]>參數
- partitionOwnership
這個實例宣告擁有的數據分割擁有權清單。
傳回
Promise<PartitionOwnership[]>
此實例成功宣告擁有權的數據分割清單。
listCheckpoints(string, string, string, OperationOptions)
列出指定命名空間、eventhub 和取用者群組之數據存放區中的所有檢查點。
function listCheckpoints(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<Checkpoint[]>參數
- fullyQualifiedNamespace
-
string
完整事件中樞命名空間。 這可能類似於 .servicebus.windows.net。
- eventHubName
-
string
事件中樞名稱。
- consumerGroup
-
string
取用者組名。
傳回
Promise<Checkpoint[]>
指定命名空間、eventhub 和取用者群組的檢查點清單。
listOwnership(string, string, string, OperationOptions)
呼叫 以從基礎數據存放區取得所有現有數據分割擁有權的清單。 如果沒有現有的擁有權資訊，可能會傳回空的結果。
function listOwnership(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<PartitionOwnership[]>參數
- fullyQualifiedNamespace
-
string
完整事件中樞命名空間。 這可能類似於 .servicebus.windows.net。
- eventHubName
-
string
事件中樞名稱。
- consumerGroup
-
string
取用者組名。
傳回
Promise<PartitionOwnership[]>
擁有者/擁有者之所有分割區的分割區擁有權詳細數據清單。
updateCheckpoint(Checkpoint, OperationOptions)
更新數據分割數據存放區中的檢查點。
function updateCheckpoint(checkpoint: Checkpoint, options?: OperationOptions): Promise<void>參數
- checkpoint
- Checkpoint
檢查點。
傳回
Promise<void>