EventHubProducerClient Třída

Zavřete základní připojení a propojení AMQP klienta producenta.

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

Parametry

Návratový typ

Výjimky

Pokud došlo k chybě při vyprázdnění vyrovnávací paměti, pokud je vyprázdnění nastaveno na Hodnotu True nebo zavření podkladových připojení AMQP v režimu vyrovnávací paměti.

Příklady

Zavřete klienta.

   import os
   from azure.eventhub import EventHubProducerClient, 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 = producer.create_batch()

       while True:
           try:
               event_data_batch.add(EventData('Message inside EventBatchData'))
           except ValueError:
               # EventDataBatch object reaches max_size.
               # New EventDataBatch object can be created here to send more data
               break

       producer.send_batch(event_data_batch)
   finally:
       # Close down the producer handler.
       producer.close()

Vytvořte objekt EventDataBatch s maximální velikostí veškerého obsahu, který je omezen max_size_in_bytes.

Max_size_in_bytes nesmí být větší než maximální povolená velikost zpráv definovaná službou.

create_batch(**kwargs: Any) -> EventDataBatch

Návratový typ

Výjimky

Pokud došlo k chybě při vyprázdnění vyrovnávací paměti, pokud je vyprázdnění nastaveno na Hodnotu True nebo zavření podkladových připojení AMQP v režimu vyrovnávací paměti.

Příklady

Vytvoření objektu EventDataBatch v omezené velikosti

       event_data_batch = 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

Pouze režim vyrovnávací paměti. Vyprázdnění událostí ve vyrovnávací paměti, které se mají okamžitě odeslat, pokud klient pracuje v režimu vyrovnávací paměti.

flush(**kwargs: Any) -> None

Parametry

Návratový typ

Výjimky

Pokud se producentovi nepodaří vyprázdnit vyrovnávací paměť v daném časovém limitu v režimu vyrovnávací paměti.

Vytvořte EventHubProducerClient ze připojovací řetězec.

from_connection_string(conn_str: str, *, eventhub_name: str | None = None, buffered_mode: Literal[False] = False, **kwargs: Any) -> EventHubProducerClient

Parametry

Návratový typ

Výjimky

Pokud došlo k chybě při vyprázdnění vyrovnávací paměti, pokud je vyprázdnění nastaveno na Hodnotu True nebo zavření podkladových připojení AMQP v režimu vyrovnávací paměti.

Příklady

Vytvořte novou instanci EventHubProducerClient z připojovací řetězec.

   import os
   from azure.eventhub 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.
   )

Počet událostí, které se ukládají do vyrovnávací paměti a čekají na publikování pro daný oddíl. Vrátí hodnotu None v režimu bez vyrovnávací paměti. POZNÁMKA: Vyrovnávací paměť událostí se zpracovává ve vlákně na pozadí, proto počet událostí ve vyrovnávací paměti hlášené tímto rozhraním API by měl být považován pouze za aproximaci a doporučuje se pouze pro použití při ladění. V případě ID oddílu, který nemá žádné události ve vyrovnávací paměti, se vrátí hodnota 0 bez ohledu na to, jestli id oddílu ve skutečnosti v centru událostí existuje.

get_buffered_event_count(partition_id: str) -> int | None

Parametry

Návratový typ

Výjimky

Pokud došlo k chybě při vyprázdnění vyrovnávací paměti, pokud je vyprázdnění nastaveno na Hodnotu True nebo zavření podkladových připojení AMQP v režimu vyrovnávací paměti.

Získejte vlastnosti centra událostí.

Mezi klíče ve vráceném slovníku patří:

• eventhub_name (str)

• created_at (UTC datetime.datetime)

• partition_ids (list[str])

get_eventhub_properties() -> Dict[str, Any]

Návraty

Slovník obsahující vlastnosti eventhubu.

Návratový typ

Výjimky

Získejte ID oddílů centra událostí.

get_partition_ids() -> List[str]

Návraty

Seznam ID oddílů.

Návratový typ

Výjimky

Získejte vlastnosti zadaného oddílu.

Mezi klíče ve slovníku vlastností patří:

• 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)

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

Parametry

Návraty

Slovník vlastností oddílu.

Návratový typ

Výjimky

