Udostępnij za pośrednictwem

CheckpointStore interface

  • Odwołanie
Pakiet:
@azure/event-hubs

Magazyn punktów kontrolnych przechowuje i pobiera informacje o własności partycji oraz szczegóły punktów kontrolnych dla każdej partycji w danej grupie odbiorców wystąpienia centrum zdarzeń.

Użytkownicy nie mają implementować CheckpointStore. Użytkownicy powinni wybrać istniejące implementacje tego interfejsu, utworzyć wystąpienie go i przekazać go do konstruktora klasy EventHubConsumerClient podczas tworzenia wystąpienia klienta. Użytkownicy nie powinni używać żadnej z metod w magazynie punktów kontrolnych. Są one używane wewnętrznie przez klienta.

Implementacje CheckpointStore można znaleźć na serwerze npm, wyszukując pakiety z prefiksem @azure/eventhub-checkpointstore-.

Metody

claimOwnership(PartitionOwnership[], OperationOptions)

Wywoływana w celu oświadczeń własności listy partycji. Spowoduje to zwrócenie listy partycji, które zostały pomyślnie należące do użytkownika.
listCheckpoints(string, string, string, OperationOptions)

Wyświetla listę wszystkich punktów kontrolnych w magazynie danych dla danej przestrzeni nazw, usługi EventHub i grupy odbiorców.
listOwnership(string, string, string, OperationOptions)

Wywołana 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 żadnych istniejących informacji o własności.
updateCheckpoint(Checkpoint, OperationOptions)

Aktualizuje punkt kontrolny w magazynie danych dla partycji.

Szczegóły metody

claimOwnership(PartitionOwnership[], OperationOptions)

Wywoływana w celu oświadczeń 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

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łynąć 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, usługi 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łynąć 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 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 żadnych 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łynąć 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ą/mają właściciela.

updateCheckpoint(Checkpoint, OperationOptions)

Aktualizuje punkt kontrolny w magazynie danych dla 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łynąć na zachowanie tej metody.

  • abortSignal: sygnał używany do żądania anulowania operacji.
  • tracingOptions: Opcje konfigurowania śledzenia.

Zwraca

Promise<void>