EventHubProducerClient Classe

Feche as ligações e a ligação amQP subjacentes ao cliente produtor.

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

Parâmetros

Tipo de retorno

Exceções

Se ocorreu um erro ao remover a memória intermédia se a descarga estiver definida como Verdadeiro ou fechar as ligações AMQP subjacentes no modo de memória intermédia.

Exemplos

Feche o processador.

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

Crie um objeto EventDataBatch com o tamanho máximo de todo o conteúdo a ser restringido por max_size_in_bytes.

O max_size_in_bytes não deve ser maior do que o tamanho máximo de mensagens permitido definido pelo serviço.

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

Tipo de retorno

Exceções

Se ocorreu um erro ao remover a memória intermédia se a descarga estiver definida como Verdadeiro ou fechar as ligações AMQP subjacentes no modo de memória intermédia.

Exemplos

Criar objeto EventDataBatch com um tamanho limitado

       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

Apenas modo em memória intermédia. Remova os eventos na memória intermédia para serem enviados imediatamente se o cliente estiver a trabalhar no modo de memória intermédia.

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

Parâmetros

Tipo de retorno

Exceções

Se o produtor não conseguir remover a memória intermédia dentro do tempo limite especificado no modo de memória intermédia.

Crie um EventHubProducerClient a partir de um cadeia de ligação.

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

Parâmetros

Tipo de retorno

Exceções

Se ocorreu um erro ao remover a memória intermédia se a descarga estiver definida como Verdadeiro ou fechar as ligações AMQP subjacentes no modo de memória intermédia.

Exemplos

Crie uma nova instância do EventHubProducerClient a partir de cadeia de ligação.

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

O número de eventos que estão em memória intermédia e à espera de serem publicados para uma determinada partição. Devolve Nenhum no modo não colocado na memória intermédia. NOTA: a memória intermédia de eventos é processada num corouteno em segundo plano, pelo que o número de eventos na memória intermédia comunicados por esta API deve ser considerado apenas uma aproximação e só é recomendado para utilização na depuração. Para um ID de partição que não tenha eventos em memória intermédia, 0 será devolvido independentemente de esse ID de partição existir realmente no Hub de Eventos.

get_buffered_event_count(partition_id: str) -> int | None

Parâmetros

Tipo de retorno

Exceções

Se ocorreu um erro ao remover a memória intermédia se a descarga estiver definida como Verdadeiro ou fechar as ligações AMQP subjacentes no modo de memória intermédia.

Obtenha as propriedades do Hub de Eventos.

As chaves no dicionário devolvido incluem:

• eventhub_name (str)

• created_at (UTC datetime.datetime)

• partition_ids (list[str])

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

Devoluções

Um dicionário que contém informações sobre o Hub de Eventos.

Tipo de retorno

Exceções

Obter IDs de partição do Hub de Eventos.

async get_partition_ids() -> List[str]

Devoluções

Uma lista de IDs de partição.

Tipo de retorno

Exceções

Obtenha as propriedades da partição especificada.

As chaves no dicionário de propriedades incluem:

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

Parâmetros

Devoluções

Um ditado das propriedades da partição.

Tipo de retorno

Exceções

Envia um lote de dados de eventos. Por predefinição, o método bloqueará até a confirmação ser recebida ou a operação exceder o limite de tempo. Se o EventHubProducerClient estiver configurado para ser executado no modo de memória intermédia, o método irá colocar os eventos na memória intermédia local e regressar. O produtor fará o envio automático em segundo plano.

Se buffered_mode for Falso, on_error chamada de retorno é opcional e os erros serão processados da seguinte forma:

• Se for transmitida uma chamada de retorno on_error durante a instanciação do cliente do produtor,

  em seguida, as informações de erro serão transmitidas à chamada de retorno on_error , que será chamada.

• Se uma chamada de retorno de on_error não for transmitida durante a instanciação do cliente,

  em seguida, o erro será gerado por predefinição.

Se buffered_mode for Verdadeiro, on_error chamada de retorno é necessária e os erros serão processados da seguinte forma:

• Se os eventos não conseguirem colocar a fila dentro do tempo limite especificado, será gerado um erro diretamente.

• Se os eventos não conseguirem enviar após a colocação em fila com êxito, a chamada de retorno on_error será chamada.

No modo de memória intermédia, o envio de um lote permanecerá intacto e será enviado como uma única unidade. O lote não será reorganizado. Isto pode resultar em ineficiência no envio de eventos.

Se estiver a enviar uma lista finita de EventData ou AmqpAnnotatedMessage e souber que está dentro do limite de tamanho da moldura do hub de eventos, pode enviá-los com uma chamada send_batch . Caso contrário, utilize create_batch para criar EventDataBatch e adicionar EventData ou AmqpAnnotatedMessage no lote um a um até ao limite de tamanho e, em seguida, chame este método para enviar o lote.

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

Parâmetros

Tipo de retorno

Exceções

Se o valor especificado pelo parâmetro de tempo limite decorrido antes de o evento poder ser enviado em modo não intermédia ou os eventos puderem ser colocados em fila de colocação na memória intermédia no modo de memória intermédia.

Exemplos

Assíncrono envia dados de eventos de forma assíncrona

       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)

Envia dados de eventos. Por predefinição, o método bloqueará até a confirmação ser recebida ou a operação exceder o limite de tempo. Se o EventHubProducerClient estiver configurado para ser executado no modo de memória intermédia, o método colocará o evento na memória intermédia local e regressará. O produtor fará o batching automático e o envio em segundo plano.

Se buffered_mode for Falso, on_error chamada de retorno é opcional e os erros serão processados da seguinte forma: * Se for transmitida uma chamada de retorno de on_error durante a instanciação do cliente de produtor,

       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.

Se buffered_mode for Verdadeiro, on_error chamada de retorno é necessária e os erros serão processados da seguinte forma: * Se os eventos não conseguirem colocar em fila dentro do tempo limite especificado, será gerado um erro diretamente.

  * 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

Parâmetros

Tipo de retorno

Exceções

Se o valor especificado pelo parâmetro de tempo limite decorrido antes de o evento poder ser enviado no modo não intermédia ou os eventos não puderem ser colocados em fila intermédia no modo de memória intermédia.

O número total de eventos que estão atualmente em memória intermédia e à espera de serem publicados, em todas as partições. Devolve Nenhum no modo não intermédia. NOTA: a memória intermédia de eventos é processada num corouteno em segundo plano, pelo que o número de eventos na memória intermédia comunicados por esta API deve ser considerado apenas uma aproximação e só é recomendado para utilização na depuração.

Tipo de retorno