Partager via

CheckpointStore Classe

  • Référence

CheckpointStore traite de l’interaction avec le service de stockage choisi.

Il peut répertorier et revendiquer des propriétés de partition, ainsi que répertorier et enregistrer des points de contrôle.

Héritage
builtins.object
CheckpointStore

Constructeur

CheckpointStore()

Méthodes

claim_ownership

Tente de revendiquer la propriété d’une liste de partitions spécifiées.
list_checkpoints

Répertoriez les points de contrôle mis à jour du service de stockage choisi.
list_ownership

Récupère une liste de propriétés complète à partir du service de stockage choisi.
update_checkpoint

Mises à jour le point de contrôle à l’aide des informations fournies pour le décalage, la partition associée et le groupe de consommateurs dans le service de stockage choisi.

Remarque : si vous envisagez d’implémenter un magasin de points de contrôle personnalisé avec l’intention d’exécuter entre des sdk EventHubs inter-langues, il est recommandé de conserver la valeur de décalage sous forme d’entier.

claim_ownership

Tente de revendiquer la propriété d’une liste de partitions spécifiées.

abstract claim_ownership(ownership_list: Iterable[Dict[str, Any]], **kwargs: Any) -> Iterable[Dict[str, Any]]

Paramètres

Nom Description
ownership_list
Obligatoire
Iterable[Dict[str,Any]]

Itérable des dictionnaires contenant toutes les propriétés à revendiquer.

Retours

Type Description
Iterable[Dict[str,Any]], Iterable <xref:of> <xref:dictionaries> <xref:containing> <xref:azure.eventhub.amqp.AmqpMessageBodyType.partition> <xref:ownership> <xref:information>:fully_qualified_namespace (str): <xref:The> <xref:fully> <xref:qualified> <xref:namespace> <xref:that> <xref:the> <xref:Event> <xref:Hub> <xref:belongs> <xref:to.> <xref:The> <xref:azure.eventhub.amqp.AmqpMessageBodyType.format> <xref:is> <xref:like> “<<xref:namespace>><xref:.servicebus.windows.net>”<xref:.> eventhub_name (str): <xref:The> <xref:name> <xref:of> <xref:the> <xref:specific> <xref:Event> <xref:Hub> <xref:the> <xref:checkpoint> <xref:is> <xref:associated> <xref:with>, <xref:relative> <xref:to> <xref:the> <xref:Event> <xref:Hubs> <xref:namespace> <xref:that> <xref:contains> <xref:it.> <xref:consumer_group> (str): <xref:The> <xref:name> <xref:of> <xref:the> <xref:consumer> <xref:group> <xref:the> <xref:ownership> <xref:are> <xref:associated> <xref:with.> <xref:partition_id> (str): <xref:The> <xref:azure.eventhub.amqp.AmqpMessageBodyType.partition> <xref:ID> <xref:which> <xref:the> <xref:checkpoint> <xref:is> <xref:created> <xref:for.> <xref:owner_id> (str): <xref:A> <xref:UUID> <xref:representing> <xref:the> <xref:owner> <xref:attempting> <xref:to> <xref:claim> <xref:this> <xref:partition.> <xref:last_modified_time> (<xref:UTC> datetime): <xref:The> <xref:last> time <xref:this> <xref:ownership> <xref:was> <xref:claimed.> <xref:etag> (str): <xref:The> <xref:Etag> <xref:value> <xref:for> <xref:the> <xref:last> time <xref:this> <xref:ownership> <xref:was> <xref:modified.> Optional <xref:depending> <xref:on> <xref:storage> <xref:implementation.>

list_checkpoints

Répertoriez les points de contrôle mis à jour du service de stockage choisi.

abstract list_checkpoints(fully_qualified_namespace: str, eventhub_name: str, consumer_group: str, **kwargs: Any) -> Iterable[Dict[str, Any]]

Paramètres

Nom Description
fully_qualified_namespace
Obligatoire
str

Espace de noms complet auquel appartient Event Hub. Le format est semblable à « . servicebus.windows.net « .
eventhub_name
Obligatoire
str

Nom du hub d’événements spécifique auquel les points de contrôle sont associés, par rapport à l’espace de noms Event Hubs qui le contient.
consumer_group
Obligatoire
str

Nom du groupe de consommateurs auquel les points de contrôle sont associés.

Retours

