CheckpointStore interface

Paket:

@azure/event-hubs

Ett kontrollpunktslager lagrar och hämtar information om partitionsägarskap och kontrollpunktsinformation för varje partition i en viss konsumentgrupp för en händelsehubbinstans.

Användare är inte avsedda att implementera en CheckpointStore. Användarna förväntas välja befintliga implementeringar av det här gränssnittet, instansiera det och skicka det till EventHubConsumerClient-klasskonstruktorn när de instansierar en klient. Användarna förväntas inte använda någon av metoderna i ett kontrollpunktslager. Dessa används internt av klienten.

Implementeringar av CheckpointStore finns på npm genom att söka efter paket med prefixet @azure/eventhub-checkpointstore-.

Metoder

claimOwnership(PartitionOwnership[], OperationOptions)	Anropas för att göra anspråk på ägarskap för en lista över partitioner. Då returneras listan över partitioner som har ägts.
listCheckpoints(string, string, string, OperationOptions)	Visar en lista över alla kontrollpunkter i ett datalager för ett givet namnområde, eventhub och en konsumentgrupp.
listOwnership(string, string, string, OperationOptions)	Anropas för att hämta listan över allt befintligt partitionsägarskap från det underliggande datalagret. Det går att returnera tomma resultat om det inte finns någon befintlig ägarskapsinformation.
updateCheckpoint(Checkpoint, OperationOptions)	Uppdaterar kontrollpunkten i datalagret för en partition.

Metodinformation

claimOwnership(PartitionOwnership[], OperationOptions)

Anropas för att göra anspråk på ägarskap för en lista över partitioner. Då returneras listan över partitioner som har ägts.

function claimOwnership(partitionOwnership: PartitionOwnership[], options?: OperationOptions): Promise<PartitionOwnership[]>

Parametrar

partitionOwnership

PartitionOwnership[]

Listan över partitionsägarskap som den här instansen gör anspråk på att äga.

options

OperationOptions

En uppsättning alternativ som kan anges för att påverka beteendet för den här metoden.

• abortSignal: En signal som används för att begära att åtgärden avbryts.
• tracingOptions: Alternativ för att konfigurera spårning.

Returer

Promise<PartitionOwnership[]>

En lista över partitioner som den här instansen har begärt ägarskap för.

listCheckpoints(string, string, string, OperationOptions)

Visar en lista över alla kontrollpunkter i ett datalager för ett givet namnområde, eventhub och en konsumentgrupp.

function listCheckpoints(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<Checkpoint[]>

Parametrar

fullyQualifiedNamespace

string

Det fullständigt kvalificerade Event Hubs-namnområdet. Detta liknar troligen .servicebus.windows.net.

eventHubName

string

Händelsehubbens namn.

consumerGroup

string

Konsumentgruppens namn.

options

OperationOptions

En uppsättning alternativ som kan anges för att påverka beteendet för den här metoden.

• abortSignal: En signal som används för att begära att åtgärden avbryts.
• tracingOptions: Alternativ för att konfigurera spårning.

Returer

Promise<Checkpoint[]>

En lista över kontrollpunkter för ett givet namnområde, eventhub och en konsumentgrupp.

listOwnership(string, string, string, OperationOptions)

Anropas för att hämta listan över allt befintligt partitionsägarskap från det underliggande datalagret. Det går att returnera tomma resultat om det inte finns någon befintlig ägarskapsinformation.

function listOwnership(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<PartitionOwnership[]>

Parametrar

fullyQualifiedNamespace

string

Det fullständigt kvalificerade Event Hubs-namnområdet. Detta liknar troligen .servicebus.windows.net.

eventHubName

string

Händelsehubbens namn.

consumerGroup

string

Konsumentgruppens namn.

options

OperationOptions

En uppsättning alternativ som kan anges för att påverka beteendet för den här metoden.

• abortSignal: En signal som används för att begära att åtgärden avbryts.
• tracingOptions: Alternativ för att konfigurera spårning.

Returer

Promise<PartitionOwnership[]>

En lista över information om partitionsägarskap för alla partitioner som har/har en ägare.

updateCheckpoint(Checkpoint, OperationOptions)

Uppdaterar kontrollpunkten i datalagret för en partition.

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

Parametrar

checkpoint

Checkpoint

Kontrollpunkten.

options

OperationOptions

En uppsättning alternativ som kan anges för att påverka beteendet för den här metoden.

• abortSignal: En signal som används för att begära att åtgärden avbryts.
• tracingOptions: Alternativ för att konfigurera spårning.

Returer

Promise<void>