Skip to content
This repository was archived by the owner on Nov 29, 2023. It is now read-only.

Commit 3b4f0d0

Browse files
gcf-owl-bot[bot]parthea
gcf-owl-bot[bot]
and
parthea
authored
feat: add api key support (#242)
* chore: upgrade gapic-generator-java, gax-java and gapic-generator-python PiperOrigin-RevId: 423842556 Source-Link: googleapis/googleapis@a616ca0 Source-Link: https://github.com/googleapis/googleapis-gen/commit/29b938c58c1e51d019f2ee539d55dc0a3c86a905 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMjliOTM4YzU4YzFlNTFkMDE5ZjJlZTUzOWQ1NWRjMGEzYzg2YTkwNSJ9 * 🦉 Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Anthonios Partheniou <partheniou@google.com>
1 parent a33c386 commit 3b4f0d0

6 files changed

Lines changed: 490 additions & 88 deletions

File tree

‎google/cloud/texttospeech_v1/services/text_to_speech/async_client.py‎

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
from collections import OrderedDict
1717
import functools
1818
import re
19-
from typing import Dict, Sequence, Tuple, Type, Union
19+
from typing import Dict, Optional, Sequence, Tuple, Type, Union
2020
import pkg_resources
2121

2222
from google.api_core.client_options import ClientOptions
@@ -99,6 +99,42 @@ def from_service_account_file(cls, filename: str, *args, **kwargs):
9999

100100
from_service_account_json = from_service_account_file
101101

102+
@classmethod
103+
def get_mtls_endpoint_and_cert_source(
104+
cls, client_options: Optional[ClientOptions] = None
105+
):
106+
"""Return the API endpoint and client cert source for mutual TLS.
107+
108+
The client cert source is determined in the following order:
109+
(1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the
110+
client cert source is None.
111+
(2) if `client_options.client_cert_source` is provided, use the provided one; if the
112+
default client cert source exists, use the default one; otherwise the client cert
113+
source is None.
114+
115+
The API endpoint is determined in the following order:
116+
(1) if `client_options.api_endpoint` if provided, use the provided one.
117+
(2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the
118+
default mTLS endpoint; if the environment variabel is "never", use the default API
119+
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
120+
use the default API endpoint.
121+
122+
More details can be found at https://google.aip.dev/auth/4114.
123+
124+
Args:
125+
client_options (google.api_core.client_options.ClientOptions): Custom options for the
126+
client. Only the `api_endpoint` and `client_cert_source` properties may be used
127+
in this method.
128+
129+
Returns:
130+
Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the
131+
client cert source to use.
132+
133+
Raises:
134+
google.auth.exceptions.MutualTLSChannelError: If any errors happen.
135+
"""
136+
return TextToSpeechClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore
137+
102138
@property
103139
def transport(self) -> TextToSpeechTransport:
104140
"""Returns the transport used by the client instance.

‎google/cloud/texttospeech_v1/services/text_to_speech/client.py‎

Lines changed: 84 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -215,6 +215,73 @@ def parse_common_location_path(path: str) -> Dict[str, str]:
215215
m = re.match(r"^projects/(?P<project>.+?)/locations/(?P<location>.+?)$", path)
216216
return m.groupdict() if m else {}
217217

218+
@classmethod
219+
def get_mtls_endpoint_and_cert_source(
220+
cls, client_options: Optional[client_options_lib.ClientOptions] = None
221+
):
222+
"""Return the API endpoint and client cert source for mutual TLS.
223+
224+
The client cert source is determined in the following order:
225+
(1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the
226+
client cert source is None.
227+
(2) if `client_options.client_cert_source` is provided, use the provided one; if the
228+
default client cert source exists, use the default one; otherwise the client cert
229+
source is None.
230+
231+
The API endpoint is determined in the following order:
232+
(1) if `client_options.api_endpoint` if provided, use the provided one.
233+
(2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the
234+
default mTLS endpoint; if the environment variabel is "never", use the default API
235+
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
236+
use the default API endpoint.
237+
238+
More details can be found at https://google.aip.dev/auth/4114.
239+
240+
Args:
241+
client_options (google.api_core.client_options.ClientOptions): Custom options for the
242+
client. Only the `api_endpoint` and `client_cert_source` properties may be used
243+
in this method.
244+
245+
Returns:
246+
Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the
247+
client cert source to use.
248+
249+
Raises:
250+
google.auth.exceptions.MutualTLSChannelError: If any errors happen.
251+
"""
252+
if client_options is None:
253+
client_options = client_options_lib.ClientOptions()
254+
use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false")
255+
use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto")
256+
if use_client_cert not in ("true", "false"):
257+
raise ValueError(
258+
"Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`"
259+
)
260+
if use_mtls_endpoint not in ("auto", "never", "always"):
261+
raise MutualTLSChannelError(
262+
"Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`"
263+
)
264+
265+
# Figure out the client cert source to use.
266+
client_cert_source = None
267+
if use_client_cert == "true":
268+
if client_options.client_cert_source:
269+
client_cert_source = client_options.client_cert_source
270+
elif mtls.has_default_client_cert_source():
271+
client_cert_source = mtls.default_client_cert_source()
272+
273+
# Figure out which api endpoint to use.
274+
if client_options.api_endpoint is not None:
275+
api_endpoint = client_options.api_endpoint
276+
elif use_mtls_endpoint == "always" or (
277+
use_mtls_endpoint == "auto" and client_cert_source
278+
):
279+
api_endpoint = cls.DEFAULT_MTLS_ENDPOINT
280+
else:
281+
api_endpoint = cls.DEFAULT_ENDPOINT
282+
283+
return api_endpoint, client_cert_source
284+
218285
def __init__(
219286
self,
220287
*,
@@ -265,57 +332,22 @@ def __init__(
265332
if client_options is None:
266333
client_options = client_options_lib.ClientOptions()
267334

268-
# Create SSL credentials for mutual TLS if needed.
269-
if os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") not in (
270-
"true",
271-
"false",
272-
):
273-
raise ValueError(
274-
"Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`"
275-
)
276-
use_client_cert = (
277-
os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") == "true"
335+
api_endpoint, client_cert_source_func = self.get_mtls_endpoint_and_cert_source(
336+
client_options
278337
)
279338

280-
client_cert_source_func = None
281-
is_mtls = False
282-
if use_client_cert:
283-
if client_options.client_cert_source:
284-
is_mtls = True
285-
client_cert_source_func = client_options.client_cert_source
286-
else:
287-
is_mtls = mtls.has_default_client_cert_source()
288-
if is_mtls:
289-
client_cert_source_func = mtls.default_client_cert_source()
290-
else:
291-
client_cert_source_func = None
292-
293-
# Figure out which api endpoint to use.
294-
if client_options.api_endpoint is not None:
295-
api_endpoint = client_options.api_endpoint
296-
else:
297-
use_mtls_env = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto")
298-
if use_mtls_env == "never":
299-
api_endpoint = self.DEFAULT_ENDPOINT
300-
elif use_mtls_env == "always":
301-
api_endpoint = self.DEFAULT_MTLS_ENDPOINT
302-
elif use_mtls_env == "auto":
303-
if is_mtls:
304-
api_endpoint = self.DEFAULT_MTLS_ENDPOINT
305-
else:
306-
api_endpoint = self.DEFAULT_ENDPOINT
307-
else:
308-
raise MutualTLSChannelError(
309-
"Unsupported GOOGLE_API_USE_MTLS_ENDPOINT value. Accepted "
310-
"values: never, auto, always"
311-
)
339+
api_key_value = getattr(client_options, "api_key", None)
340+
if api_key_value and credentials:
341+
raise ValueError(
342+
"client_options.api_key and credentials are mutually exclusive"
343+
)
312344

313345
# Save or instantiate the transport.
314346
# Ordinarily, we provide the transport, but allowing a custom transport
315347
# instance provides an extensibility point for unusual situations.
316348
if isinstance(transport, TextToSpeechTransport):
317349
# transport is a TextToSpeechTransport instance.
318-
if credentials or client_options.credentials_file:
350+
if credentials or client_options.credentials_file or api_key_value:
319351
raise ValueError(
320352
"When providing a transport instance, "
321353
"provide its credentials directly."
@@ -327,6 +359,15 @@ def __init__(
327359
)
328360
self._transport = transport
329361
else:
362+
import google.auth._default # type: ignore
363+
364+
if api_key_value and hasattr(
365+
google.auth._default, "get_api_key_credentials"
366+
):
367+
credentials = google.auth._default.get_api_key_credentials(
368+
api_key_value
369+
)
370+
330371
Transport = type(self).get_transport_class(transport)
331372
self._transport = Transport(
332373
credentials=credentials,

‎google/cloud/texttospeech_v1beta1/services/text_to_speech/async_client.py‎

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
from collections import OrderedDict
1717
import functools
1818
import re
19-
from typing import Dict, Sequence, Tuple, Type, Union
19+
from typing import Dict, Optional, Sequence, Tuple, Type, Union
2020
import pkg_resources
2121

2222
from google.api_core.client_options import ClientOptions
@@ -101,6 +101,42 @@ def from_service_account_file(cls, filename: str, *args, **kwargs):
101101

102102
from_service_account_json = from_service_account_file
103103

104+
@classmethod
105+
def get_mtls_endpoint_and_cert_source(
106+
cls, client_options: Optional[ClientOptions] = None
107+
):
108+
"""Return the API endpoint and client cert source for mutual TLS.
109+
110+
The client cert source is determined in the following order:
111+
(1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the
112+
client cert source is None.
113+
(2) if `client_options.client_cert_source` is provided, use the provided one; if the
114+
default client cert source exists, use the default one; otherwise the client cert
115+
source is None.
116+
117+
The API endpoint is determined in the following order:
118+
(1) if `client_options.api_endpoint` if provided, use the provided one.
119+
(2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the
120+
default mTLS endpoint; if the environment variabel is "never", use the default API
121+
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
122+
use the default API endpoint.
123+
124+
More details can be found at https://google.aip.dev/auth/4114.
125+
126+
Args:
127+
client_options (google.api_core.client_options.ClientOptions): Custom options for the
128+
client. Only the `api_endpoint` and `client_cert_source` properties may be used
129+
in this method.
130+
131+
Returns:
132+
Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the
133+
client cert source to use.
134+
135+
Raises:
136+
google.auth.exceptions.MutualTLSChannelError: If any errors happen.
137+
"""
138+
return TextToSpeechClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore
139+
104140
@property
105141
def transport(self) -> TextToSpeechTransport:
106142
"""Returns the transport used by the client instance.

0 commit comments

Comments
 (0)