CheckpointStore interface
In een controlepuntarchief worden gegevens over 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 verwacht 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.
Gebruikers zullen naar verwachting geen 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 |
Wordt aangeroepen om het eigendom van een lijst met partities te claimen. Hiermee wordt de lijst met partities geretourneerd waarvan de eigenaar is. |
| list |
Een lijst met alle controlepunten in een gegevensarchief voor een bepaalde naamruimte, eventhub en consumentengroep. |
| list |
Wordt aangeroepen om de lijst op te halen van alle bestaande partitieeigendom uit het onderliggende gegevensarchief. Kan lege resultaten retourneren als er geen bestaande eigendomsgegevens zijn. |
| update |
Hiermee werkt u het controlepunt in het gegevensarchief voor een partitie bij. |
Methodedetails
claimOwnership(PartitionOwnership[], OperationOptions)
Wordt aangeroepen om het eigendom van een lijst met partities te claimen. Hiermee wordt de lijst met partities geretourneerd waarvan de eigenaar is.
function claimOwnership(partitionOwnership: PartitionOwnership[], options?: OperationOptions): Promise<PartitionOwnership[]>Parameters
- partitionOwnership
De lijst met partitieeigendom waarvan dit exemplaar eigenaar is, claimt dat deze eigenaar is.
- 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 bewerking aan te vragen. -
tracingOptions: Opties voor het configureren van tracering.
Retouren
Promise<PartitionOwnership[]>
Een lijst met partities die dit exemplaar heeft geclaimd, heeft eigendom 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 <uwnaamruimte.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 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)
Wordt aangeroepen om de lijst op te halen van alle bestaande partitieeigendom 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 <uwnaamruimte.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 bewerking aan te vragen. -
tracingOptions: Opties voor het configureren van tracering.
Retouren
Promise<PartitionOwnership[]>
Een lijst met details van het eigendom van partities van alle partities die een eigenaar hebben/gehad.
updateCheckpoint(Checkpoint, OperationOptions)
Hiermee werkt u het controlepunt in het gegevensarchief voor een partitie bij.
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 bewerking aan te vragen. -
tracingOptions: Opties voor het configureren van tracering.
Retouren
Promise<void>