CheckpointStore interface
Um armazenamento de ponto de verificação armazena e recupera informações de propriedade de partição e detalhes de ponto de verificação para cada partição em um determinado grupo de consumidores de uma instância de hub de eventos.
Os usuários não devem implementar um CheckpointStore.
Espera-se que os usuários escolham implementações existentes dessa interface, instanciem-na e passem-na para o construtor de classe EventHubConsumerClient ao instanciar um cliente.
Não se espera que os usuários usem nenhum dos métodos em um armazenamento de ponto de verificação, eles são usados internamente pelo cliente.
Implementações de CheckpointStore podem ser encontradas no npm pesquisando pacotes com o prefixo @azure/eventhub-checkpointstore-.
Métodos
| claim |
Chamado para reivindicar a propriedade de uma lista de partições. Isso retornará a lista de partições que foram possuídas com êxito. |
| list |
Lista todos os pontos de verificação em um armazenamento de dados para um determinado namespace, eventhub e grupo de consumidores. |
| list |
Chamado para obter a lista de toda a propriedade de partição existente do armazenamento de dados subjacente. Pode retornar resultados vazios se não houver informações de propriedade existentes. |
| update |
Atualiza o ponto de verificação no armazenamento de dados para uma partição. |
Detalhes de Método
claimOwnership(PartitionOwnership[], OperationOptions)
Chamado para reivindicar a propriedade de uma lista de partições. Isso retornará a lista de partições que foram possuídas com êxito.
function claimOwnership(partitionOwnership: PartitionOwnership[], options?: OperationOptions): Promise<PartitionOwnership[]>Parâmetros
- partitionOwnership
A lista de propriedade da partição que esta instância alega possuir.
- options
- OperationOptions
Um conjunto de opções que podem ser especificadas para influenciar o comportamento desse método.
-
abortSignal: Um sinal usado para solicitar o cancelamento da operação. -
tracingOptions: Opções para configurar o rastreamento.
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 em um armazenamento de dados para um determinado namespace, eventhub e grupo de consumidores.
function listCheckpoints(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<Checkpoint[]>Parâmetros
- fullyQualifiedNamespace
-
string
O namespace Hubs de Eventos totalmente qualificado. É provável que isso seja semelhante ao <seunamespace.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 desse método.
-
abortSignal: Um sinal usado para solicitar o cancelamento da operação. -
tracingOptions: Opções para configurar o rastreamento.
Devoluções
Promise<Checkpoint[]>
Uma lista de pontos de verificação para um determinado namespace, eventhub e grupo de consumidores.
listOwnership(string, string, string, OperationOptions)
Chamado para obter a lista de toda a propriedade de partição existente do armazenamento de dados subjacente. Pode retornar resultados vazios se não houver informações de propriedade existentes.
function listOwnership(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<PartitionOwnership[]>Parâmetros
- fullyQualifiedNamespace
-
string
O namespace Hubs de Eventos totalmente qualificado. É provável que isso seja semelhante ao <seunamespace.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 desse método.
-
abortSignal: Um sinal usado para solicitar o cancelamento da operação. -
tracingOptions: Opções para configurar o rastreamento.
Devoluções
Promise<PartitionOwnership[]>
Uma lista de detalhes de propriedade de partição de todas as partições que têm/tiveram um proprietário.
updateCheckpoint(Checkpoint, OperationOptions)
Atualiza o ponto de verificação no armazenamento de dados para 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 desse método.
-
abortSignal: Um sinal usado para solicitar o cancelamento da operação. -
tracingOptions: Opções para configurar o rastreamento.
Devoluções
Promise<void>