EventPosition interface

Paquete:

@azure/event-hubs

Representa la posición de un evento en una partición del centro de eventos, que normalmente se usa al llamar al subscribe() método en para EventHubConsumerClient especificar la posición de la partición desde la que empezar a recibir eventos.

Para obtener una EventPosition que represente el inicio o el final de la secuencia, use las constantes earliestEventPosition y latestEventPosition , respectivamente.

Propiedades

enqueuedOn	Hora en cola en UTC del evento identificado por esta posición. Cuando se proporciona como un número, este valor es el número de milisegundos desde la época unix. Se espera que no esté definido si la posición se acaba de crear a partir de un número de secuencia o un desplazamiento.
isInclusive	Indica si el desplazamiento especificado es inclusivo del evento que identifica. Esta información solo es relevent si la posición del evento se identificó mediante un desplazamiento o un número de secuencia. Valor predeterminado: false.
offset	Desplazamiento del evento identificado por esta posición. Se espera que no esté definido si la posición se acaba de crear a partir de un número de secuencia o una hora en cola. El desplazamiento es la posición relativa de un evento en el contexto de la partición. El desplazamiento no debe considerarse un valor estable. El mismo desplazamiento puede hacer referencia a un evento diferente a medida que los eventos alcanzan el límite de antigüedad para la retención y ya no son visibles dentro de la partición.
sequenceNumber	Número de secuencia del evento identificado por esta posición. Se espera que no esté definido si la posición se acaba de crear a partir de un desplazamiento o tiempo en cola.

Detalles de las propiedades

enqueuedOn

Hora en cola en UTC del evento identificado por esta posición. Cuando se proporciona como un número, este valor es el número de milisegundos desde la época unix. Se espera que no esté definido si la posición se acaba de crear a partir de un número de secuencia o un desplazamiento.

enqueuedOn?: number | Date

Valor de propiedad

number | Date

isInclusive

Indica si el desplazamiento especificado es inclusivo del evento que identifica. Esta información solo es relevent si la posición del evento se identificó mediante un desplazamiento o un número de secuencia. Valor predeterminado: false.

isInclusive?: boolean

Valor de propiedad

boolean

offset

Desplazamiento del evento identificado por esta posición. Se espera que no esté definido si la posición se acaba de crear a partir de un número de secuencia o una hora en cola.

El desplazamiento es la posición relativa de un evento en el contexto de la partición. El desplazamiento no debe considerarse un valor estable. El mismo desplazamiento puede hacer referencia a un evento diferente a medida que los eventos alcanzan el límite de antigüedad para la retención y ya no son visibles dentro de la partición.

offset?: number | "@latest"

Valor de propiedad

number | "@latest"

sequenceNumber

Número de secuencia del evento identificado por esta posición. Se espera que no esté definido si la posición se acaba de crear a partir de un desplazamiento o tiempo en cola.

sequenceNumber?: number

Valor de propiedad

number