CheckpointStore interface
Denetim noktası, bir olay hub'ı örneğinin belirli bir tüketici grubundaki her bölüm için bölüm sahipliği bilgilerini ve denetim noktası ayrıntılarını depolar ve alır.
Kullanıcıların uygulaması amaçlanmamıştır CheckpointStore
.
Kullanıcıların bu arabirimin mevcut uygulamalarını seçmesi, örneği oluşturması ve bir istemci örneği EventHubConsumerClient
oluştururken sınıf oluşturucusna geçirmesi beklenir.
Kullanıcıların denetim noktası deposundaki yöntemlerden herhangi birini kullanması beklenmez, bunlar istemci tarafından dahili olarak kullanılır.
CheckpointStore
uygulamaları npm'de @azure/eventhub-checkpointstore- ön ekini içeren paketler aranarak bulunabilir.
Yöntemler
claim |
Bir bölüm listesinin sahipliğini talep etmek için çağrılır. Bu, başarıyla sahip olunan bölümlerin listesini döndürür. |
list |
Belirli bir ad alanı, eventhub ve tüketici grubu için veri deposundaki tüm denetim noktalarını listeler. |
list |
Temel alınan veri deposundan tüm mevcut bölüm sahipliğinin listesini almak için çağrılır. Mevcut sahiplik bilgisi yoksa boş sonuçlar döndürebilir. |
update |
Bir bölümün veri deposundaki denetim noktasını Güncelleştirmeler. |
Yöntem Ayrıntıları
claimOwnership(PartitionOwnership[], OperationOptions)
Bir bölüm listesinin sahipliğini talep etmek için çağrılır. Bu, başarıyla sahip olunan bölümlerin listesini döndürür.
function claimOwnership(partitionOwnership: PartitionOwnership[], options?: OperationOptions): Promise<PartitionOwnership[]>
Parametreler
- partitionOwnership
Bu örneğin sahip olduğunu iddia ediyor olduğu bölüm sahipliğinin listesi.
- options
- OperationOptions
Bu yöntemin davranışını etkilemek için belirtilebilen bir dizi seçenek.
abortSignal
: İşlem iptali istemek için kullanılan sinyal.tracingOptions
: İzlemeyi yapılandırma seçenekleri.
Döndürülenler
Promise<PartitionOwnership[]>
Bu örneğin sahipliği başarıyla talep ettiği bölümlerin listesi.
listCheckpoints(string, string, string, OperationOptions)
Belirli bir ad alanı, eventhub ve tüketici grubu için veri deposundaki tüm denetim noktalarını listeler.
function listCheckpoints(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<Checkpoint[]>
Parametreler
- fullyQualifiedNamespace
-
string
Tam Event Hubs ad alanı. Bu büyük olasılıkla .servicebus.windows.net'a benzer.
- eventHubName
-
string
Olay hub'ı adı.
- consumerGroup
-
string
Tüketici grubu adı.
- options
- OperationOptions
Bu yöntemin davranışını etkilemek için belirtilebilen bir dizi seçenek.
abortSignal
: İşlem iptali istemek için kullanılan sinyal.tracingOptions
: İzlemeyi yapılandırma seçenekleri.
Döndürülenler
Promise<Checkpoint[]>
Belirli bir ad alanı, eventhub ve tüketici grubu için denetim noktalarının listesi.
listOwnership(string, string, string, OperationOptions)
Temel alınan veri deposundan tüm mevcut bölüm sahipliğinin listesini almak için çağrılır. Mevcut sahiplik bilgisi yoksa boş sonuçlar döndürebilir.
function listOwnership(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<PartitionOwnership[]>
Parametreler
- fullyQualifiedNamespace
-
string
Tam Event Hubs ad alanı. Bu büyük olasılıkla .servicebus.windows.net'a benzer.
- eventHubName
-
string
Olay hub'ı adı.
- consumerGroup
-
string
Tüketici grubu adı.
- options
- OperationOptions
Bu yöntemin davranışını etkilemek için belirtilebilen bir dizi seçenek.
abortSignal
: İşlem iptali istemek için kullanılan sinyal.tracingOptions
: İzlemeyi yapılandırma seçenekleri.
Döndürülenler
Promise<PartitionOwnership[]>
Sahibi olan/sahip olan tüm bölümlerin bölüm sahipliği ayrıntılarının listesi.
updateCheckpoint(Checkpoint, OperationOptions)
Bir bölümün veri deposundaki denetim noktasını Güncelleştirmeler.
function updateCheckpoint(checkpoint: Checkpoint, options?: OperationOptions): Promise<void>
Parametreler
- checkpoint
- Checkpoint
Kontrol noktası.
- options
- OperationOptions
Bu yöntemin davranışını etkilemek için belirtilebilen bir dizi seçenek.
abortSignal
: İşlem iptali istemek için kullanılan sinyal.tracingOptions
: İzlemeyi yapılandırma seçenekleri.
Döndürülenler
Promise<void>