CheckpointStore interface
Magazyn punktów kontrolnych przechowuje i pobiera informacje o własności partycji oraz szczegóły punktu kontrolnego dla każdej partycji w danej grupie odbiorców wystąpienia centrum zdarzeń.
Użytkownicy nie mają zaimplementować elementu CheckpointStore.
Użytkownicy mają wybrać istniejące implementacje tego interfejsu, utworzyć jego wystąpienie i przekazać go do EventHubConsumerClient konstruktora klasy podczas tworzenia wystąpienia klienta.
Użytkownicy nie powinny używać żadnych metod w magazynie punktów kontrolnych. Są one używane wewnętrznie przez klienta.
Implementacje programu CheckpointStore można znaleźć na serwerze npm, wyszukując pakiety z prefiksem @azure/eventhub-checkpointstore-.
Metody
| claim |
Wywoływana w celu przejmowania własności listy partycji. Spowoduje to zwrócenie listy partycji, które zostały pomyślnie należące do użytkownika. |
| list |
Wyświetla listę wszystkich punktów kontrolnych w magazynie danych dla danej przestrzeni nazw, eventhub i grupy odbiorców. |
| list |
Wywołana polecenie w celu pobrania listy wszystkich istniejących własności partycji z bazowego magazynu danych. Może zwrócić puste wyniki, jeśli nie ma istniejących informacji o własności. |
| update |
Aktualizacje punkt kontrolny w magazynie danych partycji. |
Szczegóły metody
claimOwnership(PartitionOwnership[], OperationOptions)
Wywoływana w celu przejmowania własności listy partycji. Spowoduje to zwrócenie listy partycji, które zostały pomyślnie należące do użytkownika.
function claimOwnership(partitionOwnership: PartitionOwnership[], options?: OperationOptions): Promise<PartitionOwnership[]>Parametry
- partitionOwnership
Lista własności partycji, która jest właścicielem tego wystąpienia.
- options
- OperationOptions
Zestaw opcji, które można określić, aby wpływać na zachowanie tej metody.
abortSignal: sygnał używany do żądania anulowania operacji.tracingOptions: Opcje konfigurowania śledzenia.
Zwraca
Promise<PartitionOwnership[]>
Lista partycji, które pomyślnie przejęły własność tego wystąpienia.
listCheckpoints(string, string, string, OperationOptions)
Wyświetla listę wszystkich punktów kontrolnych w magazynie danych dla danej przestrzeni nazw, eventhub i grupy odbiorców.
function listCheckpoints(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<Checkpoint[]>Parametry
- fullyQualifiedNamespace
-
string
W pełni kwalifikowana przestrzeń nazw usługi Event Hubs. Prawdopodobnie będzie to podobne do .servicebus.windows.net.
- eventHubName
-
string
Nazwa centrum zdarzeń.
- consumerGroup
-
string
Nazwa grupy odbiorców.
- options
- OperationOptions
Zestaw opcji, które można określić, aby wpływać na zachowanie tej metody.
abortSignal: sygnał używany do żądania anulowania operacji.tracingOptions: Opcje konfigurowania śledzenia.
Zwraca
Promise<Checkpoint[]>
Lista punktów kontrolnych dla danej przestrzeni nazw, witryny eventhub i grupy odbiorców.
listOwnership(string, string, string, OperationOptions)
Wywołana polecenie w celu pobrania listy wszystkich istniejących własności partycji z bazowego magazynu danych. Może zwrócić puste wyniki, jeśli nie ma istniejących informacji o własności.
function listOwnership(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<PartitionOwnership[]>Parametry
- fullyQualifiedNamespace
-
string
W pełni kwalifikowana przestrzeń nazw usługi Event Hubs. Prawdopodobnie będzie to podobne do .servicebus.windows.net.
- eventHubName
-
string
Nazwa centrum zdarzeń.
- consumerGroup
-
string
Nazwa grupy odbiorców.
- options
- OperationOptions
Zestaw opcji, które można określić, aby wpływać na zachowanie tej metody.
abortSignal: sygnał używany do żądania anulowania operacji.tracingOptions: Opcje konfigurowania śledzenia.
Zwraca
Promise<PartitionOwnership[]>
Lista szczegółów własności partycji wszystkich partycji, które mają/miał właściciela.
updateCheckpoint(Checkpoint, OperationOptions)
Aktualizacje punkt kontrolny w magazynie danych partycji.
function updateCheckpoint(checkpoint: Checkpoint, options?: OperationOptions): Promise<void>Parametry
- checkpoint
- Checkpoint
Punkt kontrolny.
- options
- OperationOptions
Zestaw opcji, które można określić, aby wpływać na zachowanie tej metody.
abortSignal: sygnał używany do żądania anulowania operacji.tracingOptions: Opcje konfigurowania śledzenia.
Zwraca
Promise<void>