CheckpointStore interface
Um arquivo de pontos de verificação armazena e obtém informações de propriedade de partição e detalhes de ponto de verificação para cada partição num determinado grupo de consumidores de uma instância do hub de eventos.
Os utilizadores não se destinam a implementar um CheckpointStore.
Espera-se que os utilizadores escolham implementações existentes desta interface, instanciem-na e transmitam-na para o construtor de classes EventHubConsumerClient ao instanciar um cliente.
Não se espera que os utilizadores utilizem nenhum dos métodos num arquivo de pontos de verificação. Estes métodos são utilizados internamente pelo cliente.
As implementações de CheckpointStore podem ser encontradas no npm ao procurar pacotes com o prefixo @azure/eventhub-checkpointstore-.
Métodos
| claim |
Chamada para reclamar a propriedade de uma lista de partições. Esta ação devolverá a lista de partições que foram propriedade com êxito. |
| list |
Lista todos os pontos de verificação num arquivo de dados para um determinado espaço de nomes, eventhub e grupo de consumidores. |
| list |
Chamada para obter a lista de toda a propriedade de partição existente no arquivo de dados subjacente. Pode devolver resultados vazios se não existirem informações de propriedade. |
| update |
Atualizações o ponto de verificação no arquivo de dados de uma partição. |
Detalhes de Método
claimOwnership(PartitionOwnership[], OperationOptions)
Chamada para reclamar a propriedade de uma lista de partições. Esta ação devolverá a lista de partições que foram propriedade com êxito.
function claimOwnership(partitionOwnership: PartitionOwnership[], options?: OperationOptions): Promise<PartitionOwnership[]>Parâmetros
- partitionOwnership
A lista de propriedade da partição que esta instância afirma ser proprietária.
- options
- OperationOptions
Um conjunto de opções que podem ser especificadas para influenciar o comportamento deste método.
-
abortSignal: um sinal utilizado para pedir o cancelamento da operação. -
tracingOptions: opções para configurar o rastreio.
Devoluções
Promise<PartitionOwnership[]>
Uma lista de partições que esta instância reivindicou com êxito a propriedade.
listCheckpoints(string, string, string, OperationOptions)
Lista todos os pontos de verificação num arquivo de dados para um determinado espaço de nomes, eventhub e grupo de consumidores.
function listCheckpoints(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<Checkpoint[]>Parâmetros
- fullyQualifiedNamespace
-
string
O espaço de nomes dos Hubs de Eventos completamente qualificado. É provável que seja semelhante a .servicebus.windows.net.
- eventHubName
-
string
O nome do hub de eventos.
- consumerGroup
-
string
O nome do grupo de consumidores.
- options
- OperationOptions
Um conjunto de opções que podem ser especificadas para influenciar o comportamento deste método.
-
abortSignal: um sinal utilizado para pedir o cancelamento da operação. -
tracingOptions: opções para configurar o rastreio.
Devoluções
Promise<Checkpoint[]>
Uma lista de pontos de verificação para um determinado espaço de nomes, eventhub e grupo de consumidores.
listOwnership(string, string, string, OperationOptions)
Chamada para obter a lista de toda a propriedade de partição existente no arquivo de dados subjacente. Pode devolver resultados vazios se não existirem informações de propriedade.
function listOwnership(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<PartitionOwnership[]>Parâmetros
- fullyQualifiedNamespace
-
string
O espaço de nomes dos Hubs de Eventos completamente qualificado. É provável que seja semelhante a .servicebus.windows.net.
- eventHubName
-
string
O nome do hub de eventos.
- consumerGroup
-
string
O nome do grupo de consumidores.
- options
- OperationOptions
Um conjunto de opções que podem ser especificadas para influenciar o comportamento deste método.
-
abortSignal: um sinal utilizado para pedir o cancelamento da operação. -
tracingOptions: opções para configurar o rastreio.
Devoluções
Promise<PartitionOwnership[]>
Uma lista de detalhes de propriedade da partição de todas as partições que têm/tiveram um proprietário.
updateCheckpoint(Checkpoint, OperationOptions)
Atualizações o ponto de verificação no arquivo de dados de uma partição.
function updateCheckpoint(checkpoint: Checkpoint, options?: OperationOptions): Promise<void>Parâmetros
- checkpoint
- Checkpoint
O ponto de verificação.
- options
- OperationOptions
Um conjunto de opções que podem ser especificadas para influenciar o comportamento deste método.
-
abortSignal: um sinal utilizado para pedir o cancelamento da operação. -
tracingOptions: opções para configurar o rastreio.
Devoluções
Promise<void>