google-developer-knowledge 0.1.1__tar.gz → 0.1.3__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. {google_developer_knowledge-0.1.1/google_developer_knowledge.egg-info → google_developer_knowledge-0.1.3}/PKG-INFO +3 -2
  2. {google_developer_knowledge-0.1.1 → google_developer_knowledge-0.1.3}/google/developer_knowledge/gapic_version.py +1 -1
  3. google_developer_knowledge-0.1.3/google/developer_knowledge_v1/__init__.py +69 -0
  4. google_developer_knowledge-0.1.3/google/developer_knowledge_v1/_compat.py +262 -0
  5. {google_developer_knowledge-0.1.1 → google_developer_knowledge-0.1.3}/google/developer_knowledge_v1/gapic_version.py +1 -1
  6. {google_developer_knowledge-0.1.1 → google_developer_knowledge-0.1.3}/google/developer_knowledge_v1/services/developer_knowledge/async_client.py +8 -3
  7. {google_developer_knowledge-0.1.1 → google_developer_knowledge-0.1.3}/google/developer_knowledge_v1/services/developer_knowledge/client.py +31 -163
  8. {google_developer_knowledge-0.1.1 → google_developer_knowledge-0.1.3}/google/developer_knowledge_v1/services/developer_knowledge/transports/rest.py +41 -39
  9. {google_developer_knowledge-0.1.1 → google_developer_knowledge-0.1.3}/google/developer_knowledge_v1/services/developer_knowledge/transports/rest_base.py +0 -133
  10. {google_developer_knowledge-0.1.1 → google_developer_knowledge-0.1.3}/google/developer_knowledge_v1/types/developerknowledge.py +90 -8
  11. {google_developer_knowledge-0.1.1 → google_developer_knowledge-0.1.3/google_developer_knowledge.egg-info}/PKG-INFO +3 -2
  12. {google_developer_knowledge-0.1.1 → google_developer_knowledge-0.1.3}/google_developer_knowledge.egg-info/SOURCES.txt +2 -0
  13. {google_developer_knowledge-0.1.1 → google_developer_knowledge-0.1.3}/google_developer_knowledge.egg-info/requires.txt +1 -1
  14. {google_developer_knowledge-0.1.1 → google_developer_knowledge-0.1.3}/setup.py +2 -1
  15. google_developer_knowledge-0.1.3/tests/unit/gapic/developer_knowledge_v1/test_compat.py +429 -0
  16. {google_developer_knowledge-0.1.1 → google_developer_knowledge-0.1.3}/tests/unit/gapic/developer_knowledge_v1/test_developer_knowledge.py +50 -389
  17. google_developer_knowledge-0.1.1/google/developer_knowledge_v1/__init__.py +0 -153
  18. {google_developer_knowledge-0.1.1 → google_developer_knowledge-0.1.3}/LICENSE +0 -0
  19. {google_developer_knowledge-0.1.1 → google_developer_knowledge-0.1.3}/MANIFEST.in +0 -0
  20. {google_developer_knowledge-0.1.1 → google_developer_knowledge-0.1.3}/README.rst +0 -0
  21. {google_developer_knowledge-0.1.1 → google_developer_knowledge-0.1.3}/google/developer_knowledge/__init__.py +0 -0
  22. {google_developer_knowledge-0.1.1 → google_developer_knowledge-0.1.3}/google/developer_knowledge/py.typed +0 -0
  23. {google_developer_knowledge-0.1.1 → google_developer_knowledge-0.1.3}/google/developer_knowledge_v1/gapic_metadata.json +0 -0
  24. {google_developer_knowledge-0.1.1 → google_developer_knowledge-0.1.3}/google/developer_knowledge_v1/py.typed +0 -0
  25. {google_developer_knowledge-0.1.1 → google_developer_knowledge-0.1.3}/google/developer_knowledge_v1/services/__init__.py +0 -0
  26. {google_developer_knowledge-0.1.1 → google_developer_knowledge-0.1.3}/google/developer_knowledge_v1/services/developer_knowledge/__init__.py +0 -0
  27. {google_developer_knowledge-0.1.1 → google_developer_knowledge-0.1.3}/google/developer_knowledge_v1/services/developer_knowledge/pagers.py +0 -0
  28. {google_developer_knowledge-0.1.1 → google_developer_knowledge-0.1.3}/google/developer_knowledge_v1/services/developer_knowledge/transports/__init__.py +0 -0
  29. {google_developer_knowledge-0.1.1 → google_developer_knowledge-0.1.3}/google/developer_knowledge_v1/services/developer_knowledge/transports/base.py +0 -0
  30. {google_developer_knowledge-0.1.1 → google_developer_knowledge-0.1.3}/google/developer_knowledge_v1/services/developer_knowledge/transports/grpc.py +0 -0
  31. {google_developer_knowledge-0.1.1 → google_developer_knowledge-0.1.3}/google/developer_knowledge_v1/services/developer_knowledge/transports/grpc_asyncio.py +0 -0
  32. {google_developer_knowledge-0.1.1 → google_developer_knowledge-0.1.3}/google/developer_knowledge_v1/types/__init__.py +0 -0
  33. {google_developer_knowledge-0.1.1 → google_developer_knowledge-0.1.3}/google_developer_knowledge.egg-info/dependency_links.txt +0 -0
  34. {google_developer_knowledge-0.1.1 → google_developer_knowledge-0.1.3}/google_developer_knowledge.egg-info/not-zip-safe +0 -0
  35. {google_developer_knowledge-0.1.1 → google_developer_knowledge-0.1.3}/google_developer_knowledge.egg-info/top_level.txt +0 -0
  36. {google_developer_knowledge-0.1.1 → google_developer_knowledge-0.1.3}/setup.cfg +0 -0
  37. {google_developer_knowledge-0.1.1 → google_developer_knowledge-0.1.3}/tests/__init__.py +0 -0
  38. {google_developer_knowledge-0.1.1 → google_developer_knowledge-0.1.3}/tests/unit/__init__.py +0 -0
  39. {google_developer_knowledge-0.1.1 → google_developer_knowledge-0.1.3}/tests/unit/gapic/__init__.py +0 -0
  40. {google_developer_knowledge-0.1.1 → google_developer_knowledge-0.1.3}/tests/unit/gapic/developer_knowledge_v1/__init__.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: google-developer-knowledge
