NotificationsYou must be signed in to change notification settings
Fork95
Star144

Commit3069ef4

authored

feat: add universe_domain attribute to ClientOptions (#546)

* feat: add universe_domain option for TPC* test: update options to include universe domain* update the docstring* 🦉 Updates from OwlBot post-processorSeehttps://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md* Update google/api_core/client_options.pyCo-authored-by: Anthonios Partheniou <partheniou@google.com>* Update client_options.py---------Co-authored-by: omair <omairn@google.com>Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>Co-authored-by: Anthonios Partheniou <partheniou@google.com>

1 parentfc12b40 commit3069ef4Copy full SHA for 3069ef4

File tree

2 files changed

+12

-0

lines changed

google/api_core
- client_options.py
tests/unit
- test_client_options.py

2 files changed

+12

-0

lines changed

`‎google/api_core/client_options.py‎`

Lines changed: 7 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -75,6 +75,11 @@ class ClientOptions(object):`
`75`	`75`	`authentication flows. Audience is typically a resource identifier.`
`76`	`76`	`If not set, the service endpoint value will be used as a default.`
`77`	`77`	An example of a valid ``api_audience`` is: "https://language.googleapis.com".
	`78`	`+ universe_domain (Optional[str]): The desired universe domain. This must match`
	`79`	`+ the one in credentials. If not set, the default universe domain is`
	`80`	+ `googleapis.com`. If both `api_endpoint` and `universe_domain` are set,
	`81`	+ then `api_endpoint` is used as the service endpoint. If `api_endpoint` is
	`82`	+ not specified, the format will be `{service}.{universe_domain}`.
`78`	`83`
`79`	`84`	`Raises:`
`80`	`85`	ValueError: If both ``client_cert_source`` and ``client_encrypted_cert_source``
`@@ -91,6 +96,7 @@ def __init__(`
`91`	`96`	`scopes=None,`
`92`	`97`	`api_key=None,`
`93`	`98`	`api_audience=None,`
	`99`	`+universe_domain=None,`
`94`	`100`	`):`
`95`	`101`	`ifclient_cert_sourceandclient_encrypted_cert_source:`
`96`	`102`	`raiseValueError(`
`@@ -106,6 +112,7 @@ def __init__(`
`106`	`112`	`self.scopes=scopes`
`107`	`113`	`self.api_key=api_key`
`108`	`114`	`self.api_audience=api_audience`
	`115`	`+self.universe_domain=universe_domain`
`109`	`116`
`110`	`117`	`def__repr__(self):`
`111`	`118`	`return"ClientOptions: "+repr(self.__dict__)`

`‎tests/unit/test_client_options.py‎`

Lines changed: 5 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,7 @@ def test_constructor():`
`38`	`38`	`"https://www.googleapis.com/auth/cloud-platform.read-only",`
`39`	`39`	`],`
`40`	`40`	`api_audience="foo2.googleapis.com",`
	`41`	`+universe_domain="googleapis.com",`
`41`	`42`	`)`
`42`	`43`
`43`	`44`	`assertoptions.api_endpoint=="foo.googleapis.com"`
`@@ -49,6 +50,7 @@ def test_constructor():`
`49`	`50`	`"https://www.googleapis.com/auth/cloud-platform.read-only",`
`50`	`51`	`]`
`51`	`52`	`assertoptions.api_audience=="foo2.googleapis.com"`
	`53`	`+assertoptions.universe_domain=="googleapis.com"`
`52`	`54`
`53`	`55`
`54`	`56`	`deftest_constructor_with_encrypted_cert_source():`
`@@ -110,6 +112,7 @@ def test_from_dict():`
`110`	`112`	`options=client_options.from_dict(`
`111`	`113`	`{`
`112`	`114`	`"api_endpoint":"foo.googleapis.com",`
	`115`	`+"universe_domain":"googleapis.com",`
`113`	`116`	`"client_cert_source":get_client_cert,`
`114`	`117`	`"quota_project_id":"quote-proj",`
`115`	`118`	`"credentials_file":"path/to/credentials.json",`
`@@ -122,6 +125,7 @@ def test_from_dict():`
`122`	`125`	`)`
`123`	`126`
`124`	`127`	`assertoptions.api_endpoint=="foo.googleapis.com"`
	`128`	`+assertoptions.universe_domain=="googleapis.com"`
`125`	`129`	`assertoptions.client_cert_source()== (b"cert",b"key")`
`126`	`130`	`assertoptions.quota_project_id=="quote-proj"`
`127`	`131`	`assertoptions.credentials_file=="path/to/credentials.json"`
`@@ -148,6 +152,7 @@ def test_repr():`
`148`	`152`	`expected_keys=set(`
`149`	`153`	`[`
`150`	`154`	`"api_endpoint",`
	`155`	`+"universe_domain",`
`151`	`156`	`"client_cert_source",`
`152`	`157`	`"client_encrypted_cert_source",`
`153`	`158`	`"quota_project_id",`

0 commit comments

Comments

(0)

Movatterモバイル変換

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit3069ef4

File tree

2 files changed

2 files changed

`‎google/api_core/client_options.py‎`

`‎tests/unit/test_client_options.py‎`

0 commit comments