Sdílet prostřednictvím

CheckpointStore interface

  • Reference
Balíček:
@azure/event-hubs

Ú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é nejsou určeni k implementaci .CheckpointStore Očekává se, že uživatelé zvolí existující implementace tohoto rozhraní, vytvoří jeho instanci a předá ho konstruktoru EventHubConsumerClient třídy při vytváření instance klienta. U uživatelů se neočekává použití žádné metody v úložišti kontrolních bodů. Klient je používá interně.

CheckpointStore Implementace najdete na npm vyhledáním balíčků s předponou @azure/eventhub-checkpointstore-.

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.
listCheckpoints(string, string, string, OperationOptions)

Zobrazí seznam všech kontrolních bodů v úložišti dat pro daný obor názvů, centrum událostí 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.
updateCheckpoint(Checkpoint, OperationOptions)

Aktualizace kontrolní bod v úložišti dat oddílu.

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

PartitionOwnership[]

Seznam vlastnictví oddílu, které tato instance deklaruje jako vlastníka.

options
OperationOptions

Sada možností, které lze zadat k ovlivnění chování této metody.

  • abortSignal: Signál, který se používá k vyžádání zrušení operace.
  • tracingOptions: Možnosti konfigurace trasování.

Návraty

Promise<PartitionOwnership[]>

Seznam oddílů, které tato instance úspěšně nárokovala na vlastnictví.

listCheckpoints(string, string, string, OperationOptions)

Zobrazí seznam všech kontrolních bodů v úložišti dat pro daný obor názvů, centrum událostí 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 bude podobat souboru .servicebus.windows.net.

eventHubName

string

Název centra událostí.

consumerGroup

string

Název skupiny uživatelů.

options
OperationOptions

Sada možností, které lze zadat k ovlivnění chování této metody.

  • abortSignal: Signál, který se používá k vyžádání zrušení operace.
  • tracingOptions: Možnosti konfigurace trasování.

Návraty

Promise<Checkpoint[]>

Seznam kontrolních bodů pro daný obor názvů, centrum událostí 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 bude podobat souboru .servicebus.windows.net.

eventHubName

string

Název centra událostí.

consumerGroup

string

Název skupiny uživatelů.

options
OperationOptions

Sada možností, které lze zadat k ovlivnění chování této metody.

  • abortSignal: Signál, který se používá k vyžádání zrušení operace.
  • tracingOptions: Možnosti konfigurace trasování.

Návraty

Promise<PartitionOwnership[]>

Seznam podrobností o vlastnictví oddílů všech oddílů, které mají nebo měly vlastníka.

updateCheckpoint(Checkpoint, OperationOptions)

Aktualizace kontrolní bod v úložišti dat oddílu.

function updateCheckpoint(checkpoint: Checkpoint, options?: OperationOptions): Promise<void>

Parametry

checkpoint
Checkpoint

Kontrolní bod.

options
OperationOptions

Sada možností, které lze zadat k ovlivnění chování této metody.

  • abortSignal: Signál, který se používá k vyžádání zrušení operace.
  • tracingOptions: Možnosti konfigurace trasování.

Návraty

Promise<void>