3
- Version: 0.1.1
3
+ Version: 0.1.3
4
4
  Summary: Google Developer Knowledge API client library
5
5
  Home-page: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-developer-knowledge
6
6
  Author: Google LLC
@@ -17,11 +17,12 @@ Classifier: Programming Language :: Python :: 3.11
17
17
  Classifier: Programming Language :: Python :: 3.12
18
18
  Classifier: Programming Language :: Python :: 3.13
19
19
  Classifier: Programming Language :: Python :: 3.14
20
+ Classifier: Programming Language :: Python :: 3.15
20
21
  Classifier: Operating System :: OS Independent
21
22
  Classifier: Topic :: Internet
22
23
  Requires-Python: >=3.10
23
24
  License-File: LICENSE
24
- Requires-Dist: google-api-core[grpc]<3.0.0,>=2.25.0
25
+ Requires-Dist: google-api-core[grpc]<3.0.0,>=2.28.0
25
26
  Requires-Dist: google-auth!=2.24.0,!=2.25.0,<3.0.0,>=2.14.1
26
27
  Requires-Dist: grpcio<2.0.0,>=1.59.0
27
28
  Requires-Dist: grpcio<2.0.0,>=1.75.1; python_version >= "3.14"
@@ -13,4 +13,4 @@
13
13
  # See the License for the specific language governing permissions and
14
14
  # limitations under the License.
15
15
  #
