CheckpointStore interface
Un almacén de puntos de control almacena y recupera la información de propiedad de la partición y los detalles del punto de control de cada partición de un grupo de consumidores determinado de una instancia del centro de eventos.
Los usuarios no están diseñados para implementar un CheckpointStore.
Se espera que los usuarios elijan implementaciones existentes de esta interfaz, cree una instancia de ella y pásela al EventHubConsumerClient constructor de clase al crear una instancia de un cliente.
No se espera que los usuarios usen ninguno de los métodos de un almacén de puntos de control; el cliente los usa internamente.
Las implementaciones de CheckpointStore se pueden encontrar en npm mediante la búsqueda de paquetes con el prefijo @azure/eventhub-checkpointstore-.
Métodos
| claim |
Se llama para reclamar la propiedad de una lista de particiones. Esto devolverá la lista de particiones que se han propiedaddo correctamente. |
| list |
Enumera todos los puntos de control de un almacén de datos para un espacio de nombres determinado, un centro de eventos y un grupo de consumidores. |
| list |
Se llama para obtener la lista de toda la propiedad de partición existente del almacén de datos subyacente. Podría devolver resultados vacíos si no hay información de propiedad existente. |
| update |
Novedades el punto de control en el almacén de datos de una partición. |
Detalles del método
claimOwnership(PartitionOwnership[], OperationOptions)
Se llama para reclamar la propiedad de una lista de particiones. Esto devolverá la lista de particiones que se han propiedaddo correctamente.
function claimOwnership(partitionOwnership: PartitionOwnership[], options?: OperationOptions): Promise<PartitionOwnership[]>Parámetros
- partitionOwnership
La lista de la propiedad de la partición que esta instancia está reclamando es propietaria.
- options
- OperationOptions
Conjunto de opciones que se pueden especificar para influir en el comportamiento de este método.
-
abortSignal: señal usada para solicitar la cancelación de la operación. -
tracingOptions: opciones para configurar el seguimiento.
Devoluciones
Promise<PartitionOwnership[]>
Una lista de particiones que esta instancia ha reclamado correctamente la propiedad.
listCheckpoints(string, string, string, OperationOptions)
Enumera todos los puntos de control de un almacén de datos para un espacio de nombres determinado, un centro de eventos y un grupo de consumidores.
function listCheckpoints(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<Checkpoint[]>Parámetros
- fullyQualifiedNamespace
-
string
Espacio de nombres completo de Event Hubs. Es probable que sea similar a .servicebus.windows.net.
- eventHubName
-
string
Nombre del centro de eventos.
- consumerGroup
-
string
Nombre del grupo de consumidores.
- options
- OperationOptions
Conjunto de opciones que se pueden especificar para influir en el comportamiento de este método.
-
abortSignal: señal usada para solicitar la cancelación de la operación. -
tracingOptions: opciones para configurar el seguimiento.
Devoluciones
Promise<Checkpoint[]>
Lista de puntos de control de un espacio de nombres, un centro de eventos y un grupo de consumidores determinado.
listOwnership(string, string, string, OperationOptions)
Se llama para obtener la lista de toda la propiedad de partición existente del almacén de datos subyacente. Podría devolver resultados vacíos si no hay información de propiedad existente.
function listOwnership(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<PartitionOwnership[]>Parámetros
- fullyQualifiedNamespace
-
string
Espacio de nombres completo de Event Hubs. Es probable que sea similar a .servicebus.windows.net.
- eventHubName
-
string
Nombre del centro de eventos.
- consumerGroup
-
string
Nombre del grupo de consumidores.
- options
- OperationOptions
Conjunto de opciones que se pueden especificar para influir en el comportamiento de este método.
-
abortSignal: señal usada para solicitar la cancelación de la operación. -
tracingOptions: opciones para configurar el seguimiento.
Devoluciones
Promise<PartitionOwnership[]>
Una lista de detalles de propiedad de partición de todas las particiones que tienen o tenían un propietario.
updateCheckpoint(Checkpoint, OperationOptions)
Novedades el punto de control en el almacén de datos de una partición.
function updateCheckpoint(checkpoint: Checkpoint, options?: OperationOptions): Promise<void>Parámetros
- checkpoint
- Checkpoint
Punto de control.
- options
- OperationOptions
Conjunto de opciones que se pueden especificar para influir en el comportamiento de este método.
-
abortSignal: señal usada para solicitar la cancelación de la operación. -
tracingOptions: opciones para configurar el seguimiento.
Devoluciones
Promise<void>