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 um EventPosition representando 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 esta posição. Quando fornecido como um número, este valor é o número de milissegundos desde a época Unix. Espera-se que seja indefinida 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 inclui o evento que ele identifica. Esta informação só é relativa se a posição do evento tiver sido identificada por um deslocamento ou número de sequência. Valor padrão: false.
offset	O deslocamento do evento identificado por esta posição. Espera-se que seja indefinida 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 são mais visíveis dentro da partição.
sequenceNumber	O número sequencial do evento identificado por esta posição. Espera-se que seja indefinida se a posição for criada apenas a partir de um tempo deslocado ou enfileirado.

Detalhes de Propriedade

enqueuedOn

A hora enfileirada 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 seja indefinida se a posição for criada apenas a partir de um número de sequência ou um deslocamento.

enqueuedOn?: number | Date

Valor de Propriedade

number | Date

isInclusive

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

isInclusive?: boolean

Valor de Propriedade

boolean

offset

O deslocamento do evento identificado por esta posição. Espera-se que seja indefinida 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 são mais visíveis dentro da partição.

offset?: string

Valor de Propriedade

string

sequenceNumber

O número sequencial do evento identificado por esta posição. Espera-se que seja indefinida se a posição for criada apenas a partir de um tempo deslocado ou enfileirado.

sequenceNumber?: number

Valor de Propriedade

number