Type Description
Iterable[Dict[str,Any]], Iterable <xref:of> <xref:dictionaries> <xref:containing> <xref:azure.eventhub.amqp.AmqpMessageBodyType.partition> <xref:checkpoint> <xref:information>:fully_qualified_namespace (str): <xref:The> <xref:fully> <xref:qualified> <xref:namespace> <xref:that> <xref:the> <xref:Event> <xref:Hub> <xref:belongs> <xref:to.> <xref:The> <xref:azure.eventhub.amqp.AmqpMessageBodyType.format> <xref:is> <xref:like> “<<xref:namespace>><xref:.servicebus.windows.net>”<xref:.> eventhub_name (str): <xref:The> <xref:name> <xref:of> <xref:the> <xref:specific> <xref:Event> <xref:Hub> <xref:the> <xref:checkpoints> <xref:are> <xref:associated> <xref:with>, <xref:relative> <xref:to> <xref:the> <xref:Event> <xref:Hubs> <xref:namespace> <xref:that> <xref:contains> <xref:it.> <xref:consumer_group> (str): <xref:The> <xref:name> <xref:of> <xref:the> <xref:consumer> <xref:group> <xref:the> <xref:checkpoints> <xref:are> <xref:associated> <xref:with.> <xref:partition_id> (str): <xref:The> <xref:azure.eventhub.amqp.AmqpMessageBodyType.partition> <xref:ID> <xref:which> <xref:the> <xref:checkpoint> <xref:is> <xref:created> <xref:for.> sequence_number (int): <xref:The> <xref:sequence> <xref:number> <xref:of> <xref:the> <xref:EventData.> offset (str): <xref:The> offset <xref:of> <xref:the> <xref:EventData.>

list_ownership

Récupère une liste de propriétés complète à partir du service de stockage choisi.

abstract list_ownership(fully_qualified_namespace: str, eventhub_name: str, consumer_group: str, **kwargs: Any) -> Iterable[Dict[str, Any]]

Paramètres

Nom Description
fully_qualified_namespace
Obligatoire
str

Espace de noms complet auquel appartient Event Hub. Le format est semblable à « . servicebus.windows.net « .
eventhub_name
Obligatoire
str

Nom du hub d’événements spécifique auquel les propriétés de partition sont associées, par rapport à l’espace de noms Event Hubs qui le contient.
consumer_group
Obligatoire
str

Nom du groupe de consommateurs auquel les propriétaires sont associés.

Retours

Type Description
Iterable[Dict[str, Any]], Iterable <xref:of> <xref:dictionaries> <xref:containing> <xref:azure.eventhub.amqp.AmqpMessageBodyType.partition> <xref:ownership> <xref:information>:fully_qualified_namespace (str): <xref:The> <xref:fully> <xref:qualified> <xref:namespace> <xref:that> <xref:the> <xref:Event> <xref:Hub> <xref:belongs> <xref:to.> <xref:The> <xref:azure.eventhub.amqp.AmqpMessageBodyType.format> <xref:is> <xref:like> “<<xref:namespace>><xref:.servicebus.windows.net>”<xref:.> eventhub_name (str): <xref:The> <xref:name> <xref:of> <xref:the> <xref:specific> <xref:Event> <xref:Hub> <xref:the> <xref:checkpoint> <xref:is> <xref:associated> <xref:with>, <xref:relative> <xref:to> <xref:the> <xref:Event> <xref:Hubs> <xref:namespace> <xref:that> <xref:contains> <xref:it.> <xref:consumer_group> (str): <xref:The> <xref:name> <xref:of> <xref:the> <xref:consumer> <xref:group> <xref:the> <xref:ownership> <xref:are> <xref:associated> <xref:with.> <xref:partition_id> (str): <xref:The> <xref:azure.eventhub.amqp.AmqpMessageBodyType.partition> <xref:ID> <xref:which> <xref:the> <xref:checkpoint> <xref:is> <xref:created> <xref:for.> <xref:owner_id> (str): <xref:A> <xref:UUID> <xref:representing> <xref:the> <xref:current> <xref:owner> <xref:of> <xref:this> <xref:partition.> <xref:last_modified_time> (<xref:UTC> datetime): <xref:The> <xref:last> time <xref:this> <xref:ownership> <xref:was> <xref:claimed.> <xref:etag> (str): <xref:The> <xref:Etag> <xref:value> <xref:for> <xref:the> <xref:last> time <xref:this> <xref:ownership> <xref:was> <xref:modified.> Optional <xref:depending> <xref:on> <xref:storage> <xref:implementation.>

update_checkpoint

Mises à jour le point de contrôle à l’aide des informations fournies pour le décalage, la partition associée et le groupe de consommateurs dans le service de stockage choisi.

Remarque : si vous envisagez d’implémenter un magasin de points de contrôle personnalisé avec l’intention d’exécuter entre des sdk EventHubs inter-langues, il est recommandé de conserver la valeur de décalage sous forme d’entier.

abstract update_checkpoint(checkpoint: Dict[str, str | int | None], **kwargs: Any) -> None

Paramètres

Nom Description
checkpoint
Obligatoire
Dict[str,Any]

dict contenant des informations de point de contrôle :

  • fully_qualified_namespace (str) : espace de noms complet auquel le hub d’événements appartient. Le format est semblable à « . servicebus.windows.net « .

  • eventhub_name (str) : nom du hub d’événements spécifique auquel le point de contrôle est associé, par rapport à l’espace de noms Event Hubs qui le contient.

  • consumer_group (str) : nom du groupe de consommateurs auquel le point de contrôle est associé.

  • partition_id (str) : ID de partition pour lequel le point de contrôle est créé.

  • sequence_number (int) : numéro de séquence du EventData nouveau point de contrôle est associé.

  • offset (str) : décalage du EventData nouveau point de contrôle est associé.

Retours

Type Description
None