CheckpointStore interface
Un magasin de points de contrôle stocke et récupère les informations de propriété de partition et les détails de point de contrôle pour chaque partition dans un groupe de consommateurs donné d’une instance event Hub.
Les utilisateurs ne sont pas destinés à implémenter une CheckpointStore.
Les utilisateurs doivent choisir des implémentations existantes de cette interface, l’instancier et le transmettre au constructeur de classe EventHubConsumerClient lors de l’instanciation d’un client.
Les utilisateurs ne sont pas censés utiliser les méthodes d’un magasin de points de contrôle, celles-ci sont utilisées en interne par le client.
Vous trouverez des implémentations de CheckpointStore sur npm en recherchant des packages avec le préfixe @azure/eventhub-checkpointstore-.
Méthodes
| claim |
Appelé pour revendiquer la propriété d’une liste de partitions. Cette opération renvoie la liste des partitions détenues avec succès. |
| list |
Répertorie tous les points de contrôle d’un magasin de données pour un espace de noms, un eventhub et un groupe de consommateurs donnés. |
| list |
Appelé pour obtenir la liste de toutes les propriétés de partition existantes à partir du magasin de données sous-jacent. Peut retourner des résultats vides s’il n’existe aucune information de propriété existante. |
| update |
Met à jour le point de contrôle dans le magasin de données d’une partition. |
Détails de la méthode
claimOwnership(PartitionOwnership[], OperationOptions)
Appelé pour revendiquer la propriété d’une liste de partitions. Cette opération renvoie la liste des partitions détenues avec succès.
function claimOwnership(partitionOwnership: PartitionOwnership[], options?: OperationOptions): Promise<PartitionOwnership[]>Paramètres
- partitionOwnership
La liste de la propriété de partition que cette instance prétend posséder.
- options
- OperationOptions
Ensemble d’options qui peuvent être spécifiées pour influencer le comportement de cette méthode.
-
abortSignal: signal utilisé pour demander l’annulation de l’opération. -
tracingOptions: options de configuration du suivi.
Retours
Promise<PartitionOwnership[]>
Liste des partitions que cette instance a correctement revendiquée.
listCheckpoints(string, string, string, OperationOptions)
Répertorie tous les points de contrôle d’un magasin de données pour un espace de noms, un eventhub et un groupe de consommateurs donnés.
function listCheckpoints(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<Checkpoint[]>Paramètres
- fullyQualifiedNamespace
-
string
Espace de noms Event Hubs complet. Il est probable que ce soit similaire à <votrenamespace.servicebus.windows.net>.
- eventHubName
-
string
Nom du hub d’événements.
- consumerGroup
-
string
Nom du groupe de consommateurs.
- options
- OperationOptions
Ensemble d’options qui peuvent être spécifiées pour influencer le comportement de cette méthode.
-
abortSignal: signal utilisé pour demander l’annulation de l’opération. -
tracingOptions: options de configuration du suivi.
Retours
Promise<Checkpoint[]>
Liste des points de contrôle d’un espace de noms, d’un eventhub et d’un groupe de consommateurs donnés.
listOwnership(string, string, string, OperationOptions)
Appelé pour obtenir la liste de toutes les propriétés de partition existantes à partir du magasin de données sous-jacent. Peut retourner des résultats vides s’il n’existe aucune information de propriété existante.
function listOwnership(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<PartitionOwnership[]>Paramètres
- fullyQualifiedNamespace
-
string
Espace de noms Event Hubs complet. Il est probable que ce soit similaire à <votrenamespace.servicebus.windows.net>.
- eventHubName
-
string
Nom du hub d’événements.
- consumerGroup
-
string
Nom du groupe de consommateurs.
- options
- OperationOptions
Ensemble d’options qui peuvent être spécifiées pour influencer le comportement de cette méthode.
-
abortSignal: signal utilisé pour demander l’annulation de l’opération. -
tracingOptions: options de configuration du suivi.
Retours
Promise<PartitionOwnership[]>
Liste des détails de propriété de partition de toutes les partitions qui ont/avaient un propriétaire.
updateCheckpoint(Checkpoint, OperationOptions)
Met à jour le point de contrôle dans le magasin de données d’une partition.
function updateCheckpoint(checkpoint: Checkpoint, options?: OperationOptions): Promise<void>Paramètres
- checkpoint
- Checkpoint
Point de contrôle.
- options
- OperationOptions
Ensemble d’options qui peuvent être spécifiées pour influencer le comportement de cette méthode.
-
abortSignal: signal utilisé pour demander l’annulation de l’opération. -
tracingOptions: options de configuration du suivi.
Retours
Promise<void>