EventPosition interface
Olay Hub'ı bölümündeki bir olayın konumunu temsil eder; genellikle olay almaya başlamak için bölümdeki konumu belirtmek için üzerinde EventHubConsumerClient
yöntemini çağırırken subscribe()
kullanılır.
Akışın başlangıcını veya sonunu temsil eden bir EventPosition almak için sırasıyla ve latestEventPosition
sabitlerini earliestEventPosition
kullanın.
Özellikler
enqueued |
Bu konum tarafından tanımlanan olayın UTC'sinde sıralanan saat. Bir sayı olarak sağlandığında, bu değer Unix Dönemi'nin bu yana milisaniye sayısıdır. Konum yalnızca bir dizi numarasından veya uzaklıktan oluşturulduysa tanımsız olması beklenir. |
is |
Belirtilen uzaklık değerinin tanımladığı olayın dahil olup olmadığını gösterir.
Bu bilgiler yalnızca olay konumu bir uzaklık veya sıra numarasıyla belirlendiyse geçerlidir.
Varsayılan değer: |
offset | Bu konum tarafından tanımlanan olayın uzaklığı. Konum yalnızca bir sıra numarasından veya sıralı bir süreden oluşturulduysa tanımsız olması beklenir. Uzaklık, bölüm bağlamında bir olayın göreli konumudur. Uzaklık kararlı bir değer olarak kabul edilmemelidir. Olaylar saklama için yaş sınırına ulaştığından ve artık bölümde görünmediği için aynı uzaklık farklı bir olaya başvuruda bulunabilir. |
sequence |
Bu konum tarafından tanımlanan olayın sıra numarası. Konum yalnızca bir uzaklık veya sıralı süreden oluşturulduysa tanımsız olması beklenir. |
Özellik Ayrıntıları
enqueuedOn
Bu konum tarafından tanımlanan olayın UTC'sinde sıralanan saat. Bir sayı olarak sağlandığında, bu değer Unix Dönemi'nin bu yana milisaniye sayısıdır. Konum yalnızca bir dizi numarasından veya uzaklıktan oluşturulduysa tanımsız olması beklenir.
enqueuedOn?: Date | number
Özellik Değeri
Date | number
isInclusive
Belirtilen uzaklık değerinin tanımladığı olayın dahil olup olmadığını gösterir.
Bu bilgiler yalnızca olay konumu bir uzaklık veya sıra numarasıyla belirlendiyse geçerlidir.
Varsayılan değer: false
.
isInclusive?: boolean
Özellik Değeri
boolean
offset
Bu konum tarafından tanımlanan olayın uzaklığı. Konum yalnızca bir sıra numarasından veya sıralı bir süreden oluşturulduysa tanımsız olması beklenir. Uzaklık, bölüm bağlamında bir olayın göreli konumudur. Uzaklık kararlı bir değer olarak kabul edilmemelidir. Olaylar saklama için yaş sınırına ulaştığından ve artık bölümde görünmediği için aynı uzaklık farklı bir olaya başvuruda bulunabilir.
offset?: number | "@latest"
Özellik Değeri
number | "@latest"
sequenceNumber
Bu konum tarafından tanımlanan olayın sıra numarası. Konum yalnızca bir uzaklık veya sıralı süreden oluşturulduysa tanımsız olması beklenir.
sequenceNumber?: number
Özellik Değeri
number