EventPosition interface

Pacchetto:

@azure/event-hubs

Rappresenta la posizione di un evento in una partizione di Hub eventi, in genere utilizzata quando si chiama il subscribe() metodo su un EventHubConsumerClient per specificare la posizione nella partizione da cui iniziare a ricevere eventi.

Per ottenere un oggetto EventPosition che rappresenta l'inizio o la fine del flusso, usare rispettivamente le earliestEventPosition costanti e latestEventPosition .

Proprietà

enqueuedOn	Ora accodata in formato UTC dell'evento identificato da questa posizione. Se specificato come numero, questo valore è il numero di millisecondi dall'epoca Unix. Previsto che non sia definito se la posizione viene appena creata da un numero di sequenza o da un offset.
isInclusive	Indica se l'offset specificato è inclusivo dell'evento identificato. Queste informazioni vengono restituite solo se la posizione dell'evento è stata identificata da un offset o da un numero di sequenza. Valore predefinito: false.
offset	Offset dell'evento identificato da questa posizione. Previsto non definito se la posizione viene appena creata da un numero di sequenza o da un tempo accodato. L'offset è la posizione relativa di un evento nel contesto della partizione. L'offset non deve essere considerato un valore stabile. Lo stesso offset può fare riferimento a un evento diverso perché gli eventi raggiungono il limite di validità per la conservazione e non sono più visibili all'interno della partizione.
sequenceNumber	Numero di sequenza dell'evento identificato da questa posizione. Previsto che non sia definito se la posizione viene appena creata da un offset o da un tempo accodato.

Dettagli proprietà

enqueuedOn

Ora accodata in formato UTC dell'evento identificato da questa posizione. Se specificato come numero, questo valore è il numero di millisecondi dall'epoca Unix. Previsto che non sia definito se la posizione viene appena creata da un numero di sequenza o da un offset.

enqueuedOn?: number | Date

Valore della proprietà

number | Date

isInclusive

Indica se l'offset specificato è inclusivo dell'evento identificato. Queste informazioni vengono restituite solo se la posizione dell'evento è stata identificata da un offset o da un numero di sequenza. Valore predefinito: false.

isInclusive?: boolean

Valore della proprietà

boolean

offset

Offset dell'evento identificato da questa posizione. Previsto non definito se la posizione viene appena creata da un numero di sequenza o da un tempo accodato.

L'offset è la posizione relativa di un evento nel contesto della partizione. L'offset non deve essere considerato un valore stabile. Lo stesso offset può fare riferimento a un evento diverso perché gli eventi raggiungono il limite di validità per la conservazione e non sono più visibili all'interno della partizione.

offset?: number | "@latest"

Valore della proprietà

number | "@latest"

sequenceNumber

Numero di sequenza dell'evento identificato da questa posizione. Previsto che non sia definito se la posizione viene appena creata da un offset o da un tempo accodato.

sequenceNumber?: number

Valore della proprietà

number