16
- __version__ = "0.1.1" # {x-release-please-version}
16
+ __version__ = "0.1.3" # {x-release-please-version}
@@ -0,0 +1,69 @@
1
+ # -*- coding: utf-8 -*-
2
+ # Copyright 2026 Google LLC
3
+ #
4
+ # Licensed under the Apache License, Version 2.0 (the "License");
5
+ # you may not use this file except in compliance with the License.
6
+ # You may obtain a copy of the License at
7
+ #
8
+ # http://www.apache.org/licenses/LICENSE-2.0
9
+ #
10
+ # Unless required by applicable law or agreed to in writing, software
11
+ # distributed under the License is distributed on an "AS IS" BASIS,
12
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ # See the License for the specific language governing permissions and
14
+ # limitations under the License.
15
+ #
16
+ import google.api_core as api_core
17
+
18
+ from google.developer_knowledge_v1 import gapic_version as package_version
19
+
20
+ __version__ = package_version.__version__
21
+
22
+ # PEP 0810: Explicit Lazy Imports
23
+ # Python 3.15+ natively intercepts and defers these imports.
24
+ # Developers can disable this behavior and force eager imports.
25
+ # For more information, see:
26
+ # https://docs.python.org/3.15/library/sys.html#sys.set_lazy_imports_filter
27
+ # Older Python versions safely ignore this variable.
28
+ __lazy_modules__ = {
29
+ "google.developer_knowledge_v1.services.developer_knowledge",
30
+ "google.developer_knowledge_v1.types.developerknowledge",
31
+ }
32
+
33
+
34
+ from .services.developer_knowledge import (
35
+ DeveloperKnowledgeAsyncClient,
36
+ DeveloperKnowledgeClient,
37
+ )
38
+ from .types.developerknowledge import (
39
+ Answer,
40
+ AnswerQueryRequest,
41
+ AnswerQueryResponse,
42
+ BatchGetDocumentsRequest,
43
+ BatchGetDocumentsResponse,
44
+ Document,
45
+ DocumentChunk,
46
+ DocumentView,
47
+ GetDocumentRequest,
48
+ SearchDocumentChunksRequest,
49
+ SearchDocumentChunksResponse,
50
+ )
51
+
52
+ __all__ = (
53
+ "DeveloperKnowledgeAsyncClient",
54
+ "Answer",
55
+ "AnswerQueryRequest",
56
+ "AnswerQueryResponse",
57
+ "BatchGetDocumentsRequest",
58
+ "BatchGetDocumentsResponse",
59
+ "DeveloperKnowledgeClient",
60
+ "Document",
61
+ "DocumentChunk",
62
+ "DocumentView",
63
+ "GetDocumentRequest",
64
+ "SearchDocumentChunksRequest",
65
+ "SearchDocumentChunksResponse",
66
+ )
67
+
68
+ api_core.check_python_version("google.developer_knowledge_v1")
69
+ api_core.check_dependency_versions("google.developer_knowledge_v1")
@@ -0,0 +1,262 @@
1
+ # -*- coding: utf-8 -*-
2
+ # Copyright 2026 Google LLC
3
+ #
4
+ # Licensed under the Apache License, Version 2.0 (the "License");
5
+ # you may not use this file except in compliance with the License.
6
+ # You may obtain a copy of the License at
7
+ #
8
+ # http://www.apache.org/licenses/LICENSE-2.0
9
+ #
10
+ # Unless required by applicable law or agreed to in writing, software
11
+ # distributed under the License is distributed on an "AS IS" BASIS,
12
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ # See the License for the specific language governing permissions and
14
+ # limitations under the License.
15
+ #
16
+ """A compatibility module for older versions of google-api-core."""
17
+
18
+ import json
19
+ import os
20
+ from typing import Any, Dict, List, Optional, Tuple
21
+ from urllib.parse import urlparse, urlunparse
22
+
23
+ from google.api_core import path_template
24
+ from google.api_core.universe import EmptyUniverseError
25
+ from google.auth.exceptions import MutualTLSChannelError
26
+ from google.protobuf import json_format
27
+
28
+ try:
29
+ # note: `#type: ignore` is added because the return type for `should_use_client_cert`
30
+ # is different than that of the fallback implementation below. This will be removed once
31
+ # we bump the minimum supported version of google-auth.
32
+ from google.auth.transport.mtls import should_use_client_cert # type: ignore
33
+ except ImportError: # pragma: NO COVER
34
+
35
+ def should_use_client_cert():
36
+ """Returns whether client certificate should be used for mTLS."""
37
+ use_client_cert = os.getenv(
38
+ "GOOGLE_API_USE_CLIENT_CERTIFICATE", "false"
39
+ ).lower()
40
+ if use_client_cert not in ("true", "false"):
41
+ raise ValueError(
42
+ "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be"
43
+ " either `true` or `false`"
44
+ )
45
+ return use_client_cert == "true"
46
+
47
+
48
+ def read_environment_variables():
49
+ """Returns the environment variables used by the client.
50
+
51
+ Returns:
52
+ Tuple[bool, str, str]: returns the GOOGLE_API_USE_CLIENT_CERTIFICATE,
53
+ GOOGLE_API_USE_MTLS_ENDPOINT, and GOOGLE_CLOUD_UNIVERSE_DOMAIN environment variables.
54
+
55
+ Raises:
56
+ ValueError: If GOOGLE_API_USE_CLIENT_CERTIFICATE is not
57
+ any of ["true", "false"].
58
+ google.auth.exceptions.MutualTLSChannelError: If GOOGLE_API_USE_MTLS_ENDPOINT
59
+ is not any of ["auto", "never", "always"].
60
+ """
61
+ use_client_cert = should_use_client_cert()
62
+ use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto").lower()
63
+ universe_domain_env = os.getenv("GOOGLE_CLOUD_UNIVERSE_DOMAIN")
64
+ if use_mtls_endpoint not in ("auto", "never", "always"):
65
+ raise MutualTLSChannelError(
66
+ "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`,"
67
+ " `auto` or `always`"
68
+ )
69
+ return use_client_cert, use_mtls_endpoint, universe_domain_env
70
+
71
+
72
+ DEFAULT_UNIVERSE = "googleapis.com"
73
+
74
+ try:
75
+ from google.api_core.universe import get_default_mtls_endpoint
76
+ except ImportError: # pragma: NO COVER
77
+
78
+ def get_default_mtls_endpoint(api_endpoint: Optional[str]) -> Optional[str]:
79
+ """Converts api endpoint to mTLS endpoint.
80
+
81
+ Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to
82
+ "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively.
83
+ Other URLs (including those that do not match these domain suffixes or
84
+ already contain '.mtls.') are passed through as-is.
85
+
86
+ Args:
87
+ api_endpoint (Optional[str]): the api endpoint to convert.
88
+
89
+ Returns:
90
+ Optional[str]: converted mTLS api endpoint.
91
+ """
92
+ if not api_endpoint or ".mtls." in api_endpoint.lower():
93
+ return api_endpoint
94
+
95
+ has_scheme = "://" in api_endpoint
96
+ if not has_scheme:
97
+ parsed = urlparse("//" + api_endpoint)
98
+ else:
99
+ parsed = urlparse(api_endpoint)
100
+
101
+ host = parsed.hostname
102
+ if not host:
103
+ return api_endpoint
104
+
105
+ port = f":{parsed.port}" if parsed.port else ""
106
+
107
+ lowered_host = host.lower()
108
+ suffix_sandbox = ".sandbox.googleapis.com"
109
+ suffix_google = ".googleapis.com"
110
+ if lowered_host.endswith(suffix_sandbox):
111
+ new_host = host[: -len(suffix_sandbox)] + ".mtls.sandbox.googleapis.com"
112
+ elif lowered_host.endswith(suffix_google):
113
+ new_host = host[: -len(suffix_google)] + ".mtls.googleapis.com"
114
+ else:
115
+ return api_endpoint
116
+
117
+ netloc = new_host + port
118
+ new_parsed = parsed._replace(netloc=netloc)
119
+
120
+ if not has_scheme:
121
+ return urlunparse(new_parsed)[2:]
122
+ else:
123
+ return urlunparse(new_parsed)
124
+
125
+
126
+ try:
127
+ from google.api_core.universe import get_api_endpoint
128
+ except ImportError: # pragma: NO COVER
129
+
130
+ def get_api_endpoint(
131
+ api_override: Optional[str],
132
+ universe_domain: str,
133
+ default_universe: str,
134
+ default_mtls_endpoint: Optional[str],
135
+ default_endpoint_template: str,
136
+ use_mtls: bool,
137
+ ) -> str:
138
+ """Return the API endpoint used by the client.
139
+
140
+ Args:
141
+ api_override (Optional[str]): The API endpoint override. If specified,
142
+ this is always returned.
143
+ universe_domain (str): The universe domain used by the client.
144
+ default_universe (str): The default universe domain.
145
+ default_mtls_endpoint (Optional[str]): The default mTLS endpoint.
146
+ default_endpoint_template (str): The default endpoint template containing
147
+ a placeholder `{UNIVERSE_DOMAIN}`.
148
+ use_mtls (bool): Whether to use the mTLS endpoint.
149
+
150
+ Returns:
151
+ str: The API endpoint to be used by the client.
152
+
153
+ Raises:
154
+ google.auth.exceptions.MutualTLSChannelError: If mTLS is requested but
155
+ not supported in the configured universe domain.
156
+ ValueError: If mTLS is requested but no mTLS endpoint is available.
157
+ """
158
+ if api_override is not None:
159
+ return api_override
160
+
161
+ if use_mtls:
162
+ if universe_domain.lower() != default_universe.lower():
163
+ raise MutualTLSChannelError(
164
+ f"mTLS is not supported in any universe other than {default_universe}."
165
+ )
166
+ if not default_mtls_endpoint:
167
+ raise ValueError("mTLS endpoint is not available.")
168
+ return default_mtls_endpoint
169
+ else:
170
+ return default_endpoint_template.format(UNIVERSE_DOMAIN=universe_domain)
171
+
172
+
173
+ try:
174
+ from google.api_core.universe import get_universe_domain
175
+ except ImportError: # pragma: NO COVER
176
+
177
+ def get_universe_domain(
178
+ *potential_universes: Optional[str],
179
+ default_universe: str,
180
+ ) -> str:
181
+ """Return the universe domain used by the client.
182
+
183
+ Args:
184
+ *potential_universes (Optional[str]): Potential universe domains in order of preference.
185
+ default_universe (str): The default universe domain.
186
+
187
+ Returns:
188
+ str: The universe domain to be used by the client.
189
+
190
+ Raises:
191
+ EmptyUniverseError: If the resolved universe domain is an empty string.
192
+ """
193
+ resolved = next(
194
+ (x.strip() for x in potential_universes if x is not None),
195
+ default_universe,
196
+ )
197
+
198
+ if not resolved:
199
+ raise EmptyUniverseError()
200
+ return resolved
201
+
202
+
203
+ try:
204
+ from google.api_core.rest_helpers import transcode_request # type: ignore
205
+ except ImportError: # pragma: NO COVER
206
+
207
+ def transcode_request(
208
+ http_options: List[Dict[str, str]],
209
+ request: Any,
210
+ required_fields_default_values: Optional[Dict[str, Any]] = None,
211
+ rest_numeric_enums: bool = False,
212
+ ) -> Tuple[Dict[str, Any], Optional[str], Dict[str, Any]]:
213
+ """Transcodes a request into HTTP method, URI, body, and query parameters.
214
+
215
+ Args:
216
+ http_options (List[Dict[str, str]]): List of HTTP transcoding rules.
217
+ request (Any): The protobuf or proto-plus request message.
218
+ required_fields_default_values (Optional[Dict[str, Any]]): Dictionary
219
+ of required fields default values to merge into query parameters if missing.
220
+ rest_numeric_enums (bool): Whether to encode enums as integers.
221
+
222
+ Returns:
223
+ Tuple[Dict[str, Any], Optional[str], Dict[str, Any]]: A tuple containing:
224
+ - The raw transcoded request dictionary (containing keys like 'uri', 'method').
225
+ - The serialized request body JSON string, or None if no body.
226
+ - The query parameters dictionary.
227
+ """
228
+ if request is None:
229
+ raise TypeError("request cannot be None")
230
+
231
+ # Convert proto-plus message to its underlying protobuf message if needed
232
+ pb_request = getattr(request, "_pb", request)
233
+
234
+ transcoded_request = path_template.transcode(http_options, pb_request)
235
+
236
+ body_json = None
237
+ if transcoded_request.get("body") is not None:
238
+ body_json = json_format.MessageToJson(
239
+ transcoded_request["body"],
240
+ use_integers_for_enums=rest_numeric_enums,
241
+ )
242
+
243
+ query_params_json = {}
244
+ if transcoded_request.get("query_params") is not None:
245
+ query_params_json = json.loads(
246
+ json_format.MessageToJson(
247
+ transcoded_request["query_params"],
248
+ use_integers_for_enums=rest_numeric_enums,
249
+ )
250
+ )
251
+
252
+ # If required_fields_default_values is provided, we merge default values for missing
253
+ # required fields into the query parameters.
254
+ if required_fields_default_values:
255
+ for k, v in required_fields_default_values.items():
256
+ if k not in query_params_json:
257
+ query_params_json[k] = v
258
+
259
+ if rest_numeric_enums:
260
+ query_params_json["$alt"] = "json;enum-encoding=int"
261
+
262
+ return transcoded_request, body_json, query_params_json
@@ -13,4 +13,4 @@
13
13
  # See the License for the specific language governing permissions and
