EventHubProducerClient Classe

Fermez la connexion et les liens AMQP sous-jacents du client Producteur.

async close(*, flush: bool = True, **kwargs: Any) -> None

Paramètres

Type de retour

Exceptions

Si une erreur s’est produite lors du vidage de la mémoire tampon si le vidage est défini sur True ou lors de la fermeture des connexions AMQP sous-jacentes en mode mis en mémoire tampon.

Exemples

Fermez le gestionnaire.

   import os
   from azure.eventhub.aio import EventHubProducerClient
   from azure.eventhub import EventData

   event_hub_connection_str = os.environ['EVENT_HUB_CONN_STR']
   eventhub_name = os.environ['EVENT_HUB_NAME']

   producer = EventHubProducerClient.from_connection_string(
       conn_str=event_hub_connection_str,
       eventhub_name=eventhub_name  # EventHub name should be specified if it doesn't show up in connection string.
   )
   try:
       event_data_batch = await producer.create_batch()
       while True:
           try:
               event_data_batch.add(EventData('Message inside EventBatchData'))
           except ValueError:
               # The EventDataBatch object reaches its max_size.
               # You can send the full EventDataBatch object and create a new one here.
               break
       await producer.send_batch(event_data_batch)
   finally:
       # Close down the producer handler.
       await producer.close()

Créez un objet EventDataBatch dont la taille maximale de tout le contenu est limitée par max_size_in_bytes.

La max_size_in_bytes ne doit pas être supérieure à la taille maximale autorisée des messages définie par le service.

async create_batch(*, partition_id: str | None = None, partition_key: str | None = None, max_size_in_bytes: int | None = None) -> EventDataBatch

Type de retour

Exceptions

Si une erreur s’est produite lors du vidage de la mémoire tampon si le vidage est défini sur True ou lors de la fermeture des connexions AMQP sous-jacentes en mode mis en mémoire tampon.

Exemples

Créer un objet EventDataBatch de taille limitée

       from azure.eventhub import EventData
       event_data_batch = await producer.create_batch()
       while True:
           try:
               event_data_batch.add(EventData('Message inside EventBatchData'))
           except ValueError:
               # The EventDataBatch object reaches its max_size.
               # You can send the full EventDataBatch object and create a new one here.
               break

Mode mis en mémoire tampon uniquement. Vider les événements dans la mémoire tampon à envoyer immédiatement si le client fonctionne en mode mis en mémoire tampon.

async flush(**kwargs: Any) -> None

Paramètres

Type de retour

Exceptions

Si le producteur ne parvient pas à vider la mémoire tampon dans le délai d’expiration donné en mode mis en mémoire tampon.

Créez un EventHubProducerClient à partir d’un chaîne de connexion.

from_connection_string(conn_str: str, *, eventhub_name: str | None = None, buffered_mode: bool = False, on_error: Callable[[List[EventData | AmqpAnnotatedMessage], str | None, Exception], Awaitable[None]] | None = None, on_success: Callable[[List[EventData | AmqpAnnotatedMessage], str | None], Awaitable[None]] | None = None, max_buffer_length: int | None = None, max_wait_time: float | None = None, logging_enable: bool = False, http_proxy: Dict[str, str | int] | None = None, auth_timeout: float = 60, user_agent: str | None = None, retry_total: int = 3, transport_type: TransportType = TransportType.Amqp, **kwargs: Any) -> EventHubProducerClient

Paramètres

Type de retour

Exceptions

Si une erreur s’est produite lors du vidage de la mémoire tampon si le vidage est défini sur True ou lors de la fermeture des connexions AMQP sous-jacentes en mode mis en mémoire tampon.

Exemples

Créez une instance de EventHubProducerClient à partir de chaîne de connexion.

   import os
   from azure.eventhub.aio import EventHubProducerClient
   event_hub_connection_str = os.environ['EVENT_HUB_CONN_STR']
   eventhub_name = os.environ['EVENT_HUB_NAME']
   producer = EventHubProducerClient.from_connection_string(
       conn_str=event_hub_connection_str,
       eventhub_name=eventhub_name  # EventHub name should be specified if it doesn't show up in connection string.
   )

Nombre d’événements mis en mémoire tampon et en attente de publication pour une partition donnée. Retourne Aucun en mode non mis en mémoire tampon. REMARQUE : La mémoire tampon d’événements est traitée dans une coroutine d’arrière-plan. Par conséquent, le nombre d’événements dans la mémoire tampon signalé par cette API doit être considéré comme une approximation et n’est recommandé que pour le débogage. Pour un ID de partition pour lequel aucun événement n’est mis en mémoire tampon, 0 est retourné, que cet ID de partition existe réellement dans le hub d’événements.

get_buffered_event_count(partition_id: str) -> int | None

Paramètres

Type de retour

Exceptions

Si une erreur s’est produite lors du vidage de la mémoire tampon si le vidage est défini sur True ou lors de la fermeture des connexions AMQP sous-jacentes en mode mis en mémoire tampon.

Obtient les propriétés du hub d’événements.

Les clés dans le dictionnaire retourné sont les suivantes :

• eventhub_name (str)

• created_at (UTC datetime.datetime)

• partition_ids (list[str])

async get_eventhub_properties() -> Dict[str, Any]

Retours

