From 7a51f04d8009b22863dd1167a1314114a637c34d Mon Sep 17 00:00:00 2001 From: Tianzi Cai Date: Thu, 25 Jul 2019 16:01:35 -0700 Subject: [PATCH 1/2] document client_options --- pubsub/google/cloud/pubsub_v1/publisher/client.py | 2 ++ pubsub/google/cloud/pubsub_v1/subscriber/client.py | 2 ++ 2 files changed, 4 insertions(+) diff --git a/pubsub/google/cloud/pubsub_v1/publisher/client.py b/pubsub/google/cloud/pubsub_v1/publisher/client.py index b837de24c6f0..27ccb4faab9b 100644 --- a/pubsub/google/cloud/pubsub_v1/publisher/client.py +++ b/pubsub/google/cloud/pubsub_v1/publisher/client.py @@ -58,6 +58,8 @@ class Client(object): Before being passed along to the GAPIC constructor, a channel may be added if ``credentials`` are passed explicitly or if the Pub / Sub emulator is detected as running. + Regional endpoints can be set via `client_options` that takes a + single key-value pair of name `api_endpoint`. """ _batch_class = thread.Batch diff --git a/pubsub/google/cloud/pubsub_v1/subscriber/client.py b/pubsub/google/cloud/pubsub_v1/subscriber/client.py index f2e8faa4fcf5..71daaec3f79b 100644 --- a/pubsub/google/cloud/pubsub_v1/subscriber/client.py +++ b/pubsub/google/cloud/pubsub_v1/subscriber/client.py @@ -53,6 +53,8 @@ class Client(object): :class:`~.gapic.pubsub.v1.subscriber_client.SubscriberClient`. Generally, you should not need to set additional keyword arguments. + Regional endpoints can be set via `client_options` that takes a + single key-value pair of name `api_endpoint`. """ def __init__(self, **kwargs): From bdef4624b7a75e56513d817592e385938d74dc92 Mon Sep 17 00:00:00 2001 From: Tianzi Cai Date: Fri, 26 Jul 2019 10:01:42 -0700 Subject: [PATCH 2/2] show an example that sets client_options --- pubsub/google/cloud/pubsub_v1/publisher/client.py | 3 ++- pubsub/google/cloud/pubsub_v1/subscriber/client.py | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/pubsub/google/cloud/pubsub_v1/publisher/client.py b/pubsub/google/cloud/pubsub_v1/publisher/client.py index 27ccb4faab9b..006bf509d24b 100644 --- a/pubsub/google/cloud/pubsub_v1/publisher/client.py +++ b/pubsub/google/cloud/pubsub_v1/publisher/client.py @@ -59,7 +59,8 @@ class Client(object): be added if ``credentials`` are passed explicitly or if the Pub / Sub emulator is detected as running. Regional endpoints can be set via `client_options` that takes a - single key-value pair of name `api_endpoint`. + single key-value pair that defines the endpoint, i.e. + `client_options={"api_endpoint": REGIONAL_ENDPOINT}` """ _batch_class = thread.Batch diff --git a/pubsub/google/cloud/pubsub_v1/subscriber/client.py b/pubsub/google/cloud/pubsub_v1/subscriber/client.py index 71daaec3f79b..7dbb425caf66 100644 --- a/pubsub/google/cloud/pubsub_v1/subscriber/client.py +++ b/pubsub/google/cloud/pubsub_v1/subscriber/client.py @@ -54,7 +54,8 @@ class Client(object): Generally, you should not need to set additional keyword arguments. Regional endpoints can be set via `client_options` that takes a - single key-value pair of name `api_endpoint`. + single key-value pair that defines the endpoint, i.e. + `client_options={"api_endpoint": REGIONAL_ENDPOINT}`. """ def __init__(self, **kwargs):