EventPosition interface

Balíček:

@azure/event-hubs

Představuje pozici události v oddílu centra událostí, která se obvykle používá při volání metody subscribe() na EventHubConsumerClient k určení pozice v oddílu pro zahájení příjmu událostí.

Pokud chcete získat EventPosition představující začátek nebo konec datového proudu, použijte konstanty earliestEventPosition a latestEventPosition.

Vlastnosti

enqueuedOn	Čas zařazení do fronty v UTC události identifikované touto pozicí. Pokud je tato hodnota zadaná jako číslo, jedná se o počet milisekund od unixového epochu. Očekává se, že nebude definována, pokud je pozice vytvořena právě z pořadového čísla nebo posunu.
isInclusive	Určuje, jestli je zadaný posun včetně události, kterou identifikuje. Tyto informace se znovu promyslí, pouze pokud byla pozice události identifikována posunem nebo pořadovým číslem. Výchozí hodnota: false.
offset	Posun události identifikované touto pozicí Očekává se, že bude nedefinovaná, pokud se pozice právě vytvoří z pořadového čísla nebo z fronty. Posun je relativní pozice události v kontextu oddílu. Posun by neměl být považován za stabilní hodnotu. Stejný posun může odkazovat na jinou událost, protože události dosáhnou věkového limitu pro uchovávání a v rámci oddílu se už nezobrazují.
sequenceNumber	Pořadové číslo události identifikované touto pozicí. Očekává se, že nebude definována, pokud je pozice právě vytvořena z posunu nebo zařazení do fronty času.

Podrobnosti vlastnosti

enqueuedOn

Čas zařazení do fronty v UTC události identifikované touto pozicí. Pokud je tato hodnota zadaná jako číslo, jedná se o počet milisekund od unixového epochu. Očekává se, že nebude definována, pokud je pozice vytvořena právě z pořadového čísla nebo posunu.

enqueuedOn?: number | Date

Hodnota vlastnosti

number | Date

isInclusive

Určuje, jestli je zadaný posun včetně události, kterou identifikuje. Tyto informace se znovu promyslí, pouze pokud byla pozice události identifikována posunem nebo pořadovým číslem. Výchozí hodnota: false.

isInclusive?: boolean

Hodnota vlastnosti

boolean

offset

Posun události identifikované touto pozicí Očekává se, že bude nedefinovaná, pokud se pozice právě vytvoří z pořadového čísla nebo z fronty.

Posun je relativní pozice události v kontextu oddílu. Posun by neměl být považován za stabilní hodnotu. Stejný posun může odkazovat na jinou událost, protože události dosáhnou věkového limitu pro uchovávání a v rámci oddílu se už nezobrazují.

offset?: string

Hodnota vlastnosti

string

sequenceNumber

Pořadové číslo události identifikované touto pozicí. Očekává se, že nebude definována, pokud je pozice právě vytvořena z posunu nebo zařazení do fronty času.

sequenceNumber?: number

Hodnota vlastnosti

number