CheckpointStore interface
Úložiště kontrolních bodů ukládá a načítá informace o vlastnictví oddílu a podrobnosti kontrolního bodu pro každý oddíl v dané skupině příjemců instance centra událostí.
Uživatelé nemají implementovat CheckpointStore.
Očekává se, že uživatelé vyberou existující implementace tohoto rozhraní, vytvoří instanci a předají ho konstruktoru třídy EventHubConsumerClient při vytváření instance klienta.
U úložiště kontrolních bodů se očekává, že uživatelé nebudou používat žádné metody, které klient používá interně.
Implementace CheckpointStore najdete na npm vyhledáním balíčků s předponou @azure/eventhub-checkpointstore-.
Metody
| claim |
Volá se k deklaraci vlastnictví seznamu oddílů. Tím se vrátí seznam oddílů, které byly úspěšně vlastněny. |
| list |
Zobrazí seznam všech kontrolních bodů v úložišti dat pro daný obor názvů, eventhub a skupinu příjemců. |
| list |
Volá se k získání seznamu všech existujících vlastnictví oddílů z podkladového úložiště dat. Pokud neexistují žádné informace o vlastnictví, může vrátit prázdné výsledky. |
| update |
Aktualizuje kontrolní bod v úložišti dat pro oddíl. |
Podrobnosti metody
claimOwnership(PartitionOwnership[], OperationOptions)
Volá se k deklaraci vlastnictví seznamu oddílů. Tím se vrátí seznam oddílů, které byly úspěšně vlastněny.
function claimOwnership(partitionOwnership: PartitionOwnership[], options?: OperationOptions): Promise<PartitionOwnership[]>Parametry
- partitionOwnership
Seznam vlastnictví oddílu, které tato instance vlastní
- options
- OperationOptions
Sadu možností, které lze zadat, aby ovlivnily chování této metody.
-
abortSignal: Signál použitý ke zrušení operace žádosti. -
tracingOptions: Možnosti konfigurace trasování
Návraty
Promise<PartitionOwnership[]>
Seznamoddílůchchch
listCheckpoints(string, string, string, OperationOptions)
Zobrazí seznam všech kontrolních bodů v úložišti dat pro daný obor názvů, eventhub a skupinu příjemců.
function listCheckpoints(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<Checkpoint[]>Parametry
- fullyQualifiedNamespace
-
string
Plně kvalifikovaný obor názvů služby Event Hubs. Pravděpodobně se to bude podobat .servicebus.windows.net.
- eventHubName
-
string
Název centra událostí.
- consumerGroup
-
string
Název skupiny příjemců.
- options
- OperationOptions
Sadu možností, které lze zadat, aby ovlivnily chování této metody.
-
abortSignal: Signál použitý ke zrušení operace žádosti. -
tracingOptions: Možnosti konfigurace trasování
Návraty
Promise<Checkpoint[]>
Seznam kontrolních bodů pro daný obor názvů, eventhub a skupinu příjemců
listOwnership(string, string, string, OperationOptions)
Volá se k získání seznamu všech existujících vlastnictví oddílů z podkladového úložiště dat. Pokud neexistují žádné informace o vlastnictví, může vrátit prázdné výsledky.
function listOwnership(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<PartitionOwnership[]>Parametry
- fullyQualifiedNamespace
-
string
Plně kvalifikovaný obor názvů služby Event Hubs. Pravděpodobně se to bude podobat .servicebus.windows.net.
- eventHubName
-
string
Název centra událostí.
- consumerGroup
-
string
Název skupiny příjemců.
- options
- OperationOptions
Sadu možností, které lze zadat, aby ovlivnily chování této metody.
-
abortSignal: Signál použitý ke zrušení operace žádosti. -
tracingOptions: Možnosti konfigurace trasování
Návraty
Promise<PartitionOwnership[]>
Seznam podrobností o vlastnictví oddílu všech oddílů, které mají nebo mají vlastníka.
updateCheckpoint(Checkpoint, OperationOptions)
Aktualizuje kontrolní bod v úložišti dat pro oddíl.
function updateCheckpoint(checkpoint: Checkpoint, options?: OperationOptions): Promise<void>Parametry
- checkpoint
- Checkpoint
Kontrolní bod.
- options
- OperationOptions
Sadu možností, které lze zadat, aby ovlivnily chování této metody.
-
abortSignal: Signál použitý ke zrušení operace žádosti. -
tracingOptions: Možnosti konfigurace trasování
Návraty
Promise<void>