From 574914b8a82a14adf9556b43d36437e1d265c29d Mon Sep 17 00:00:00 2001 From: Kashif Khan Date: Mon, 25 Mar 2024 09:04:14 -0500 Subject: [PATCH] update docs on buffered producer timeout --- sdk/eventhub/azure-eventhub/azure/eventhub/_producer_client.py | 3 ++- .../azure/eventhub/aio/_producer_client_async.py | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/sdk/eventhub/azure-eventhub/azure/eventhub/_producer_client.py b/sdk/eventhub/azure-eventhub/azure/eventhub/_producer_client.py index 68e97eb949e4..b7d91a7f2b9f 100644 --- a/sdk/eventhub/azure-eventhub/azure/eventhub/_producer_client.py +++ b/sdk/eventhub/azure-eventhub/azure/eventhub/_producer_client.py @@ -576,7 +576,8 @@ def send_event( :keyword float timeout: The maximum wait time to send the event data in non-buffered mode or the maximum wait time to enqueue the event data into the buffer in buffered mode. In non-buffered mode, the default wait time specified when the producer - was created will be used. In buffered mode, the default wait time is None. + was created will be used. In buffered mode, the default wait time is None indicating that the event will be + scheduled to send immediately. :keyword str partition_id: The specific partition ID to send to. Default is None, in which case the service will assign to all partitions using round-robin. A `TypeError` will be raised if partition_id is specified and event_data_batch is an `EventDataBatch` because diff --git a/sdk/eventhub/azure-eventhub/azure/eventhub/aio/_producer_client_async.py b/sdk/eventhub/azure-eventhub/azure/eventhub/aio/_producer_client_async.py index 606035b91020..76ddc1737371 100644 --- a/sdk/eventhub/azure-eventhub/azure/eventhub/aio/_producer_client_async.py +++ b/sdk/eventhub/azure-eventhub/azure/eventhub/aio/_producer_client_async.py @@ -557,7 +557,8 @@ async def send_event( :keyword float timeout: The maximum wait time to send the event data in non-buffered mode or the maximum wait time to enqueue the event data into the buffer in buffered mode. In non-buffered mode, the default wait time specified when the producer - was created will be used. In buffered mode, the default wait time is None. + was created will be used. In buffered mode, the default wait time is None indicating that the event will be + scheduled to send immediately. :keyword str partition_id: The specific partition ID to send to. Default is None, in which case the service will assign to all partitions using round-robin. A `TypeError` will be raised if partition_id is specified and event_data_batch is an `EventDataBatch` because