14
14
  # limitations under the License.
15
15
  #
16
- __version__ = "0.1.1" # {x-release-please-version}
16
+ __version__ = "0.1.3" # {x-release-please-version}
@@ -474,6 +474,10 @@ class DeveloperKnowledgeAsyncClient:
474
474
  Example:
475
475
  ``documents/docs.cloud.google.com/storage/docs/creating-buckets``
476
476
 
477
+ The name must not exceed 500 characters; values longer
478
+ than 500 characters will result in an
479
+ ``INVALID_ARGUMENT`` error.
480
+
477
481
  This corresponds to the ``name`` field
478
482
  on the ``request`` instance; if ``request`` is provided, this
479
483
  should not be set.
@@ -487,9 +491,10 @@ class DeveloperKnowledgeAsyncClient:
487
491
 
488
492
  Returns:
489
493
  google.developer_knowledge_v1.types.Document:
490
- A Document represents a piece of
491
- content from the Developer Knowledge
492
- corpus.
494
+ A Document represents a page of
495
+ documentation in the Developer Knowledge
496
+ corpus, like the page at
497
+ https://docs.cloud.google.com/storage/docs/creating-buckets.
493
498
 
494
499
  """
495
500
  # Create or coerce a protobuf request object.
@@ -46,6 +46,13 @@ from google.auth.transport.grpc import SslCredentials # type: ignore
46
46
  from google.oauth2 import service_account # type: ignore
47
47
 
48
48
  from google.developer_knowledge_v1 import gapic_version as package_version
49
+ from google.developer_knowledge_v1._compat import (
50
+ get_api_endpoint,
51
+ get_default_mtls_endpoint,
52
+ get_universe_domain,
53
+ read_environment_variables,
54
+ should_use_client_cert,
55
+ )
49
56
 
50
57
  try:
51
58
  OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None]
@@ -126,77 +133,13 @@ class DeveloperKnowledgeClient(metaclass=DeveloperKnowledgeClientMeta):
126
133
  All document content is provided in Markdown format.
127
134
  """
