CheckpointStore interface

Csomag:

@azure/event-hubs

Az ellenőrzőpont-tároló tárolja és lekéri az eseményközpont-példány adott fogyasztói csoportjában található partíciók tulajdonjogi adatait és ellenőrzőpont-adatait.

A felhasználóknak nem kell implementálniuk a következőt CheckpointStore: . A felhasználóknak ki kell választaniuk a felület meglévő implementációit, példányosítaniuk kell, és át kell adniuk az EventHubConsumerClient osztálykonstruktornak az ügyfél példányosításakor. A felhasználóknak nem kell használniuk az ellenőrzőpont-tárolók egyik metódusát sem, ezeket az ügyfél belsőleg használja.

Az implementációk CheckpointStore az npm-en találhatók a @azure/eventhub-checkpointstore- előtaggal rendelkező csomagok keresésével.

Metódusok

claimOwnership(PartitionOwnership[], OperationOptions)	A partíciók listájának tulajdonjogának igénylésére van meghívva. Ez visszaadja a sikeresen birtokolt partíciók listáját.
listCheckpoints(string, string, string, OperationOptions)	Egy adott névtérhez, eseményközponthoz és fogyasztói csoporthoz tartozó adattár összes ellenőrzőpontját felsorolja.
listOwnership(string, string, string, OperationOptions)	Meghívva az összes meglévő partíciótulajdon listájának lekéréséhez a mögöttes adattárból. Üres eredményeket adhat vissza, ha nincsenek meglévő tulajdonosi információk.
updateCheckpoint(Checkpoint, OperationOptions)	Frissítések az adattárban lévő ellenőrzőpontot egy partícióhoz.

Metódus adatai

claimOwnership(PartitionOwnership[], OperationOptions)

A partíciók listájának tulajdonjogának igénylésére van meghívva. Ez visszaadja a sikeresen birtokolt partíciók listáját.

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

Paraméterek

partitionOwnership

PartitionOwnership[]

A példány által birtokolt partíció tulajdonjogának listája.

options

OperationOptions

A metódus viselkedésének befolyásolására megadható beállítások készlete.

• abortSignal: A művelet megszakításának igénylésére használt jel.
• tracingOptions: A nyomkövetés konfigurálásának lehetőségei.

Válaszok

Promise<PartitionOwnership[]>

A példány által sikeresen igényelt partíciók listája.

listCheckpoints(string, string, string, OperationOptions)

Egy adott névtérhez, eseményközponthoz és fogyasztói csoporthoz tartozó adattár összes ellenőrzőpontját felsorolja.

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

Paraméterek

fullyQualifiedNamespace

string

A teljes Event Hubs-névtér. Ez valószínűleg hasonló lesz a .servicebus.windows.net-hoz.

eventHubName

string

Az eseményközpont neve.

consumerGroup

string

A fogyasztói csoport neve.

options

OperationOptions

A metódus viselkedésének befolyásolására megadható beállítások készlete.

• abortSignal: A művelet megszakításának igénylésére használt jel.
• tracingOptions: A nyomkövetés konfigurálásának lehetőségei.

Válaszok

Promise<Checkpoint[]>

Egy adott névtér, eseményközpont és fogyasztói csoport ellenőrzőpontjainak listája.

listOwnership(string, string, string, OperationOptions)

Meghívva az összes meglévő partíciótulajdon listájának lekéréséhez a mögöttes adattárból. Üres eredményeket adhat vissza, ha nincsenek meglévő tulajdonosi információk.

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

Paraméterek

fullyQualifiedNamespace

string

A teljes Event Hubs-névtér. Ez valószínűleg hasonló lesz a .servicebus.windows.net-hoz.

eventHubName

string

Az eseményközpont neve.

consumerGroup

string

A fogyasztói csoport neve.

options

OperationOptions

A metódus viselkedésének befolyásolására megadható beállítások készlete.

• abortSignal: A művelet megszakításának igénylésére használt jel.
• tracingOptions: A nyomkövetés konfigurálásának lehetőségei.

Válaszok

Promise<PartitionOwnership[]>

A tulajdonossal/tulajdonossal rendelkező partíciók tulajdonosi adatainak listája.

updateCheckpoint(Checkpoint, OperationOptions)

Frissítések az adattárban lévő ellenőrzőpontot egy partícióhoz.

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

Paraméterek

checkpoint

Checkpoint

Az ellenőrzőpont.

options

OperationOptions

A metódus viselkedésének befolyásolására megadható beállítások készlete.

• abortSignal: A művelet megszakításának igénylésére használt jel.
• tracingOptions: A nyomkövetés konfigurálásának lehetőségei.

Válaszok

Promise<void>