Udostępnij za pośrednictwem

EventPosition interface

  • Odwołanie
Pakiet:
@azure/event-hubs

Reprezentuje położenie zdarzenia w partycji centrum zdarzeń, zwykle używane podczas wywoływania subscribe() metody na obiekcie EventHubConsumerClient w celu określenia pozycji w partycji, aby rozpocząć odbieranie zdarzeń.

Aby uzyskać element EventPosition reprezentujący początek lub koniec strumienia, użyj stałych earliestEventPosition i latestEventPosition odpowiednio.

Właściwości

enqueuedOn

Czas w kolejce w formacie UTC zdarzenia określonego przez tę pozycję. W przypadku podania jako liczby ta wartość jest liczbą milisekund od czasu epoki systemu Unix. Oczekiwano niezdefiniowania, jeśli pozycja została właśnie utworzona na podstawie numeru sekwencji lub przesunięcia.
isInclusive

Wskazuje, czy określone przesunięcie jest uwzględniane w zdarzeniu, które identyfikuje. Te informacje są zmieniane tylko wtedy, gdy pozycja zdarzenia została zidentyfikowana przez przesunięcie lub numer sekwencji. Wartość domyślna: false.
offset

Przesunięcie zdarzenia określonego przez tę pozycję. Oczekiwano niezdefiniowania, jeśli pozycja została właśnie utworzona na podstawie numeru sekwencji lub czasu w kolejce.

Przesunięcie to względne położenie zdarzenia w kontekście partycji. Przesunięcie nie powinno być uznawane za stabilną wartość. To samo przesunięcie może odnosić się do innego zdarzenia, ponieważ zdarzenia osiągną limit wieku przechowywania i nie są już widoczne w partycji.
sequenceNumber

Numer sekwencji zdarzenia określonego przez tę pozycję. Oczekiwano niezdefiniowania, jeśli pozycja została właśnie utworzona na podstawie przesunięcia lub czasu w kolejce.

Szczegóły właściwości

enqueuedOn

Czas w kolejce w formacie UTC zdarzenia określonego przez tę pozycję. W przypadku podania jako liczby ta wartość jest liczbą milisekund od czasu epoki systemu Unix. Oczekiwano niezdefiniowania, jeśli pozycja została właśnie utworzona na podstawie numeru sekwencji lub przesunięcia.

enqueuedOn?: number | Date

Wartość właściwości

number | Date

isInclusive

Wskazuje, czy określone przesunięcie jest uwzględniane w zdarzeniu, które identyfikuje. Te informacje są zmieniane tylko wtedy, gdy pozycja zdarzenia została zidentyfikowana przez przesunięcie lub numer sekwencji. Wartość domyślna: false.

isInclusive?: boolean

Wartość właściwości

boolean

offset

Przesunięcie zdarzenia określonego przez tę pozycję. Oczekiwano niezdefiniowania, jeśli pozycja została właśnie utworzona na podstawie numeru sekwencji lub czasu w kolejce.

Przesunięcie to względne położenie zdarzenia w kontekście partycji. Przesunięcie nie powinno być uznawane za stabilną wartość. To samo przesunięcie może odnosić się do innego zdarzenia, ponieważ zdarzenia osiągną limit wieku przechowywania i nie są już widoczne w partycji.

offset?: number | "@latest"

Wartość właściwości

number | "@latest"

sequenceNumber

Numer sekwencji zdarzenia określonego przez tę pozycję. Oczekiwano niezdefiniowania, jeśli pozycja została właśnie utworzona na podstawie przesunięcia lub czasu w kolejce.

sequenceNumber?: number

Wartość właściwości

number