CheckpointStore interface
Un magasin de points de contrôle stocke et récupère les informations sur la propriété de la partition et les détails des points 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 un CheckpointStore.
Les utilisateurs sont censés choisir les implémentations existantes de cette interface, les instancier et les passer au constructeur de classe lors de l’instanciation EventHubConsumerClient d’un client.
Les utilisateurs ne sont pas censés utiliser l’une des méthodes sur un magasin de points de contrôle, celles-ci sont utilisées en interne par le client.
Les implémentations de CheckpointStore peuvent être trouvées 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 qui ont été 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 |
Mises à 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 qui ont été détenues avec succès.
function claimOwnership(partitionOwnership: PartitionOwnership[], options?: OperationOptions): Promise<PartitionOwnership[]>Paramètres
- partitionOwnership
Liste de la propriété de la 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 dont cette instance a correctement revendiqué la propriété.
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 complet Event Hubs. Cela est probablement similaire à .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 pour un espace de noms, un eventhub et 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 complet Event Hubs. Cela est probablement similaire à .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 la propriété de la partition de toutes les partitions qui ont/ont un propriétaire.
updateCheckpoint(Checkpoint, OperationOptions)
Mises à 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>