FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
python-api-core/google/api_core/client_options.py at master · software-dov/python-api-core · GitHub
software-dov
/
python-api-core
Public
forked from
googleapis/python-api-core
Notifications
You must be signed in to change notification settings
Fork
0
Star
0
Code
Pull requests
2
Actions
Projects
Security and quality
0
Insights
Additional navigation options
Code
Pull requests
Actions
Projects
Security and quality
Insights
Expand file tree
Breadcrumbs
python-api-core
/
google
/
api_core
/
client_options.py
Copy path
More file actions
More file actions
Latest commit
History
History
History
123 lines (97 loc) · 4.39 KB
Breadcrumbs
python-api-core
/
google
/
api_core
/
client_options.py
Copy path
File metadata and controls
123 lines (97 loc) · 4.39 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# Copyright 2019 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Client options class.
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
def get_client_cert():
# code to load client certificate and private key.
return client_cert_bytes, client_private_key_bytes
options = ClientOptions(api_endpoint="foo.googleapis.com",
client_cert_source=get_client_cert)
client = ImageAnnotatorClient(client_options=options)
You can also pass a mapping object.
.. code-block:: python
from google.cloud.vision_v1 import ImageAnnotatorClient
client = ImageAnnotatorClient(
client_options={
"api_endpoint": "foo.googleapis.com",
"client_cert_source" : get_client_cert
})
"""
class
ClientOptions
(
object
):
"""Client Options used to set options on clients.
Args:
api_endpoint (Optional[str]): The desired API endpoint, e.g.,
compute.googleapis.com
client_cert_source (Optional[Callable[[], (bytes, bytes)]]): A callback
which returns client certificate bytes and private key bytes both in
PEM format. ``client_cert_source`` and ``client_encrypted_cert_source``
are mutually exclusive.
client_encrypted_cert_source (Optional[Callable[[], (str, str, bytes)]]):
A callback which returns client certificate file path, encrypted
private key file path, and the passphrase bytes.``client_cert_source``
and ``client_encrypted_cert_source`` are mutually exclusive.
quota_project_id (Optional[str]): A project name that a client's
quota belongs to.
credentials_file (Optional[str]): A path to a file storing credentials.
``credentials_file` and ``api_key`` are mutually exclusive.
scopes (Optional[Sequence[str]]): OAuth access token override scopes.
api_key (Optional[str]): Google API key. ``credentials_file`` and
``api_key`` are mutually exclusive.
Raises:
ValueError: If both ``client_cert_source`` and ``client_encrypted_cert_source``
are provided, or both ``credentials_file`` and ``api_key`` are provided.
"""
def
__init__
(
self
,
api_endpoint
=
None
,
client_cert_source
=
None
,
client_encrypted_cert_source
=
None
,
quota_project_id
=
None
,
credentials_file
=
None
,
scopes
=
None
,
api_key
=
None
,
):
if
client_cert_source
and
client_encrypted_cert_source
:
raise
ValueError
(
"client_cert_source and client_encrypted_cert_source are mutually exclusive"
)
if
api_key
and
credentials_file
:
raise
ValueError
(
"api_key and credentials_file are mutually exclusive"
)
self
.
api_endpoint
=
api_endpoint
self
.
client_cert_source
=
client_cert_source
self
.
client_encrypted_cert_source
=
client_encrypted_cert_source
self
.
quota_project_id
=
quota_project_id
self
.
credentials_file
=
credentials_file
self
.
scopes
=
scopes
self
.
api_key
=
api_key
def
__repr__
(
self
):
return
"ClientOptions: "
+
repr
(
self
.
__dict__
)
def
from_dict
(
options
):
"""Construct a client options object from a mapping object.
Args:
options (collections.abc.Mapping): A mapping object with client options.
See the docstring for ClientOptions for details on valid arguments.
"""
client_options
=
ClientOptions
()
for
key
,
value
in
options
.
items
():
if
hasattr
(
client_options
,
key
):
setattr
(
client_options
,
key
,
value
)
else
:
raise
ValueError
(
"ClientOptions does not accept an option '"
+
key
+
"'"
)
return
client_options
Back
|
FazBrowse Home
|
New Git URL