CheckpointStore interface
In einem Prüfpunktspeicher werden Partitionsbesitzinformationen und Prüfpunktdetails für jede Partition in einer bestimmten Consumergruppe einer Event Hub-Instanz gespeichert und abgerufen.
Benutzer sollen keine CheckpointStoreimplementieren.
Es wird erwartet, dass Benutzer vorhandene Implementierungen dieser Schnittstelle auswählen, instanziieren und beim Instanziieren eines Clients an den EventHubConsumerClient Klassenkonstruktor übergeben.
Benutzer werden nicht davon ausgegangen, dass sie eine der Methoden in einem Prüfpunktspeicher verwenden, diese werden intern vom Client verwendet.
Implementierungen von CheckpointStore finden Sie auf npm, indem Sie nach Paketen mit dem Präfix @azure/eventhub-checkpointstore-suchen.
Methoden
| claim |
Wird aufgerufen, um den Besitz einer Liste von Partitionen zu beanspruchen. Dadurch wird die Liste der Partitionen zurückgegeben, die erfolgreich waren. |
| list |
Listet alle Prüfpunkte in einem Datenspeicher für einen bestimmten Namespace, eventhub und Consumer-Gruppe auf. |
| list |
Wird aufgerufen, um die Liste aller vorhandenen Partitionsbesitzer aus dem zugrunde liegenden Datenspeicher abzurufen. Kann leere Ergebnisse zurückgeben, wenn keine Besitzerinformationen vorhanden sind. |
| update |
Aktualisiert den Prüfpunkt im Datenspeicher für eine Partition. |
Details zur Methode
claimOwnership(PartitionOwnership[], OperationOptions)
Wird aufgerufen, um den Besitz einer Liste von Partitionen zu beanspruchen. Dadurch wird die Liste der Partitionen zurückgegeben, die erfolgreich waren.
function claimOwnership(partitionOwnership: PartitionOwnership[], options?: OperationOptions): Promise<PartitionOwnership[]>Parameter
- partitionOwnership
Die Liste des Partitionsbesitzes, den diese Instanz besitzt.
- options
- OperationOptions
Eine Reihe von Optionen, die angegeben werden können, um das Verhalten dieser Methode zu beeinflussen.
-
abortSignal: Ein Signal, das zum Anfordern des Vorgangsabbruchs verwendet wird. -
tracingOptions: Optionen zum Konfigurieren der Ablaufverfolgung.
Gibt zurück
Promise<PartitionOwnership[]>
Eine Liste der Partitionen, die diese Instanz erfolgreich in Anspruch genommen hat.
listCheckpoints(string, string, string, OperationOptions)
Listet alle Prüfpunkte in einem Datenspeicher für einen bestimmten Namespace, eventhub und Consumer-Gruppe auf.
function listCheckpoints(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<Checkpoint[]>Parameter
- fullyQualifiedNamespace
-
string
Der vollqualifizierte Event Hubs-Namespace. Dies ist wahrscheinlich mit .servicebus.windows.net vergleichbar.
- eventHubName
-
string
Der Name des Event Hubs.
- consumerGroup
-
string
Der Name der Consumergruppe.
- options
- OperationOptions
Eine Reihe von Optionen, die angegeben werden können, um das Verhalten dieser Methode zu beeinflussen.
-
abortSignal: Ein Signal, das zum Anfordern des Vorgangsabbruchs verwendet wird. -
tracingOptions: Optionen zum Konfigurieren der Ablaufverfolgung.
Gibt zurück
Promise<Checkpoint[]>
Eine Liste der Prüfpunkte für einen bestimmten Namespace, eventhub und consumer group.
listOwnership(string, string, string, OperationOptions)
Wird aufgerufen, um die Liste aller vorhandenen Partitionsbesitzer aus dem zugrunde liegenden Datenspeicher abzurufen. Kann leere Ergebnisse zurückgeben, wenn keine Besitzerinformationen vorhanden sind.
function listOwnership(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<PartitionOwnership[]>Parameter
- fullyQualifiedNamespace
-
string
Der vollqualifizierte Event Hubs-Namespace. Dies ist wahrscheinlich mit .servicebus.windows.net vergleichbar.
- eventHubName
-
string
Der Name des Event Hubs.
- consumerGroup
-
string
Der Name der Consumergruppe.
- options
- OperationOptions
Eine Reihe von Optionen, die angegeben werden können, um das Verhalten dieser Methode zu beeinflussen.
-
abortSignal: Ein Signal, das zum Anfordern des Vorgangsabbruchs verwendet wird. -
tracingOptions: Optionen zum Konfigurieren der Ablaufverfolgung.
Gibt zurück
Promise<PartitionOwnership[]>
Eine Liste der Partitionsbesitzerdetails aller Partitionen, die über einen Besitzer verfügen/hatten.
updateCheckpoint(Checkpoint, OperationOptions)
Aktualisiert den Prüfpunkt im Datenspeicher für eine Partition.
function updateCheckpoint(checkpoint: Checkpoint, options?: OperationOptions): Promise<void>Parameter
- checkpoint
- Checkpoint
Der Prüfpunkt.
- options
- OperationOptions
Eine Reihe von Optionen, die angegeben werden können, um das Verhalten dieser Methode zu beeinflussen.
-
abortSignal: Ein Signal, das zum Anfordern des Vorgangsabbruchs verwendet wird. -
tracingOptions: Optionen zum Konfigurieren der Ablaufverfolgung.
Gibt zurück
Promise<void>