EventHubProducerClient Sınıf

Temel alınan AMQP bağlantısı ve bağlantılarını üretici istemcisini kapatın.

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

Parametreler

Dönüş türü

Özel durumlar

Arabellek boşaltılırken hata oluştuysa, boşaltma Doğru olarak ayarlandıysa veya arabelleğe alınan modda temel alınan AMQP bağlantılarını kapatın.

Örnekler

İstemciyi kapatın.

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

max_size_in_bytes tarafından kısıtlanan tüm içeriğin en büyük boyutuna sahip bir EventDataBatch nesnesi oluşturun.

max_size_in_bytes, hizmet tarafından tanımlanan izin verilen maksimum ileti boyutundan büyük olmamalıdır.

create_batch(**kwargs: Any) -> EventDataBatch

Dönüş türü

Özel durumlar

Arabellek boşaltılırken hata oluştuysa, boşaltma Doğru olarak ayarlandıysa veya arabelleğe alınan modda temel alınan AMQP bağlantılarını kapatın.

Örnekler

Sınırlı boyutta EventDataBatch nesnesi oluşturma

       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

Yalnızca arabelleğe alınan mod. İstemci arabelleğe alınan modda çalışıyorsa hemen gönderilecek arabellekteki olayları boşaltın.

flush(**kwargs: Any) -> None

Parametreler

Dönüş türü

Özel durumlar

Üretici arabelleğe alınan modda verilen zaman aşımı içinde arabelleği temizleyemezse.

bir bağlantı dizesi EventHubProducerClient oluşturun.

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

Parametreler

Dönüş türü

Özel durumlar

Arabellek boşaltılırken hata oluştuysa, boşaltma Doğru olarak ayarlandıysa veya arabelleğe alınan modda temel alınan AMQP bağlantılarını kapatın.

Örnekler

bağlantı dizesi'dan EventHubProducerClient'ın yeni bir örneğini oluşturun.

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

Arabelleğe alınan ve belirli bir bölüm için yayımlanmayı bekleyen olayların sayısı. Arabelleğe alınamayan modda Hiçbiri döndürür. NOT: Olay arabelleği bir arka plan iş parçacığında işlenir, bu nedenle bu API tarafından bildirilen arabellekteki olayların sayısı yalnızca yaklaşık olarak kabul edilmelidir ve yalnızca hata ayıklamada kullanılması önerilir. Arabelleğe alınmamış olay içermeyen bir bölüm kimliği için, bölüm kimliğinin Olay Hub'ının içinde olup olmadığına bakılmaksızın 0 döndürülür.

get_buffered_event_count(partition_id: str) -> int | None

Parametreler

Dönüş türü

Özel durumlar

Arabellek boşaltılırken hata oluştuysa, boşaltma Doğru olarak ayarlandıysa veya arabelleğe alınan modda temel alınan AMQP bağlantılarını kapatın.

Olay Hub'ının özelliklerini alma.

Döndürülen sözlükteki anahtarlar şunlardır:

• eventhub_name (str)

• created_at (UTC datetime.datetime)

• partition_ids (list[str])

get_eventhub_properties() -> Dict[str, Any]

Döndürülenler

eventhub özelliklerini içeren bir sözlük.

Dönüş türü

Özel durumlar

Olay Hub'ının bölüm kimliklerini alın.

get_partition_ids() -> List[str]

Döndürülenler

Bölüm kimliklerinin listesi.

Dönüş türü

Özel durumlar

Belirtilen bölümün özelliklerini alın.

Özellikler sözlüğündeki anahtarlar şunlardır:

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

Parametreler

Döndürülenler

Bölüm özellikleri sözlüğü.

Dönüş türü

Özel durumlar

Bir grup olay verisi gönderir. Varsayılan olarak, onay alınana veya işlem zaman aşımına ulaşana kadar yöntemi engeller. EventHubProducerClient arabelleğe alınmış modda çalışacak şekilde yapılandırıldıysa, yöntemi belirtilen süre içinde olayları arabellekte sıralamayı dener ve döndürür. Üretici arka planda arabelleğe alınan modda otomatik gönderme yapar.

buffered_mode False ise, on_error geri çağırma isteğe bağlıdır ve hatalar aşağıdaki gibi işlenir:

• Üretici istemci örneği oluşturma sırasında bir on_error geri çağırma geçirilirse,

  ardından hata bilgileri on_error geri çağırmaya geçirilir ve bu da çağrılır.

• İstemci örneği oluşturma sırasında bir on_error geri çağırma geçirilmediyse,

  ardından hata varsayılan olarak oluşturulur.

buffered_mode True ise, on_error geri çağırma gerekir ve hatalar şu şekilde işlenir:

• Olaylar verilen zaman aşımı içinde sıraya alınamazsa, doğrudan bir hata oluşur.

• Olaylar başarıyla sıraya alındıktan sonra gönderilemiyorsa , on_error geri çağırma çağrılır.

Arabelleğe alınan modda, toplu iş gönderme işlemi değişmeden kalır ve tek bir birim olarak gönderilir. Toplu iş yeniden düzenlenmeyecek. Bu, olay göndermede yetersizliğe neden olabilir.

EventData veya AmqpAnnotatedMessage'ın sınırlı bir listesini gönderiyorsanız ve bunun olay hub'ı çerçeve boyutu sınırı içinde olduğunu biliyorsanız, bunları bir send_batch çağrısıyla gönderebilirsiniz. Aksi takdirde, EventDataBatch oluşturmak ve boyut sınırına kadar toplu işleme EventData veya AmqpAnnotatedMessage eklemek için kullanın create_batch ve ardından toplu işlemi göndermek için bu yöntemi çağırın.

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

Parametreler

Dönüş türü

Özel durumlar

Zaman aşımı parametresi tarafından belirtilen değer, olayın arabelleğe alınmamış modda gönderilebilmesinden önce geçerse veya olaylar arabelleğe alınan modda arabelleğe alınan moda sıraya alınamıyorsa.

Örnekler

Olay verilerini gönderir

       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)

Olay verileri gönderir. Varsayılan olarak, onay alınana veya işlem zaman aşımına ulaşana kadar yöntemi engeller. EventHubProducerClient arabelleğe alınmış modda çalışacak şekilde yapılandırıldıysa, yöntemi belirtilen süre içinde olayları arabellekte sıralamayı dener ve döndürür. Üretici arka planda arabelleğe alınan modda otomatik gönderme yapar.

buffered_mode False ise, on_error geri çağırma isteğe bağlıdır ve hatalar şu şekilde işlenir: * Üretici istemci örneği oluşturma sırasında bir on_error geri çağırma geçirilirse,

       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.

buffered_mode True ise, on_error geri çağırma gerekir ve hatalar şu şekilde işlenir: * Olaylar belirtilen zaman aşımı içinde sıraya alınamazsa, doğrudan bir hata oluşur.

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

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

Parametreler

Dönüş türü

Özel durumlar

Zaman aşımı parametresi tarafından belirtilen değer, olay arabelleğe alınamayan modda gönderilmeden önce geçerse veya olaylar arabelleğe alınan modda arabelleğe alınan moda sıralanabilir.

Tüm bölümlerde arabelleğe alınmış ve yayımlanmayı bekleyen olayların toplam sayısı. Arabelleğe alınamayan modda Hiçbiri döndürür. NOT: Olay arabelleği bir arka plan iş parçacığında işlenir, bu nedenle bu API tarafından bildirilen arabellekteki olay sayısı yalnızca bir yaklaşık değer olarak kabul edilmelidir ve yalnızca hata ayıklamada kullanılması önerilir.

Dönüş türü