EventPosition interface

Pacote:

@azure/event-hubs

Representa a posição de um evento numa partição do Hub de Eventos, normalmente utilizada ao chamar o subscribe() método num EventHubConsumerClient para especificar a posição na partição a partir da qual começar a receber eventos.

Para obter um EventPosition que represente o início ou o fim do fluxo, utilize as constantes earliestEventPosition e latestEventPosition respetivamente.

Propriedades

enqueuedOn	A hora em fila em UTC do evento identificado por esta posição. Quando fornecido como um número, este valor é o número de milissegundos desde a Época Unix. Espera-se que não seja definido se a posição for criada a partir de um número de sequência ou de um desvio.
isInclusive	Indica se o desvio especificado inclui o evento que identifica. Esta informação só é relevente se a posição do evento tiver sido identificada por um desvio ou número de sequência. Valor predefinido: false.
offset	O desvio do evento identificado por esta posição. Espera-se que não seja definido se a posição for criada a partir de um número de sequência ou de um tempo em fila. O desvio é a posição relativa de um evento no contexto da partição. O desvio não deve ser considerado um valor estável. O mesmo desvio pode referir-se a um evento diferente, uma vez que os eventos atingem o limite de idade para retenção e já não estão visíveis na partição.
sequenceNumber	O número de sequência do evento identificado por esta posição. Espera-se que não seja definido se a posição tiver acabado de ser criada a partir de um tempo de deslocamento ou em fila de espera.

Detalhes de Propriedade

enqueuedOn

A hora em fila em UTC do evento identificado por esta posição. Quando fornecido como um número, este valor é o número de milissegundos desde a Época Unix. Espera-se que não seja definido se a posição for criada a partir de um número de sequência ou de um desvio.

enqueuedOn?: number | Date

Valor de Propriedade

number | Date

isInclusive

Indica se o desvio especificado inclui o evento que identifica. Esta informação só é relevente se a posição do evento tiver sido identificada por um desvio ou número de sequência. Valor predefinido: false.

isInclusive?: boolean

Valor de Propriedade

boolean

offset

O desvio do evento identificado por esta posição. Espera-se que não seja definido se a posição for criada a partir de um número de sequência ou de um tempo em fila.

O desvio é a posição relativa de um evento no contexto da partição. O desvio não deve ser considerado um valor estável. O mesmo desvio pode referir-se a um evento diferente, uma vez que os eventos atingem o limite de idade para retenção e já não estão visíveis na partição.

offset?: number | "@latest"

Valor de Propriedade

number | "@latest"

sequenceNumber

O número de sequência do evento identificado por esta posição. Espera-se que não seja definido se a posição tiver acabado de ser criada a partir de um tempo de deslocamento ou em fila de espera.

sequenceNumber?: number

Valor de Propriedade

number