128
135
 
129
- @staticmethod
130
- def _get_default_mtls_endpoint(api_endpoint) -> Optional[str]:
131
- """Converts api endpoint to mTLS endpoint.
132
-
133
- Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to
134
- "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively.
135
- Args:
136
- api_endpoint (Optional[str]): the api endpoint to convert.
137
- Returns:
138
- Optional[str]: converted mTLS api endpoint.
139
- """
140
- if not api_endpoint:
141
- return api_endpoint
142
-
143
- mtls_endpoint_re = re.compile(
144
- r"(?P<name>[^.]+)(?P<mtls>\.mtls)?(?P<sandbox>\.sandbox)?(?P<googledomain>\.googleapis\.com)?"
145
- )
146
-
147
- m = mtls_endpoint_re.match(api_endpoint)
148
- if m is None:
149
- # Could not parse api_endpoint; return as-is.
150
- return api_endpoint
151
-
152
- name, mtls, sandbox, googledomain = m.groups()
153
- if mtls or not googledomain:
154
- return api_endpoint
155
-
156
- if sandbox:
157
- return api_endpoint.replace(
158
- "sandbox.googleapis.com", "mtls.sandbox.googleapis.com"
159
- )
160
-
161
- return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com")
162
-
163
136
  # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead.
164
137
  DEFAULT_ENDPOINT = "developerknowledge.googleapis.com"
