CheckpointStore interface
Un archivio checkpoint archivia e recupera le informazioni sulla proprietà della partizione e i dettagli del checkpoint per ogni partizione in un determinato gruppo di consumer di un'istanza dell'hub eventi.
Gli utenti non devono implementare un CheckpointStoreoggetto .
Gli utenti devono scegliere implementazioni esistenti di questa interfaccia, crearne un'istanza e passarla al costruttore della classe quando si crea un'istanza EventHubConsumerClient di un client.
Gli utenti non devono usare uno dei metodi in un archivio checkpoint, questi vengono usati internamente dal client.
Le implementazioni di CheckpointStore sono disponibili in npm cercando pacchetti con il prefisso @azure/eventhub-checkpointstore-.
Metodi
| claim |
Chiamata per richiedere la proprietà di un elenco di partizioni. Verrà restituito l'elenco delle partizioni di proprietà. |
| list |
Elenca tutti i checkpoint in un archivio dati per uno spazio dei nomi specifico, eventhub e gruppo di consumer. |
| list |
Chiamato per ottenere l'elenco di tutte le proprietà di partizione esistenti dall'archivio dati sottostante. Potrebbe restituire risultati vuoti se non sono presenti informazioni sulla proprietà esistenti. |
| update |
Aggiornamenti il checkpoint nell'archivio dati per una partizione. |
Dettagli metodo
claimOwnership(PartitionOwnership[], OperationOptions)
Chiamata per richiedere la proprietà di un elenco di partizioni. Verrà restituito l'elenco delle partizioni di proprietà.
function claimOwnership(partitionOwnership: PartitionOwnership[], options?: OperationOptions): Promise<PartitionOwnership[]>Parametri
- partitionOwnership
L'elenco della proprietà della partizione che questa istanza richiede di essere proprietaria.
- options
- OperationOptions
Set di opzioni che possono essere specificate per influenzare il comportamento di questo metodo.
-
abortSignal: segnale usato per richiedere l'annullamento dell'operazione. -
tracingOptions: opzioni per la configurazione della traccia.
Restituisce
Promise<PartitionOwnership[]>
Elenco delle partizioni che questa istanza ha richiesto correttamente la proprietà.
listCheckpoints(string, string, string, OperationOptions)
Elenca tutti i checkpoint in un archivio dati per uno spazio dei nomi specifico, eventhub e gruppo di consumer.
function listCheckpoints(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<Checkpoint[]>Parametri
- fullyQualifiedNamespace
-
string
Spazio dei nomi di Hub eventi completo. È probabile che sia simile a .servicebus.windows.net.
- eventHubName
-
string
Nome dell'hub eventi.
- consumerGroup
-
string
Nome del gruppo consumer.
- options
- OperationOptions
Set di opzioni che possono essere specificate per influenzare il comportamento di questo metodo.
-
abortSignal: segnale usato per richiedere l'annullamento dell'operazione. -
tracingOptions: opzioni per la configurazione della traccia.
Restituisce
Promise<Checkpoint[]>
Elenco di checkpoint per uno spazio dei nomi, un eventhub e un gruppo consumer specifico.
listOwnership(string, string, string, OperationOptions)
Chiamato per ottenere l'elenco di tutte le proprietà di partizione esistenti dall'archivio dati sottostante. Potrebbe restituire risultati vuoti se non sono presenti informazioni sulla proprietà esistenti.
function listOwnership(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<PartitionOwnership[]>Parametri
- fullyQualifiedNamespace
-
string
Spazio dei nomi di Hub eventi completo. È probabile che sia simile a .servicebus.windows.net.
- eventHubName
-
string
Nome dell'hub eventi.
- consumerGroup
-
string
Nome del gruppo consumer.
- options
- OperationOptions
Set di opzioni che possono essere specificate per influenzare il comportamento di questo metodo.
-
abortSignal: segnale usato per richiedere l'annullamento dell'operazione. -
tracingOptions: opzioni per la configurazione della traccia.
Restituisce
Promise<PartitionOwnership[]>
Elenco dei dettagli della proprietà della partizione di tutte le partizioni che hanno/hanno un proprietario.
updateCheckpoint(Checkpoint, OperationOptions)
Aggiornamenti il checkpoint nell'archivio dati per una partizione.
function updateCheckpoint(checkpoint: Checkpoint, options?: OperationOptions): Promise<void>Parametri
- checkpoint
- Checkpoint
Checkpoint.
- options
- OperationOptions
Set di opzioni che possono essere specificate per influenzare il comportamento di questo metodo.
-
abortSignal: segnale usato per richiedere l'annullamento dell'operazione. -
tracingOptions: opzioni per la configurazione della traccia.
Restituisce
Promise<void>