EventPosition interface

Pacote:

@azure/event-hubs

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

Para obter uma EventPosition que represente o início ou o fim do fluxo, use as constantes earliestEventPosition e latestEventPosition respectivamente.

Propriedades

enqueuedOn	A hora enfileirada em UTC do evento identificado por essa posição. Quando fornecido como um número, esse valor é o número de milissegundos desde a Época Unix. Espera-se que seja indefinido se a posição for criada apenas a partir de um número de sequência ou um deslocamento.
isInclusive	Indica se o deslocamento especificado é inclusivo do evento que ele identifica. Essas informações só serão releventadas se a posição do evento tiver sido identificada por um número de deslocamento ou sequência. Valor padrão: false.
offset	O deslocamento do evento identificado por essa posição. Espera-se que seja indefinido se a posição for criada apenas a partir de um número de sequência ou de um tempo enfileirado. O deslocamento é a posição relativa de um evento no contexto da partição. O deslocamento não deve ser considerado um valor estável. O mesmo deslocamento pode se referir a um evento diferente, pois os eventos atingem o limite de idade para retenção e não estão mais visíveis dentro da partição.
sequenceNumber	O número de sequência do evento identificado por essa posição. Espera-se que seja indefinido se a posição for criada apenas a partir de um deslocamento ou tempo enfileirado.

Detalhes da propriedade

enqueuedOn

A hora enfileirada em UTC do evento identificado por essa posição. Quando fornecido como um número, esse valor é o número de milissegundos desde a Época Unix. Espera-se que seja indefinido se a posição for criada apenas a partir de um número de sequência ou um deslocamento.

enqueuedOn?: number | Date

Valor da propriedade

number | Date

isInclusive

Indica se o deslocamento especificado é inclusivo do evento que ele identifica. Essas informações só serão releventadas se a posição do evento tiver sido identificada por um número de deslocamento ou sequência. Valor padrão: false.

isInclusive?: boolean

Valor da propriedade

boolean

offset

O deslocamento do evento identificado por essa posição. Espera-se que seja indefinido se a posição for criada apenas a partir de um número de sequência ou de um tempo enfileirado.

O deslocamento é a posição relativa de um evento no contexto da partição. O deslocamento não deve ser considerado um valor estável. O mesmo deslocamento pode se referir a um evento diferente, pois os eventos atingem o limite de idade para retenção e não estão mais visíveis dentro da partição.

offset?: number | "@latest"

Valor da propriedade

number | "@latest"

sequenceNumber

O número de sequência do evento identificado por essa posição. Espera-se que seja indefinido se a posição for criada apenas a partir de um deslocamento ou tempo enfileirado.

sequenceNumber?: number

Valor da propriedade

number