165
- DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore
166
- DEFAULT_ENDPOINT
167
- )
138
+ DEFAULT_MTLS_ENDPOINT = get_default_mtls_endpoint(DEFAULT_ENDPOINT)
168
139
 
169
140
  _DEFAULT_ENDPOINT_TEMPLATE = "developerknowledge.{UNIVERSE_DOMAIN}"
170
141
  _DEFAULT_UNIVERSE = "googleapis.com"
171
142
 
172
- @staticmethod
173
- def _use_client_cert_effective():
174
- """Returns whether client certificate should be used for mTLS if the
175
- google-auth version supports should_use_client_cert automatic mTLS enablement.
176
-
177
- Alternatively, read from the GOOGLE_API_USE_CLIENT_CERTIFICATE env var.
178
-
179
- Returns:
180
- bool: whether client certificate should be used for mTLS
181
- Raises:
182
- ValueError: (If using a version of google-auth without should_use_client_cert and
183
- GOOGLE_API_USE_CLIENT_CERTIFICATE is set to an unexpected value.)
184
- """
185
- # check if google-auth version supports should_use_client_cert for automatic mTLS enablement
186
- if hasattr(mtls, "should_use_client_cert"): # pragma: NO COVER
187
- return mtls.should_use_client_cert()
188
- else: # pragma: NO COVER
189
- # if unsupported, fallback to reading from env var
190
- use_client_cert_str = os.getenv(
191
- "GOOGLE_API_USE_CLIENT_CERTIFICATE", "false"
192
- ).lower()
193
- if use_client_cert_str not in ("true", "false"):
194
- raise ValueError(
195
- "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be"
196
- " either `true` or `false`"
197
- )
198
- return use_client_cert_str == "true"
199
-
200
143
  @classmethod
201
144
  def from_service_account_info(cls, info: dict, *args, **kwargs):
