API Core: Add client_options documentation. (#8834)

busunkim96 · web-flow · commit 5916b6b46a73 · 2019-07-30T13:36:42.000-07:00
diff --git a/api_core/docs/client_options.rst b/api_core/docs/client_options.rst
@@ -0,0 +1,6 @@
+Client Options
+==========================
+
+.. automodule:: google.api_core.client_options
+  :members:
+  :show-inheritance:
diff --git a/api_core/docs/index.rst b/api_core/docs/index.rst
@@ -9,6 +9,7 @@ Core
 .. toctree::
     auth
     client_info
+    client_options
     exceptions
     futures
     helpers
diff --git a/api_core/google/api_core/client_options.py b/api_core/google/api_core/client_options.py
@@ -16,6 +16,27 @@
 
 Client options provide a consistent interface for user options to be defined
 across clients.
+
+You can pass a client options object to a client.
+
+.. code-block:: python
+
+    from google.api_core.client_options import ClientOptions
+    from google.cloud.vision_v1 import ImageAnnotatorClient
+
+    options = ClientOptions(api_endpoint="foo.googleapis.com")
+
+    client = ImageAnnotatorClient(client_options=options)
+
+You can also pass a dictionary.
+
+.. code-block:: python
+
+    from google.cloud.vision_v1 import ImageAnnotatorClient
+
+    client = ImageAnnotatorClient(client_options={"api_endpoint": "foo.googleapis.com"})
+
+
 """
 
 
