Add client options. (#9045)

Author: busunkim96

packages/google-cloud-runtimeconfig/docs/conf.py

@@ -340,10 +340,7 @@
 intersphinx_mapping = {
     "python": ("http://python.readthedocs.org/en/latest/", None),
     "google-auth": ("https://google-auth.readthedocs.io/en/stable", None),
-    "google.api_core": (
-        "https://googleapis.github.io/google-cloud-python/latest",
-        None,
-    ),
+    "google.api_core": ("https://googleapis.dev/python/google-api-core/latest", None),
     "grpc": ("https://grpc.io/grpc/python/", None),
     "requests": ("https://2.python-requests.org/en/master/", None),
 }

packages/google-cloud-runtimeconfig/google/cloud/runtimeconfig/_http.py

@@ -31,15 +31,14 @@ class Connection(_http.JSONConnection):
     :param client_info: (Optional) instance used to generate user agent.
     """
 
-    def __init__(self, client, client_info=None):
-        super(Connection, self).__init__(client, client_info)
+    DEFAULT_API_ENDPOINT = "https://runtimeconfig.googleapis.com"
 
+    def __init__(self, client, client_info=None, api_endpoint=DEFAULT_API_ENDPOINT):
+        super(Connection, self).__init__(client, client_info)
+        self.API_BASE_URL = api_endpoint
         self._client_info.gapic_version = __version__
         self._client_info.client_library_version = __version__
 
-    API_BASE_URL = "https://runtimeconfig.googleapis.com"
-    """The base of the API call URL."""
-
     API_VERSION = "v1beta1"
     """The version of the API, used in building the API call's URL."""
 

packages/google-cloud-runtimeconfig/google/cloud/runtimeconfig/client.py

@@ -14,7 +14,7 @@
 
 """Client for interacting with the Google Cloud RuntimeConfig API."""
 
-
+import google.api_core.client_options
 from google.cloud.client import ClientWithProject
 
 from google.cloud.runtimeconfig._http import Connection
@@ -50,16 +50,38 @@ class Client(ClientWithProject):
         requests. If ``None``, then default info will be used. Generally,
         you only need to set this if you're developing your own library
         or partner tool.
+    :type client_options: :class:`~google.api_core.client_options.ClientOptions`
+        or :class:`dict`
+    :param client_options: (Optional) Client options used to set user options
+        on the client. API Endpoint should be set through client_options.
     """
 
     SCOPE = ("https://www.googleapis.com/auth/cloudruntimeconfig",)
     """The scopes required for authenticating as a RuntimeConfig consumer."""
 
-    def __init__(self, project=None, credentials=None, _http=None, client_info=None):
+    def __init__(
+        self,
+        project=None,
+        credentials=None,
+        _http=None,
+        client_info=None,
+        client_options=None,
+    ):
         super(Client, self).__init__(
             project=project, credentials=credentials, _http=_http
         )
-        self._connection = Connection(self, client_info=client_info)
+
+        kw_args = {"client_info": client_info}
+        if client_options:
+            if type(client_options) == dict:
+                client_options = google.api_core.client_options.from_dict(
+                    client_options
+                )
+            if client_options.api_endpoint:
+                api_endpoint = client_options.api_endpoint
+                kw_args["api_endpoint"] = api_endpoint
+
+        self._connection = Connection(self, **kw_args)
 
     def config(self, config_name):
         """Factory constructor for config object.

packages/google-cloud-runtimeconfig/tests/unit/test__http.py

@@ -32,6 +32,12 @@ def test_default_url(self):
         conn = self._make_one(client)
         self.assertIs(conn._client, client)
 
+    def test_build_api_url_w_custom_endpoint(self):
+        custom_endpoint = "https://foo-runtimeconfig.googleapis.com"
+        conn = self._make_one(object(), api_endpoint=custom_endpoint)
+        URI = "/".join([custom_endpoint, conn.API_VERSION, "foo"])
+        self.assertEqual(conn.build_api_url("/foo"), URI)
+
     def test_extra_headers(self):
         import requests
         from google.cloud import _http as base_http

packages/google-cloud-runtimeconfig/tests/unit/test_client.py

@@ -64,6 +64,36 @@ def test_ctor_w_client_info(self):
         self.assertIs(client._http_internal, http)
         self.assertIs(client._connection._client_info, client_info)
 
+    def test_ctor_w_empty_client_options(self):
+        from google.api_core.client_options import ClientOptions
+
+        http = object()
+        client_options = ClientOptions()
+        client = self._make_one(_http=http, client_options=client_options)
+        self.assertEqual(
+            client._connection.API_BASE_URL, client._connection.DEFAULT_API_ENDPOINT
+        )
+
+    def test_constructor_w_client_options_object(self):
+        from google.api_core.client_options import ClientOptions
+
+        http = object()
+        client_options = ClientOptions(
+            api_endpoint="https://foo-runtimeconfig.googleapis.com"
+        )
+        client = self._make_one(_http=http, client_options=client_options)
+        self.assertEqual(
+            client._connection.API_BASE_URL, "https://foo-runtimeconfig.googleapis.com"
+        )
+
+    def test_constructor_w_client_options_dict(self):
+        http = object()
+        client_options = {"api_endpoint": "https://foo-runtimeconfig.googleapis.com"}
+        client = self._make_one(_http=http, client_options=client_options)
+        self.assertEqual(
+            client._connection.API_BASE_URL, "https://foo-runtimeconfig.googleapis.com"
+        )
+
     def test_config(self):
         PROJECT = "PROJECT"
         CONFIG_NAME = "config_name"