202
145
  """Creates an instance of this client using the provided credentials
@@ -377,7 +320,7 @@ class DeveloperKnowledgeClient(metaclass=DeveloperKnowledgeClientMeta):
377
320
  )
378
321
  if client_options is None:
379
322
  client_options = client_options_lib.ClientOptions()
380
- use_client_cert = DeveloperKnowledgeClient._use_client_cert_effective()
323
+ use_client_cert = should_use_client_cert()
381
324
  use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto")
382
325
  if use_mtls_endpoint not in ("auto", "never", "always"):
383
326
  raise MutualTLSChannelError(
@@ -398,35 +341,12 @@ class DeveloperKnowledgeClient(metaclass=DeveloperKnowledgeClientMeta):
398
341
  elif use_mtls_endpoint == "always" or (
399
342
  use_mtls_endpoint == "auto" and client_cert_source
400
343
  ):
401
- api_endpoint = cls.DEFAULT_MTLS_ENDPOINT
344
+ api_endpoint = cls.DEFAULT_MTLS_ENDPOINT # type: ignore
402
345
  else:
403
346
  api_endpoint = cls.DEFAULT_ENDPOINT
404
347
 
405
348
  return api_endpoint, client_cert_source
406
349
 
407
- @staticmethod
408
- def _read_environment_variables():
409
- """Returns the environment variables used by the client.
410
-
411
- Returns:
412
- Tuple[bool, str, str]: returns the GOOGLE_API_USE_CLIENT_CERTIFICATE,
413
- GOOGLE_API_USE_MTLS_ENDPOINT, and GOOGLE_CLOUD_UNIVERSE_DOMAIN environment variables.
414
-
415
- Raises:
416
- ValueError: If GOOGLE_API_USE_CLIENT_CERTIFICATE is not
417
- any of ["true", "false"].
418
- google.auth.exceptions.MutualTLSChannelError: If GOOGLE_API_USE_MTLS_ENDPOINT
419
- is not any of ["auto", "never", "always"].
420
- """
421
- use_client_cert = DeveloperKnowledgeClient._use_client_cert_effective()
422
- use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto").lower()
423
- universe_domain_env = os.getenv("GOOGLE_CLOUD_UNIVERSE_DOMAIN")
424
- if use_mtls_endpoint not in ("auto", "never", "always"):
425
- raise MutualTLSChannelError(
426
- "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`"
427
- )
428
- return use_client_cert, use_mtls_endpoint, universe_domain_env
429
-
430
350
  @staticmethod
431
351
  def _get_client_cert_source(provided_cert_source, use_cert_flag):
432
352
  """Return the client cert source to be used by the client.
@@ -446,65 +366,6 @@ class DeveloperKnowledgeClient(metaclass=DeveloperKnowledgeClientMeta):
446
366
  client_cert_source = mtls.default_client_cert_source()
447
367
  return client_cert_source
448
368
 
449
- @staticmethod
450
- def _get_api_endpoint(
451
- api_override, client_cert_source, universe_domain, use_mtls_endpoint
452
- ) -> str:
453
- """Return the API endpoint used by the client.
454
-
455
- Args:
456
- api_override (str): The API endpoint override. If specified, this is always
457
- the return value of this function and the other arguments are not used.
458
- client_cert_source (bytes): The client certificate source used by the client.
459
- universe_domain (str): The universe domain used by the client.
460
- use_mtls_endpoint (str): How to use the mTLS endpoint, which depends also on the other parameters.
461
- Possible values are "always", "auto", or "never".
462
-
463
- Returns:
464
- str: The API endpoint to be used by the client.
465
- """
466
- if api_override is not None:
467
- api_endpoint = api_override
468
- elif use_mtls_endpoint == "always" or (
469
- use_mtls_endpoint == "auto" and client_cert_source
470
- ):
471
- _default_universe = DeveloperKnowledgeClient._DEFAULT_UNIVERSE
472
- if universe_domain != _default_universe:
473
- raise MutualTLSChannelError(
474
- f"mTLS is not supported in any universe other than {_default_universe}."
475
- )
476
- api_endpoint = DeveloperKnowledgeClient.DEFAULT_MTLS_ENDPOINT
477
- else:
478
- api_endpoint = DeveloperKnowledgeClient._DEFAULT_ENDPOINT_TEMPLATE.format(
479
- UNIVERSE_DOMAIN=universe_domain
480
- )
481
- return api_endpoint
482
-
483
- @staticmethod
484
- def _get_universe_domain(
485
- client_universe_domain: Optional[str], universe_domain_env: Optional[str]
486
- ) -> str:
487
- """Return the universe domain used by the client.
488
-
489
- Args:
490
- client_universe_domain (Optional[str]): The universe domain configured via the client options.
491
- universe_domain_env (Optional[str]): The universe domain configured via the "GOOGLE_CLOUD_UNIVERSE_DOMAIN" environment variable.
492
-
493
- Returns:
494
- str: The universe domain to be used by the client.
495
-
496
- Raises:
497
- ValueError: If the universe domain is an empty string.
498
- """
499
- universe_domain = DeveloperKnowledgeClient._DEFAULT_UNIVERSE
500
- if client_universe_domain is not None:
501
- universe_domain = client_universe_domain
502
- elif universe_domain_env is not None:
503
- universe_domain = universe_domain_env
504
- if len(universe_domain.strip()) == 0:
505
- raise ValueError("Universe Domain cannot be an empty string.")
506
- return universe_domain
507
-
508
369
  def _validate_universe_domain(self):
