EventPosition interface
Egy esemény pozícióját jelöli egy Event Hub-partícióban, amely általában akkor használatos, amikor meghívja a subscribe()
metódust egyre EventHubConsumerClient
, és megadja a partíció pozícióját az események fogadásának megkezdéséhez.
A stream kezdetét vagy végét jelképező EventPosition lekéréséhez használja az állandókat earliestEventPosition
és latestEventPosition
azokat.
Tulajdonságok
enqueued |
Az ebben a pozícióban azonosított esemény utc-beli lekért időpontja. Számként megadva ez az érték a Unix-korszak óta eltelt ezredmásodpercek száma. Várhatóan nem lesz definiálva, ha a pozíció éppen egy sorszámból vagy eltolásból jött létre. |
is |
Azt jelzi, hogy a megadott eltolás tartalmazza-e az általa azonosított eseményt.
Ez az információ csak akkor jelenik meg, ha az eseménypozíciót eltolás vagy sorszám azonosította.
Alapértelmezett érték: |
offset | Az ezzel a pozícióval azonosított esemény eltolása. A várt érték nem lesz meghatározva, ha a pozíció most jön létre egy sorszámból vagy egy leküldett időpontból. Az eltolás egy esemény relatív pozíciója a partíció kontextusában. Az eltolás nem tekinthető stabil értéknek. Ugyanez az eltolás egy másik eseményre utalhat, mivel az események elérik a megőrzés korhatárát, és már nem láthatók a partíción belül. |
sequence |
Az ezzel a pozícióval azonosított esemény sorszáma. A várt érték nem lesz meghatározva, ha a pozíció most jön létre egy eltolásból vagy leküldett időpontból. |
Tulajdonság adatai
enqueuedOn
Az ebben a pozícióban azonosított esemény utc-beli lekért időpontja. Számként megadva ez az érték a Unix-korszak óta eltelt ezredmásodpercek száma. Várhatóan nem lesz definiálva, ha a pozíció éppen egy sorszámból vagy eltolásból jött létre.
enqueuedOn?: number | Date
Tulajdonság értéke
number | Date
isInclusive
Azt jelzi, hogy a megadott eltolás tartalmazza-e az általa azonosított eseményt.
Ez az információ csak akkor jelenik meg, ha az eseménypozíciót eltolás vagy sorszám azonosította.
Alapértelmezett érték: false
.
isInclusive?: boolean
Tulajdonság értéke
boolean
offset
Az ezzel a pozícióval azonosított esemény eltolása. A várt érték nem lesz meghatározva, ha a pozíció most jön létre egy sorszámból vagy egy leküldett időpontból.
Az eltolás egy esemény relatív pozíciója a partíció kontextusában. Az eltolás nem tekinthető stabil értéknek. Ugyanez az eltolás egy másik eseményre utalhat, mivel az események elérik a megőrzés korhatárát, és már nem láthatók a partíción belül.
offset?: number | "@latest"
Tulajdonság értéke
number | "@latest"
sequenceNumber
Az ezzel a pozícióval azonosított esemény sorszáma. A várt érték nem lesz meghatározva, ha a pozíció most jön létre egy eltolásból vagy leküldett időpontból.
sequenceNumber?: number
Tulajdonság értéke
number