Odešle dávku dat událostí. Ve výchozím nastavení bude metoda blokovat, dokud nedojde k potvrzení nebo dokud nevypadne časový limit operace. Pokud je EventHubProducerClient nakonfigurovaný tak, aby běžel v režimu vyrovnávací paměti, metoda se pokusí zařadí události do vyrovnávací paměti v daném čase, pokud je zadaný a vrátí se. Producent provede automatické odesílání na pozadí v režimu vyrovnávací paměti.

Pokud je buffered_mode False, on_error zpětné volání je volitelné a chyby se budou zpracovávat následujícím způsobem:

• Pokud se během vytváření instancí klienta producenta předá zpětné volání on_error ,

  pak se informace o chybě předají zpětnému volání on_error , které se pak zavolá.

• Pokud se během vytváření instancí klienta nepředá zpětné volání on_error,

  pak bude ve výchozím nastavení vyvolána chyba.

Pokud má buffered_mode hodnotu True, vyžaduje se on_error zpětné volání a chyby se budou zpracovávat následujícím způsobem:

• Pokud se událostem nepodaří vytvořit frontu v daném časovém limitu, bude přímo vyvolána chyba.

• Pokud se události po úspěšném zařazení do fronty nepodaří odeslat, bude volána zpětná volání on_error .

V režimu vyrovnávací paměti zůstane odeslání dávky nedotčené a odesláno jako jedna jednotka. Uspořádání dávky nebude přeuspořádané. To může vést k neefektivitě odesílání událostí.

Pokud odesíláte konečný seznam EventData nebo AmqpAnnotatedMessage a víte, že je v limitu velikosti rámce centra událostí, můžete je poslat s send_batch voláním. V opačném případě použijte create_batch k vytvoření EventDataBatch a přidejte buď EventData nebo AmqpAnnotatedMessage do dávky jeden po druhém až do limitu velikosti, a pak voláním této metody odešlete dávku.

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

Parametry

Návratový typ

Výjimky

Pokud hodnota určená parametrem časového limitu uplynou před odesláním události v režimu bez vyrovnávací paměti nebo události nelze zařadit do vyrovnávací paměti v režimu vyrovnávací paměti.

Příklady

Odesílá data událostí.

       with producer:
           event_data_batch = producer.create_batch()

           while True:
               try:
                   event_data_batch.add(EventData('Message inside EventBatchData'))
               except ValueError:
                   # EventDataBatch object reaches max_size.
                   # New EventDataBatch object can be created here to send more data
                   break

           producer.send_batch(event_data_batch)

Odešle data události. Ve výchozím nastavení bude metoda blokovat, dokud nedojde k potvrzení nebo dokud nevypadne časový limit operace. Pokud je EventHubProducerClient nakonfigurovaný tak, aby běžel v režimu vyrovnávací paměti, metoda se pokusí zařadí události do vyrovnávací paměti v daném čase, pokud je zadaný a vrátí se. Producent provede automatické odesílání na pozadí v režimu vyrovnávací paměti.

Pokud je buffered_mode false, on_error zpětné volání je volitelné a chyby se budou zpracovávat takto: * Pokud se během vytváření instance klienta producenta předá zpětné volání on_error ,

       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.

Pokud má buffered_mode hodnotu True, vyžaduje se on_error zpětné volání a chyby se budou zpracovávat následujícím způsobem: * Pokud se událostem nepodaří vytvořit frontu v daném časovém limitu, bude přímo vyvolána chyba.

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

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

Parametry

Návratový typ

Výjimky

Pokud hodnota určená parametrem časového limitu uplynou před odesláním události v režimu bez vyrovnávací paměti nebo události mohou být zapsány do vyrovnávací paměti v režimu vyrovnávací paměti.

Celkový počet událostí, které jsou aktuálně ve vyrovnávací paměti a čekají na publikování, napříč všemi oddíly. Vrátí hodnotu None v režimu bez vyrovnávací paměti. POZNÁMKA: Vyrovnávací paměť událostí se zpracovává ve vlákně na pozadí, proto počet událostí ve vyrovnávací paměti hlášené tímto rozhraním API by měl být považován pouze za aproximaci a doporučuje se pouze pro použití při ladění.

Návratový typ