CheckpointStore interface
In een controlepuntarchief worden informatie over het eigendom van partities en controlepuntgegevens opgeslagen en opgehaald voor elke partitie in een bepaalde consumentengroep van een Event Hub-exemplaar.
Gebruikers zijn niet bedoeld om een CheckpointStorete implementeren.
Gebruikers worden geacht bestaande implementaties van deze interface te kiezen, deze te instantiëren en door te geven aan de EventHubConsumerClient klasseconstructor bij het instantiëren van een client.
Van gebruikers wordt niet verwacht dat ze een van de methoden in een controlepuntarchief gebruiken. Deze worden intern door de client gebruikt.
Implementaties van CheckpointStore vindt u op npm door te zoeken naar pakketten met het voorvoegsel @azure/eventhub-checkpointstore-.
Methoden
| claim |
Aangeroepen om het eigendom van een lijst met partities te claimen. Hiermee wordt de lijst met partities geretourneerd die eigendom zijn. |
| list |
Een lijst met alle controlepunten in een gegevensarchief voor een bepaalde naamruimte, eventhub en consumentengroep. |
| list |
Aangeroepen om de lijst met alle bestaande partitieeigendom op te halen uit het onderliggende gegevensarchief. Kan lege resultaten retourneren als er geen bestaande eigendomsgegevens zijn. |
| update |
Updates het controlepunt in het gegevensarchief voor een partitie. |
Methodedetails
claimOwnership(PartitionOwnership[], OperationOptions)
Aangeroepen om het eigendom van een lijst met partities te claimen. Hiermee wordt de lijst met partities geretourneerd die eigendom zijn.
function claimOwnership(partitionOwnership: PartitionOwnership[], options?: OperationOptions): Promise<PartitionOwnership[]>Parameters
- partitionOwnership
De lijst met partitieeigendom waarvan dit exemplaar claimt eigenaar te zijn.
- options
- OperationOptions
Een set opties die kunnen worden opgegeven om het gedrag van deze methode te beïnvloeden.
abortSignal: Een signaal dat wordt gebruikt om annulering van de bewerking aan te vragen.tracingOptions: Opties voor het configureren van tracering.
Retouren
Promise<PartitionOwnership[]>
Een lijst met partities die door dit exemplaar zijn geclaimd.
listCheckpoints(string, string, string, OperationOptions)
Een lijst met alle controlepunten in een gegevensarchief voor een bepaalde naamruimte, eventhub en consumentengroep.
function listCheckpoints(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<Checkpoint[]>Parameters
- fullyQualifiedNamespace
-
string
De volledig gekwalificeerde Event Hubs-naamruimte. Dit is waarschijnlijk vergelijkbaar met .servicebus.windows.net.
- eventHubName
-
string
De naam van de Event Hub.
- consumerGroup
-
string
De naam van de consumentengroep.
- options
- OperationOptions
Een set opties die kunnen worden opgegeven om het gedrag van deze methode te beïnvloeden.
abortSignal: Een signaal dat wordt gebruikt om annulering van de bewerking aan te vragen.tracingOptions: Opties voor het configureren van tracering.
Retouren
Promise<Checkpoint[]>
Een lijst met controlepunten voor een bepaalde naamruimte, eventhub en consumentengroep.
listOwnership(string, string, string, OperationOptions)
Aangeroepen om de lijst met alle bestaande partitieeigendom op te halen uit het onderliggende gegevensarchief. Kan lege resultaten retourneren als er geen bestaande eigendomsgegevens zijn.
function listOwnership(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<PartitionOwnership[]>Parameters
- fullyQualifiedNamespace
-
string
De volledig gekwalificeerde Event Hubs-naamruimte. Dit is waarschijnlijk vergelijkbaar met .servicebus.windows.net.
- eventHubName
-
string
De naam van de Event Hub.
- consumerGroup
-
string
De naam van de consumentengroep.
- options
- OperationOptions
Een set opties die kunnen worden opgegeven om het gedrag van deze methode te beïnvloeden.
abortSignal: Een signaal dat wordt gebruikt om annulering van de bewerking aan te vragen.tracingOptions: Opties voor het configureren van tracering.
Retouren
Promise<PartitionOwnership[]>
Een lijst met details van het eigendom van de partitie van alle partities die een eigenaar hebben/hadden.
updateCheckpoint(Checkpoint, OperationOptions)
Updates het controlepunt in het gegevensarchief voor een partitie.
function updateCheckpoint(checkpoint: Checkpoint, options?: OperationOptions): Promise<void>Parameters
- checkpoint
- Checkpoint
Het controlepunt.
- options
- OperationOptions
Een set opties die kunnen worden opgegeven om het gedrag van deze methode te beïnvloeden.
abortSignal: Een signaal dat wordt gebruikt om annulering van de bewerking aan te vragen.tracingOptions: Opties voor het configureren van tracering.
Retouren
Promise<void>