CheckpointStore interface
Ein Prüfpunktspeicher speichert und ruft Partitionsbesitzinformationen und Prüfpunktdetails für jede Partition in einer bestimmten Consumergruppe einer Event Hub-Instanz ab.
Benutzer sind nicht dafür vorgesehen, ein CheckpointStorezu implementieren.
Benutzer müssen vorhandene Implementierungen dieser Schnittstelle auswählen, instanziieren und an den EventHubConsumerClient Klassenkonstruktor übergeben, wenn sie einen Client instanziieren.
Es wird nicht erwartet, dass Benutzer 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 im Besitz waren. |
| list |
Listet alle Prüfpunkte in einem Datenspeicher für einen bestimmten Namespace, eventhub und eine bestimmte Consumergruppe 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 |
Aktualisierungen 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 im Besitz waren.
function claimOwnership(partitionOwnership: PartitionOwnership[], options?: OperationOptions): Promise<PartitionOwnership[]>Parameter
- partitionOwnership
Die Liste der Partitionsbesitzer, die diese Instanz für sich beansprucht.
- 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 Abbruchs des Vorgangs verwendet wird. -
tracingOptions: Optionen zum Konfigurieren der Ablaufverfolgung.
Gibt zurück
Promise<PartitionOwnership[]>
Eine Liste der Partitionen, die diese Instanz erfolgreich für sich beansprucht hat.
listCheckpoints(string, string, string, OperationOptions)
Listet alle Prüfpunkte in einem Datenspeicher für einen bestimmten Namespace, eventhub und eine bestimmte Consumergruppe auf.
function listCheckpoints(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<Checkpoint[]>Parameter
- fullyQualifiedNamespace
-
string
Der vollqualifizierte Event Hubs-Namespace. Dies ähnelt wahrscheinlich .servicebus.windows.net.
- eventHubName
-
string
Der Event Hub-Name.
- 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 Abbruchs des Vorgangs verwendet wird. -
tracingOptions: Optionen zum Konfigurieren der Ablaufverfolgung.
Gibt zurück
Promise<Checkpoint[]>
Eine Liste von Prüfpunkten für einen bestimmten Namespace, eventhub und eine Consumergruppe.
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 ähnelt wahrscheinlich .servicebus.windows.net.
- eventHubName
-
string
Der Event Hub-Name.
- 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 Abbruchs des Vorgangs verwendet wird. -
tracingOptions: Optionen zum Konfigurieren der Ablaufverfolgung.
Gibt zurück
Promise<PartitionOwnership[]>
Eine Liste der Partitionsbesitzdetails aller Partitionen, die einen Besitzer haben/hatten.
updateCheckpoint(Checkpoint, OperationOptions)
Aktualisierungen 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 Abbruchs des Vorgangs verwendet wird. -
tracingOptions: Optionen zum Konfigurieren der Ablaufverfolgung.
Gibt zurück
Promise<void>