From a1b54767345dd0121312f8c1cb2b05ed15c5be33 Mon Sep 17 00:00:00 2001 From: Yijun Xie <48257664+YijunXieMS@users.noreply.github.com> Date: Mon, 6 Jul 2020 11:49:46 -0700 Subject: [PATCH] [Event Hubs] Update Development Status (#12378) * Update Development Status to "4 - Beta" * Fix keyword type display in sphinx-generated doc --- .../azure-eventhub/azure/eventhub/_consumer_client.py | 6 ++++-- .../azure/eventhub/aio/_consumer_client_async.py | 6 ++++-- sdk/eventhub/azure-eventhub/setup.py | 2 +- 3 files changed, 9 insertions(+), 5 deletions(-) diff --git a/sdk/eventhub/azure-eventhub/azure/eventhub/_consumer_client.py b/sdk/eventhub/azure-eventhub/azure/eventhub/_consumer_client.py index ad7e09976fc..1df04c72ff9 100644 --- a/sdk/eventhub/azure-eventhub/azure/eventhub/_consumer_client.py +++ b/sdk/eventhub/azure-eventhub/azure/eventhub/_consumer_client.py @@ -91,7 +91,7 @@ class EventHubConsumerClient(ClientBase): of seconds. Every load-balancing evaluation will automatically extend the ownership expiration time. Default is 6 * load_balancing_interval, i.e. 60 seconds when using the default load_balancing_interval of 10 seconds. - :keyword str or ~azure.eventhub.LoadBalancingStrategy load_balancing_strategy: When load-balancing kicks in, + :keyword load_balancing_strategy: When load-balancing kicks in, it will use this strategy to claim and balance the partition ownership. Use "greedy" or `LoadBalancingStrategy.GREEDY` for the greedy strategy, which, for every load-balancing evaluation, will grab as many unclaimed partitions required to balance the load. @@ -101,6 +101,7 @@ class EventHubConsumerClient(ClientBase): too few partitions, this client will steal one partition from other clients for every load-balancing evaluation regardless of the load balancing strategy. Greedy strategy is used by default. + :paramtype load_balancing_strategy: str or ~azure.eventhub.LoadBalancingStrategy .. admonition:: Example: @@ -225,7 +226,7 @@ def from_connection_string(cls, conn_str, consumer_group, **kwargs): of seconds. Every load-balancing evaluation will automatically extend the ownership expiration time. Default is 6 * load_balancing_interval, i.e. 60 seconds when using the default load_balancing_interval of 10 seconds. - :keyword str or ~azure.eventhub.LoadBalancingStrategy load_balancing_strategy: When load-balancing kicks in, + :keyword load_balancing_strategy: When load-balancing kicks in, it will use this strategy to claim and balance the partition ownership. Use "greedy" or `LoadBalancingStrategy.GREEDY` for the greedy strategy, which, for every load-balancing evaluation, will grab as many unclaimed partitions required to balance the load. @@ -235,6 +236,7 @@ def from_connection_string(cls, conn_str, consumer_group, **kwargs): too few partitions, this client will steal one partition from other clients for every load-balancing evaluation regardless of the load balancing strategy. Greedy strategy is used by default. + :paramtype load_balancing_strategy: str or ~azure.eventhub.LoadBalancingStrategy :rtype: ~azure.eventhub.EventHubConsumerClient diff --git a/sdk/eventhub/azure-eventhub/azure/eventhub/aio/_consumer_client_async.py b/sdk/eventhub/azure-eventhub/azure/eventhub/aio/_consumer_client_async.py index d40e37bd590..b93d0c67128 100644 --- a/sdk/eventhub/azure-eventhub/azure/eventhub/aio/_consumer_client_async.py +++ b/sdk/eventhub/azure-eventhub/azure/eventhub/aio/_consumer_client_async.py @@ -96,7 +96,7 @@ class EventHubConsumerClient(ClientBaseAsync): of seconds. Every load-balancing evaluation will automatically extend the ownership expiration time. Default is 6 * load_balancing_interval, i.e. 60 seconds when using the default load_balancing_interval of 10 seconds. - :keyword str or ~azure.eventhub.LoadBalancingStrategy load_balancing_strategy: When load-balancing kicks in, + :keyword load_balancing_strategy: When load-balancing kicks in, it will use this strategy to claim and balance the partition ownership. Use "greedy" or `LoadBalancingStrategy.GREEDY` for the greedy strategy, which, for every load-balancing evaluation, will grab as many unclaimed partitions required to balance the load. @@ -106,6 +106,7 @@ class EventHubConsumerClient(ClientBaseAsync): too few partitions, this client will steal one partition from other clients for every load-balancing evaluation regardless of the load balancing strategy. Greedy strategy is used by default. + :paramtype load_balancing_strategy: str or ~azure.eventhub.LoadBalancingStrategy .. admonition:: Example: @@ -242,7 +243,7 @@ def from_connection_string( of seconds. Every load-balancing evaluation will automatically extend the ownership expiration time. Default is 6 * load_balancing_interval, i.e. 60 seconds when using the default load_balancing_interval of 10 seconds. - :keyword str or ~azure.eventhub.LoadBalancingStrategy load_balancing_strategy: When load-balancing kicks in, + :keyword load_balancing_strategy: When load-balancing kicks in, it will use this strategy to claim and balance the partition ownership. Use "greedy" or `LoadBalancingStrategy.GREEDY` for the greedy strategy, which, for every load-balancing evaluation, will grab as many unclaimed partitions required to balance the load. @@ -252,6 +253,7 @@ def from_connection_string( too few partitions, this client will steal one partition from other clients for every load-balancing evaluation regardless of the load balancing strategy. Greedy strategy is used by default. + :paramtype load_balancing_strategy: str or ~azure.eventhub.LoadBalancingStrategy :rtype: ~azure.eventhub.aio.EventHubConsumerClient .. admonition:: Example: diff --git a/sdk/eventhub/azure-eventhub/setup.py b/sdk/eventhub/azure-eventhub/setup.py index 0db0549b9ee..2590ef1de62 100644 --- a/sdk/eventhub/azure-eventhub/setup.py +++ b/sdk/eventhub/azure-eventhub/setup.py @@ -54,7 +54,7 @@ author_email='azpysdkhelp@microsoft.com', url='https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/eventhub/azure-eventhub', classifiers=[ - "Development Status :: 5 - Production/Stable", + "Development Status :: 4 - Beta", 'Programming Language :: Python', 'Programming Language :: Python :: 2', 'Programming Language :: Python :: 2.7',