Skip to content
This repository was archived by the owner on Mar 26, 2026. It is now read-only.

Commit 0c8940f

Browse files
committed
Sync docstring in async_client
1 parent 33195e5 commit 0c8940f

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

gapic/templates/%namespace/%name_%version/%sub/services/%service/async_client.py.j2

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -60,14 +60,19 @@ class {{ service.async_client_name }}:
6060
transport (Union[str, ~.{{ service.name }}Transport]): The
6161
transport to use. If set to None, a transport is chosen
6262
automatically.
63-
client_options (ClientOptions): Custom options for the client.
63+
client_options (ClientOptions): Custom options for the client. It
64+
won't take effect if a ``transport`` instance is provided.
6465
(1) The ``api_endpoint`` property can be used to override the
65-
default endpoint provided by the client.
66-
(2) If ``transport`` argument is None, ``client_options`` can be
67-
used to create a mutual TLS transport. If ``client_cert_source``
68-
is provided, mutual TLS transport will be created with the given
69-
``api_endpoint`` or the default mTLS endpoint, and the client
70-
SSL credentials obtained from ``client_cert_source``.
66+
default endpoint provided by the client. GOOGLE_API_USE_MTLS
67+
environment variable can also be used to override the endpoint:
68+
"always" (always use the default mTLS endpoint), "never" (always
69+
use the default regular endpoint, this is the default value for
70+
the environment variable) and "auto" (auto switch to the default
71+
mTLS endpoint if client SSL credentials is present). However,
72+
the ``api_endpoint`` property takes precedence if provided.
73+
(2) The ``client_cert_source`` property is used to provide client
74+
SSL credentials for mutual TLS transport. If not provided, the
75+
default SSL credentials will be used if present.
7176

7277
Raises:
7378
google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport

0 commit comments

Comments
 (0)