CheckpointStore interface
Penyimpanan titik pemeriksaan menyimpan dan mengambil informasi kepemilikan partisi dan detail titik pemeriksaan untuk setiap partisi dalam grup konsumen tertentu dari instans pusat aktivitas.
Pengguna tidak dimaksudkan untuk menerapkan CheckpointStore.
Pengguna diharapkan untuk memilih implementasi antarmuka ini yang ada, membuat instansnya, dan meneruskannya ke konstruktor kelas EventHubConsumerClient saat membuat instans klien.
Pengguna tidak diharapkan menggunakan salah satu metode di penyimpanan titik pemeriksaan, ini digunakan secara internal oleh klien.
Implementasi CheckpointStore dapat ditemukan di npm dengan mencari paket dengan awalan @azure/eventhub-checkpointstore-.
Metode
| claim |
Dipanggil untuk mengklaim kepemilikan daftar partisi. Ini akan mengembalikan daftar partisi yang berhasil dimiliki. |
| list |
Mencantumkan semua titik pemeriksaan di penyimpanan data untuk namespace, eventhub, dan grup konsumen tertentu. |
| list |
Dipanggil untuk mendapatkan daftar semua kepemilikan partisi yang ada dari penyimpanan data yang mendasar. Dapat mengembalikan hasil kosong jika tidak ada informasi kepemilikan yang ada. |
| update |
Memperbarui titik pemeriksaan di penyimpanan data untuk partisi. |
Detail Metode
claimOwnership(PartitionOwnership[], OperationOptions)
Dipanggil untuk mengklaim kepemilikan daftar partisi. Ini akan mengembalikan daftar partisi yang berhasil dimiliki.
function claimOwnership(partitionOwnership: PartitionOwnership[], options?: OperationOptions): Promise<PartitionOwnership[]>Parameter
- partitionOwnership
Daftar kepemilikan partisi yang diklaim oleh instans ini.
- options
- OperationOptions
Sekumpulan opsi yang dapat ditentukan untuk memengaruhi perilaku metode ini.
-
abortSignal: Sinyal yang digunakan untuk meminta pembatalan operasi. -
tracingOptions: Opsi untuk mengonfigurasi pelacakan.
Mengembalikan
Promise<PartitionOwnership[]>
Daftar partisi instans ini berhasil mengklaim kepemilikan.
listCheckpoints(string, string, string, OperationOptions)
Mencantumkan semua titik pemeriksaan di penyimpanan data untuk namespace, eventhub, dan grup konsumen tertentu.
function listCheckpoints(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<Checkpoint[]>Parameter
- fullyQualifiedNamespace
-
string
Namespace Layanan Azure Event Hubs yang sepenuhnya memenuhi syarat. Ini kemungkinan mirip dengan <yournamespace.servicebus.windows.net>.
- eventHubName
-
string
Nama pusat aktivitas.
- consumerGroup
-
string
Nama grup konsumen.
- options
- OperationOptions
Sekumpulan opsi yang dapat ditentukan untuk memengaruhi perilaku metode ini.
-
abortSignal: Sinyal yang digunakan untuk meminta pembatalan operasi. -
tracingOptions: Opsi untuk mengonfigurasi pelacakan.
Mengembalikan
Promise<Checkpoint[]>
Daftar titik pemeriksaan untuk namespace, eventhub, dan grup konsumen tertentu.
listOwnership(string, string, string, OperationOptions)
Dipanggil untuk mendapatkan daftar semua kepemilikan partisi yang ada dari penyimpanan data yang mendasar. Dapat mengembalikan hasil kosong jika tidak ada informasi kepemilikan yang ada.
function listOwnership(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<PartitionOwnership[]>Parameter
- fullyQualifiedNamespace
-
string
Namespace Layanan Azure Event Hubs yang sepenuhnya memenuhi syarat. Ini kemungkinan mirip dengan <yournamespace.servicebus.windows.net>.
- eventHubName
-
string
Nama pusat aktivitas.
- consumerGroup
-
string
Nama grup konsumen.
- options
- OperationOptions
Sekumpulan opsi yang dapat ditentukan untuk memengaruhi perilaku metode ini.
-
abortSignal: Sinyal yang digunakan untuk meminta pembatalan operasi. -
tracingOptions: Opsi untuk mengonfigurasi pelacakan.
Mengembalikan
Promise<PartitionOwnership[]>
Daftar detail kepemilikan partisi dari semua partisi yang memiliki/memiliki pemilik.
updateCheckpoint(Checkpoint, OperationOptions)
Memperbarui titik pemeriksaan di penyimpanan data untuk partisi.
function updateCheckpoint(checkpoint: Checkpoint, options?: OperationOptions): Promise<void>Parameter
- checkpoint
- Checkpoint
Titik pemeriksaan.
- options
- OperationOptions
Sekumpulan opsi yang dapat ditentukan untuk memengaruhi perilaku metode ini.
-
abortSignal: Sinyal yang digunakan untuk meminta pembatalan operasi. -
tracingOptions: Opsi untuk mengonfigurasi pelacakan.
Mengembalikan
Promise<void>