CheckpointStore interface
Хранилище контрольных точек хранит и извлекает сведения о владельце секции и сведения о контрольной точке для каждой секции в заданной группе потребителей экземпляра концентратора событий.
Пользователи не предназначены для реализации CheckpointStore.
Ожидается, что пользователи будут выбирать существующие реализации этого интерфейса, создавать экземпляры и передавать его конструктору класса EventHubConsumerClient при создании экземпляра клиента.
Пользователи не должны использовать какие-либо методы в хранилище контрольных точек, они используются внутри клиента.
Реализации CheckpointStore можно найти в npm, выполнив поиск пакетов с префиксом @azure/eventhub-checkpointstore-.
Методы
| claim |
Вызывается для утверждения владения списком секций. При этом будет возвращен список секций, принадлежащих успешно. |
| list |
Выводит список всех контрольных точек в хранилище данных для заданного пространства имен, концентратора событий и группы потребителей. |
| list |
Вызывается для получения списка всех существующих владельцев секций из базового хранилища данных. Может возвращать пустые результаты, если нет существующих сведений о владельце. |
| update |
Обновляет контрольную точку в хранилище данных для секции. |
Сведения о методе
claimOwnership(PartitionOwnership[], OperationOptions)
Вызывается для утверждения владения списком секций. При этом будет возвращен список секций, принадлежащих успешно.
function claimOwnership(partitionOwnership: PartitionOwnership[], options?: OperationOptions): Promise<PartitionOwnership[]>Параметры
- partitionOwnership
Список владельцев секций, который этот экземпляр утверждает, что он принадлежит.
- options
- OperationOptions
Набор параметров, которые можно указать для влияния на поведение этого метода.
-
abortSignal: сигнал, используемый для отмены операции запроса. -
tracingOptions: параметры настройки трассировки.
Возвращаемое значение
Promise<PartitionOwnership[]>
Список секций, которые этот экземпляр успешно претендовал на владение.
listCheckpoints(string, string, string, OperationOptions)
Выводит список всех контрольных точек в хранилище данных для заданного пространства имен, концентратора событий и группы потребителей.
function listCheckpoints(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<Checkpoint[]>Параметры
- fullyQualifiedNamespace
-
string
Полное пространство имен Центров событий. Скорее всего, это будет похоже на <yournamespace.servicebus.windows.net>.
- eventHubName
-
string
Имя концентратора событий.
- consumerGroup
-
string
Имя группы потребителей.
- options
- OperationOptions
Набор параметров, которые можно указать для влияния на поведение этого метода.
-
abortSignal: сигнал, используемый для отмены операции запроса. -
tracingOptions: параметры настройки трассировки.
Возвращаемое значение
Promise<Checkpoint[]>
Список контрольных точек для заданного пространства имен, концентратора событий и группы потребителей.
listOwnership(string, string, string, OperationOptions)
Вызывается для получения списка всех существующих владельцев секций из базового хранилища данных. Может возвращать пустые результаты, если нет существующих сведений о владельце.
function listOwnership(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<PartitionOwnership[]>Параметры
- fullyQualifiedNamespace
-
string
Полное пространство имен Центров событий. Скорее всего, это будет похоже на <yournamespace.servicebus.windows.net>.
- eventHubName
-
string
Имя концентратора событий.
- consumerGroup
-
string
Имя группы потребителей.
- options
- OperationOptions
Набор параметров, которые можно указать для влияния на поведение этого метода.
-
abortSignal: сигнал, используемый для отмены операции запроса. -
tracingOptions: параметры настройки трассировки.
Возвращаемое значение
Promise<PartitionOwnership[]>
Список сведений о владельцах секций всех секций, имеющих или имеющих владельца.
updateCheckpoint(Checkpoint, OperationOptions)
Обновляет контрольную точку в хранилище данных для секции.
function updateCheckpoint(checkpoint: Checkpoint, options?: OperationOptions): Promise<void>Параметры
- checkpoint
- Checkpoint
Контрольная точка.
- options
- OperationOptions
Набор параметров, которые можно указать для влияния на поведение этого метода.
-
abortSignal: сигнал, используемый для отмены операции запроса. -
tracingOptions: параметры настройки трассировки.
Возвращаемое значение
Promise<void>