509
370
  """Validates client's and credentials' universe domains are consistent.
510
371
 
@@ -638,13 +499,15 @@ class DeveloperKnowledgeClient(metaclass=DeveloperKnowledgeClientMeta):
638
499
  universe_domain_opt = getattr(self._client_options, "universe_domain", None)
639
500
 
640
501
  self._use_client_cert, self._use_mtls_endpoint, self._universe_domain_env = (
641
- DeveloperKnowledgeClient._read_environment_variables()
502
+ read_environment_variables()
642
503
  )
643
504
  self._client_cert_source = DeveloperKnowledgeClient._get_client_cert_source(
644
505
  self._client_options.client_cert_source, self._use_client_cert
645
506
  )
646
- self._universe_domain = DeveloperKnowledgeClient._get_universe_domain(
647
- universe_domain_opt, self._universe_domain_env
507
+ self._universe_domain = get_universe_domain(
508
+ universe_domain_opt,
509
+ self._universe_domain_env,
510
+ default_universe=DeveloperKnowledgeClient._DEFAULT_UNIVERSE,
648
511
  )
649
512
  self._api_endpoint: str = "" # updated below, depending on `transport`
650
513
 
@@ -679,14 +542,14 @@ class DeveloperKnowledgeClient(metaclass=DeveloperKnowledgeClientMeta):
679
542
  self._transport = cast(DeveloperKnowledgeTransport, transport)
680
543
  self._api_endpoint = self._transport.host
681
544
 
682
- self._api_endpoint = (
683
- self._api_endpoint
684
- or DeveloperKnowledgeClient._get_api_endpoint(
685
- self._client_options.api_endpoint,
686
- self._client_cert_source,
687
- self._universe_domain,
688
- self._use_mtls_endpoint,
689
- )
545
+ self._api_endpoint = self._api_endpoint or get_api_endpoint(
546
+ api_override=self._client_options.api_endpoint,
547
+ universe_domain=self._universe_domain,
548
+ default_universe=DeveloperKnowledgeClient._DEFAULT_UNIVERSE,
549
+ default_mtls_endpoint=DeveloperKnowledgeClient.DEFAULT_MTLS_ENDPOINT,
550
+ default_endpoint_template=DeveloperKnowledgeClient._DEFAULT_ENDPOINT_TEMPLATE,
551
+ use_mtls=self._use_mtls_endpoint == "always"
552
+ or (self._use_mtls_endpoint == "auto" and self._client_cert_source),
690
553
  )
691
554
 
692
555
  if not transport_provided:
@@ -898,6 +761,10 @@ class DeveloperKnowledgeClient(metaclass=DeveloperKnowledgeClientMeta):
898
761
  Example:
899
762
  ``documents/docs.cloud.google.com/storage/docs/creating-buckets``
900
763
 
764
+ The name must not exceed 500 characters; values longer
765
+ than 500 characters will result in an
766
+ ``INVALID_ARGUMENT`` error.
767
+
901
768
  This corresponds to the ``name`` field
902
769
  on the ``request`` instance; if ``request`` is provided, this
903
770
  should not be set.
@@ -911,9 +778,10 @@ class DeveloperKnowledgeClient(metaclass=DeveloperKnowledgeClientMeta):
911
778
 
912
779
  Returns:
913
780
  google.developer_knowledge_v1.types.Document:
914
- A Document represents a piece of
915
- content from the Developer Knowledge
916
- corpus.
781
+ A Document represents a page of
782
+ documentation in the Developer Knowledge
783
+ corpus, like the page at
784
+ https://docs.cloud.google.com/storage/docs/creating-buckets.
917
785
 
918
786
  """
919
787
  # Create or coerce a protobuf request object.