Dictionnaire contenant des informations sur le hub d’événements.

Type de retour

Exceptions

Obtenez les ID de partition de l’Event Hub.

async get_partition_ids() -> List[str]

Retours

Liste des ID de partition.

Type de retour

Exceptions

Obtient les propriétés de la partition spécifiée.

Les clés du dictionnaire de propriétés sont les suivantes :

• eventhub_name (str)

• id (str)

• beginning_sequence_number (int)

• last_enqueued_sequence_number (int)

• last_enqueued_offset (str)

• last_enqueued_time_utc (UTC datetime.datetime)

• is_empty (bool)

async get_partition_properties(partition_id: str) -> Dict[str, Any]

Paramètres

Retours

dicté des propriétés de partition.

Type de retour

Exceptions

Envoie un lot de données d’événement. Par défaut, la méthode est bloquée jusqu’à ce que l’accusé de réception soit reçu ou que l’opération expire. Si EventHubProducerClient est configuré pour s’exécuter en mode mis en mémoire tampon, la méthode met en file d’attente les événements dans la mémoire tampon locale et retourne. Le producteur effectue l’envoi automatique en arrière-plan.

Si buffered_mode a la valeur False, on_error rappel est facultatif et les erreurs sont gérées comme suit :

• Si un rappel on_error est passé pendant l’instanciation du client producteur,

  ensuite, les informations d’erreur sont transmises au rappel on_error , qui sera ensuite appelé.

• Si un rappel on_error n’est pas passé pendant l’instanciation du client,

  l’erreur est alors déclenchée par défaut.

Si buffered_mode a la valeur True, on_error rappel est requis et les erreurs sont gérées comme suit :

• Si les événements ne parviennent pas à mettre en file d’attente dans le délai d’attente donné, une erreur est directement générée.

• Si les événements ne parviennent pas à être envoyés après la mise en file d’attente, le rappel on_error est appelé.

En mode mis en mémoire tampon, l’envoi d’un lot reste intact et envoyé en tant qu’unité unique. Le lot ne sera pas réorganisé. Cela peut entraîner l’inefficacité de l’envoi d’événements.

Si vous envoyez une liste finie d’EventData ou d’AmqpAnnotatedMessage et que vous savez qu’elle se trouve dans la limite de taille d’image du hub d’événements, vous pouvez l’envoyer avec un appel send_batch . Sinon, utilisez create_batch pour créer EventDataBatch et ajouter EventData ou AmqpAnnotatedMessage dans le lot un par un jusqu’à la limite de taille, puis appelez cette méthode pour envoyer le lot.

async send_batch(event_data_batch: EventDataBatch | List[EventData | AmqpAnnotatedMessage], **kwargs: Any) -> None

Paramètres

Type de retour

Exceptions

Si la valeur spécifiée par le paramètre de délai d’expiration s’écoule avant que l’événement puisse être envoyé en mode non mis en mémoire tampon ou que les événements peuvent être mis en file d’attente dans la mise en mémoire tampon en mode mis en mémoire tampon.

Exemples

Envoie de manière asynchrone des données d’événement

       async with producer:
           event_data_batch = await producer.create_batch()
           while True:
               try:
                   event_data_batch.add(EventData('Message inside EventBatchData'))
               except ValueError:
                   # The EventDataBatch object reaches its max_size.
                   # You can send the full EventDataBatch object and create a new one here.
                   break
           await producer.send_batch(event_data_batch)

Envoie des données d’événement. Par défaut, la méthode est bloquée jusqu’à ce que l’accusé de réception soit reçu ou que l’opération expire. Si EventHubProducerClient est configuré pour s’exécuter en mode mis en mémoire tampon, la méthode met l’événement en file d’attente dans la mémoire tampon locale et retourne. Le producteur effectue automatiquement le traitement par lots et l’envoi en arrière-plan.

Si buffered_mode a la valeur False, on_error rappel est facultatif et les erreurs sont gérées comme suit : * Si un rappel on_error est passé pendant l’instanciation du client producteur,

       then error information will be passed to the *on_error* callback, which will then be called.

  * If an *on_error* callback is not passed in during client instantiation,

       then the error will be raised by default.

Si buffered_mode a la valeur True, on_error rappel est requis et les erreurs sont gérées comme suit : * Si les événements ne parviennent pas à se mettre en file d’attente dans le délai d’attente donné, une erreur est directement générée.

  * If events fail to send after enqueuing successfully, the *on_error* callback will be called.

async send_event(event_data: EventData | AmqpAnnotatedMessage, **kwargs: Any) -> None

Paramètres

Type de retour

Exceptions

Si la valeur spécifiée par le paramètre de délai d’expiration s’écoule avant que l’événement ne puisse être envoyé en mode non mis en mémoire tampon ou que les événements ne peuvent pas être mis en file d’attente dans la mémoire tampon en mode mis en mémoire tampon.

Nombre total d’événements actuellement mis en mémoire tampon et en attente d’être publiés, sur toutes les partitions. Retourne Aucun en mode non mis en mémoire tampon. REMARQUE : la mémoire tampon d’événements est traitée dans une coroutine en arrière-plan. Par conséquent, le nombre d’événements dans la mémoire tampon signalé par cette API doit être considéré comme une approximation et est recommandé uniquement pour le débogage.

Type de retour