EventPosition interface

Paket:

@azure/event-hubs

Representerar positionen för en händelse i en Event Hub-partition, som vanligtvis används när du anropar metoden subscribe() på en EventHubConsumerClient för att ange positionen i partitionen för att börja ta emot händelser från.

Om du vill hämta en EventPosition som representerar början eller slutet av strömmen använder du konstanterna earliestEventPosition respektive latestEventPosition.

Egenskaper

enqueuedOn	Den köade tiden i UTC för den händelse som identifieras av den här positionen. När det anges som ett tal är det här värdet antalet millisekunder sedan Unix-epoken. Förväntas vara odefinierad om positionen bara skapas från ett sekvensnummer eller en förskjutning.
isInclusive	Anger om den angivna förskjutningen inkluderar den händelse som den identifierar. Den här informationen återleventeras endast om händelsepositionen identifierades av ett förskjutnings- eller sekvensnummer. Standardvärde: false.
offset	Förskjutningen av händelsen som identifieras av den här positionen. Förväntas vara odefinierad om positionen bara skapas från ett sekvensnummer eller en köad tid. Förskjutningen är den relativa positionen för en händelse i partitionens kontext. Förskjutningen bör inte betraktas som ett stabilt värde. Samma förskjutning kan referera till en annan händelse eftersom händelser når åldersgränsen för kvarhållning och inte längre visas i partitionen.
sequenceNumber	Sekvensnumret för den händelse som identifieras av den här positionen. Förväntas vara odefinierad om positionen bara skapas från en förskjutning eller en köad tid.

Egenskapsinformation

enqueuedOn

Den köade tiden i UTC för den händelse som identifieras av den här positionen. När det anges som ett tal är det här värdet antalet millisekunder sedan Unix-epoken. Förväntas vara odefinierad om positionen bara skapas från ett sekvensnummer eller en förskjutning.

enqueuedOn?: number | Date

Egenskapsvärde

number | Date

isInclusive

Anger om den angivna förskjutningen inkluderar den händelse som den identifierar. Den här informationen återleventeras endast om händelsepositionen identifierades av ett förskjutnings- eller sekvensnummer. Standardvärde: false.

isInclusive?: boolean

Egenskapsvärde

boolean

offset

Förskjutningen av händelsen som identifieras av den här positionen. Förväntas vara odefinierad om positionen bara skapas från ett sekvensnummer eller en köad tid.

Förskjutningen är den relativa positionen för en händelse i partitionens kontext. Förskjutningen bör inte betraktas som ett stabilt värde. Samma förskjutning kan referera till en annan händelse eftersom händelser når åldersgränsen för kvarhållning och inte längre visas i partitionen.

offset?: number | "@latest"

Egenskapsvärde

number | "@latest"

sequenceNumber

Sekvensnumret för den händelse som identifieras av den här positionen. Förväntas vara odefinierad om positionen bara skapas från en förskjutning eller en köad tid.

sequenceNumber?: number

Egenskapsvärde

number