google-cloud-maintenance-api 0.4.1__tar.gz → 0.4.2__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 (63) hide show
  1. {google_cloud_maintenance_api-0.4.1/google_cloud_maintenance_api.egg-info → google_cloud_maintenance_api-0.4.2}/PKG-INFO +5 -5
  2. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/google/cloud/maintenance_api/gapic_version.py +1 -1
  3. google_cloud_maintenance_api-0.4.2/google/cloud/maintenance_api_v1/__init__.py +62 -0
  4. google_cloud_maintenance_api-0.4.2/google/cloud/maintenance_api_v1/_compat.py +262 -0
  5. {google_cloud_maintenance_api-0.4.1/google/cloud/maintenance_api_v1beta → google_cloud_maintenance_api-0.4.2/google/cloud/maintenance_api_v1}/gapic_version.py +1 -1
  6. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/google/cloud/maintenance_api_v1/services/maintenance/async_client.py +1 -3
  7. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/google/cloud/maintenance_api_v1/services/maintenance/client.py +24 -160
  8. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/google/cloud/maintenance_api_v1/services/maintenance/transports/base.py +1 -3
  9. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/google/cloud/maintenance_api_v1/services/maintenance/transports/rest.py +47 -48
  10. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/google/cloud/maintenance_api_v1/services/maintenance/transports/rest_base.py +0 -115
  11. google_cloud_maintenance_api-0.4.2/google/cloud/maintenance_api_v1beta/__init__.py +62 -0
  12. google_cloud_maintenance_api-0.4.2/google/cloud/maintenance_api_v1beta/_compat.py +262 -0
  13. {google_cloud_maintenance_api-0.4.1/google/cloud/maintenance_api_v1 → google_cloud_maintenance_api-0.4.2/google/cloud/maintenance_api_v1beta}/gapic_version.py +1 -1
  14. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/google/cloud/maintenance_api_v1beta/services/maintenance/async_client.py +1 -3
  15. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/google/cloud/maintenance_api_v1beta/services/maintenance/client.py +24 -160
  16. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/google/cloud/maintenance_api_v1beta/services/maintenance/transports/base.py +1 -3
  17. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/google/cloud/maintenance_api_v1beta/services/maintenance/transports/rest.py +47 -48
  18. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/google/cloud/maintenance_api_v1beta/services/maintenance/transports/rest_base.py +0 -115
  19. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2/google_cloud_maintenance_api.egg-info}/PKG-INFO +5 -5
  20. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/google_cloud_maintenance_api.egg-info/SOURCES.txt +4 -0
  21. google_cloud_maintenance_api-0.4.2/google_cloud_maintenance_api.egg-info/requires.txt +8 -0
  22. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/setup.py +8 -5
  23. google_cloud_maintenance_api-0.4.2/tests/unit/gapic/maintenance_api_v1/test_compat.py +429 -0
  24. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/tests/unit/gapic/maintenance_api_v1/test_maintenance.py +76 -352
  25. google_cloud_maintenance_api-0.4.2/tests/unit/gapic/maintenance_api_v1beta/test_compat.py +429 -0
  26. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/tests/unit/gapic/maintenance_api_v1beta/test_maintenance.py +76 -352
  27. google_cloud_maintenance_api-0.4.1/google/cloud/maintenance_api_v1/__init__.py +0 -134
  28. google_cloud_maintenance_api-0.4.1/google/cloud/maintenance_api_v1beta/__init__.py +0 -134
  29. google_cloud_maintenance_api-0.4.1/google_cloud_maintenance_api.egg-info/requires.txt +0 -11
  30. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/LICENSE +0 -0
  31. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/MANIFEST.in +0 -0
  32. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/README.rst +0 -0
  33. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/google/cloud/maintenance_api/__init__.py +0 -0
  34. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/google/cloud/maintenance_api/py.typed +0 -0
  35. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/google/cloud/maintenance_api_v1/gapic_metadata.json +0 -0
  36. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/google/cloud/maintenance_api_v1/py.typed +0 -0
  37. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/google/cloud/maintenance_api_v1/services/__init__.py +0 -0
  38. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/google/cloud/maintenance_api_v1/services/maintenance/__init__.py +0 -0
  39. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/google/cloud/maintenance_api_v1/services/maintenance/pagers.py +0 -0
  40. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/google/cloud/maintenance_api_v1/services/maintenance/transports/__init__.py +0 -0
  41. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/google/cloud/maintenance_api_v1/services/maintenance/transports/grpc.py +0 -0
  42. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/google/cloud/maintenance_api_v1/services/maintenance/transports/grpc_asyncio.py +0 -0
  43. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/google/cloud/maintenance_api_v1/types/__init__.py +0 -0
  44. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/google/cloud/maintenance_api_v1/types/maintenance_service.py +0 -0
  45. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/google/cloud/maintenance_api_v1beta/gapic_metadata.json +0 -0
  46. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/google/cloud/maintenance_api_v1beta/py.typed +0 -0
  47. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/google/cloud/maintenance_api_v1beta/services/__init__.py +0 -0
  48. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/google/cloud/maintenance_api_v1beta/services/maintenance/__init__.py +0 -0
  49. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/google/cloud/maintenance_api_v1beta/services/maintenance/pagers.py +0 -0
  50. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/google/cloud/maintenance_api_v1beta/services/maintenance/transports/__init__.py +0 -0
  51. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/google/cloud/maintenance_api_v1beta/services/maintenance/transports/grpc.py +0 -0
  52. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/google/cloud/maintenance_api_v1beta/services/maintenance/transports/grpc_asyncio.py +0 -0
  53. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/google/cloud/maintenance_api_v1beta/types/__init__.py +0 -0
  54. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/google/cloud/maintenance_api_v1beta/types/maintenance_service.py +0 -0
  55. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/google_cloud_maintenance_api.egg-info/dependency_links.txt +0 -0
  56. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/google_cloud_maintenance_api.egg-info/not-zip-safe +0 -0
  57. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/google_cloud_maintenance_api.egg-info/top_level.txt +0 -0
  58. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/setup.cfg +0 -0
  59. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/tests/__init__.py +0 -0
  60. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/tests/unit/__init__.py +0 -0
  61. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/tests/unit/gapic/__init__.py +0 -0
  62. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/tests/unit/gapic/maintenance_api_v1/__init__.py +0 -0
  63. {google_cloud_maintenance_api-0.4.1 → google_cloud_maintenance_api-0.4.2}/tests/unit/gapic/maintenance_api_v1beta/__init__.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: google-cloud-maintenance-api
3
- Version: 0.4.1
3
+ Version: 0.4.2
4
4
  Summary: Google Cloud Maintenance Api API client library
5
5
  Home-page: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-maintenance-api
6
6
  Author: Google LLC
@@ -17,17 +17,17 @@ 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.17.1
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"
28
- Requires-Dist: proto-plus<2.0.0,>=1.22.3
29
- Requires-Dist: proto-plus<2.0.0,>=1.25.0; python_version >= "3.13"
30
- Requires-Dist: protobuf<8.0.0,>=4.25.8
29
+ Requires-Dist: proto-plus<2.0.0,>=1.26.1
30
+ Requires-Dist: protobuf<8.0.0,>=6.33.5
31
31
  Dynamic: author
32
32
  Dynamic: author-email
33
33
  Dynamic: classifier
@@ -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.4.1" # {x-release-please-version}
16
+ __version__ = "0.4.2" # {x-release-please-version}
@@ -0,0 +1,62 @@
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.cloud.maintenance_api_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.cloud.maintenance_api_v1.services.maintenance",
30
+ "google.cloud.maintenance_api_v1.types.maintenance_service",
31
+ }
32
+
33
+
34
+ from .services.maintenance import MaintenanceAsyncClient, MaintenanceClient
35
+ from .types.maintenance_service import (
36
+ GetResourceMaintenanceRequest,
37
+ ListResourceMaintenancesRequest,
38
+ ListResourceMaintenancesResponse,
39
+ MaintenanceCategory,
40
+ MaintenanceControl,
41
+ MaintenanceSummary,
42
+ ResourceMaintenance,
43
+ SummarizeMaintenancesRequest,
44
+ SummarizeMaintenancesResponse,
45
+ )
46
+
47
+ __all__ = (
48
+ "MaintenanceAsyncClient",
49
+ "GetResourceMaintenanceRequest",
50
+ "ListResourceMaintenancesRequest",
51
+ "ListResourceMaintenancesResponse",
52
+ "MaintenanceCategory",
53
+ "MaintenanceClient",
54
+ "MaintenanceControl",
55
+ "MaintenanceSummary",
56
+ "ResourceMaintenance",
57
+ "SummarizeMaintenancesRequest",
58
+ "SummarizeMaintenancesResponse",
59
+ )
60
+
61
+ api_core.check_python_version("google.cloud.maintenance_api_v1")
62
+ api_core.check_dependency_versions("google.cloud.maintenance_api_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.4.1" # {x-release-please-version}
16
+ __version__ = "0.4.2" # {x-release-please-version}
@@ -794,9 +794,7 @@ class MaintenanceAsyncClient:
794
794
  DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
795
795
  gapic_version=package_version.__version__
796
796
  )
797
-
798
- if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER
799
- DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__
797
+ DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__
800
798
 
801
799
 
802
800
  __all__ = ("MaintenanceAsyncClient",)
@@ -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.cloud.maintenance_api_v1 import gapic_version as package_version
49
+ from google.cloud.maintenance_api_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]
@@ -111,77 +118,13 @@ class MaintenanceClientMeta(type):
111
118
  class MaintenanceClient(metaclass=MaintenanceClientMeta):
112
119
  """Unified Maintenance service"""
113
120
 
114
- @staticmethod
115
- def _get_default_mtls_endpoint(api_endpoint) -> Optional[str]:
116
- """Converts api endpoint to mTLS endpoint.
117
-
118
- Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to
119
- "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively.
120
- Args:
121
- api_endpoint (Optional[str]): the api endpoint to convert.
122
- Returns:
123
- Optional[str]: converted mTLS api endpoint.
124
- """
125
- if not api_endpoint:
126
- return api_endpoint
127
-
128
- mtls_endpoint_re = re.compile(
129
- r"(?P<name>[^.]+)(?P<mtls>\.mtls)?(?P<sandbox>\.sandbox)?(?P<googledomain>\.googleapis\.com)?"
130
- )
131
-
132
- m = mtls_endpoint_re.match(api_endpoint)
133
- if m is None:
134
- # Could not parse api_endpoint; return as-is.
135
- return api_endpoint
136
-
137
- name, mtls, sandbox, googledomain = m.groups()
138
- if mtls or not googledomain:
139
- return api_endpoint
140
-
141
- if sandbox:
142
- return api_endpoint.replace(
143
- "sandbox.googleapis.com", "mtls.sandbox.googleapis.com"
144
- )
145
-
146
- return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com")
147
-
148
121
  # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead.
149
122
  DEFAULT_ENDPOINT = "maintenance.googleapis.com"
150
- DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore
151
- DEFAULT_ENDPOINT
152
- )
123
+ DEFAULT_MTLS_ENDPOINT = get_default_mtls_endpoint(DEFAULT_ENDPOINT)
153
124
 
154
125
  _DEFAULT_ENDPOINT_TEMPLATE = "maintenance.{UNIVERSE_DOMAIN}"
155
126
  _DEFAULT_UNIVERSE = "googleapis.com"
156
127
 
157
- @staticmethod
158
- def _use_client_cert_effective():
159
- """Returns whether client certificate should be used for mTLS if the
160
- google-auth version supports should_use_client_cert automatic mTLS enablement.
161
-
162
- Alternatively, read from the GOOGLE_API_USE_CLIENT_CERTIFICATE env var.
163
-
164
- Returns:
165
- bool: whether client certificate should be used for mTLS
166
- Raises:
167
- ValueError: (If using a version of google-auth without should_use_client_cert and
168
- GOOGLE_API_USE_CLIENT_CERTIFICATE is set to an unexpected value.)
169
- """
170
- # check if google-auth version supports should_use_client_cert for automatic mTLS enablement
171
- if hasattr(mtls, "should_use_client_cert"): # pragma: NO COVER
172
- return mtls.should_use_client_cert()
173
- else: # pragma: NO COVER
174
- # if unsupported, fallback to reading from env var
175
- use_client_cert_str = os.getenv(
176
- "GOOGLE_API_USE_CLIENT_CERTIFICATE", "false"
177
- ).lower()
178
- if use_client_cert_str not in ("true", "false"):
179
- raise ValueError(
180
- "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be"
181
- " either `true` or `false`"
182
- )
183
- return use_client_cert_str == "true"
184
-
185
128
  @classmethod
186
129
  def from_service_account_info(cls, info: dict, *args, **kwargs):
187
130
  """Creates an instance of this client using the provided credentials
@@ -369,7 +312,7 @@ class MaintenanceClient(metaclass=MaintenanceClientMeta):
369
312
  )
370
313
  if client_options is None:
371
314
  client_options = client_options_lib.ClientOptions()
372
- use_client_cert = MaintenanceClient._use_client_cert_effective()
315
+ use_client_cert = should_use_client_cert()
373
316
  use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto")
374
317
  if use_mtls_endpoint not in ("auto", "never", "always"):
375
318
  raise MutualTLSChannelError(
@@ -390,35 +333,12 @@ class MaintenanceClient(metaclass=MaintenanceClientMeta):
390
333
  elif use_mtls_endpoint == "always" or (
391
334
  use_mtls_endpoint == "auto" and client_cert_source
392
335
  ):
393
- api_endpoint = cls.DEFAULT_MTLS_ENDPOINT
336
+ api_endpoint = cls.DEFAULT_MTLS_ENDPOINT # type: ignore
394
337
  else:
395
338
  api_endpoint = cls.DEFAULT_ENDPOINT
396
339
 
397
340
  return api_endpoint, client_cert_source
398
341
 
399
- @staticmethod
400
- def _read_environment_variables():
401
- """Returns the environment variables used by the client.
402
-
403
- Returns:
404
- Tuple[bool, str, str]: returns the GOOGLE_API_USE_CLIENT_CERTIFICATE,
405
- GOOGLE_API_USE_MTLS_ENDPOINT, and GOOGLE_CLOUD_UNIVERSE_DOMAIN environment variables.
406
-
407
- Raises:
408
- ValueError: If GOOGLE_API_USE_CLIENT_CERTIFICATE is not
409
- any of ["true", "false"].
410
- google.auth.exceptions.MutualTLSChannelError: If GOOGLE_API_USE_MTLS_ENDPOINT
411
- is not any of ["auto", "never", "always"].
412
- """
413
- use_client_cert = MaintenanceClient._use_client_cert_effective()
414
- use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto").lower()
415
- universe_domain_env = os.getenv("GOOGLE_CLOUD_UNIVERSE_DOMAIN")
416
- if use_mtls_endpoint not in ("auto", "never", "always"):
417
- raise MutualTLSChannelError(
418
- "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`"
419
- )
420
- return use_client_cert, use_mtls_endpoint, universe_domain_env
421
-
422
342
  @staticmethod
423
343
  def _get_client_cert_source(provided_cert_source, use_cert_flag):
424
344
  """Return the client cert source to be used by the client.
@@ -438,65 +358,6 @@ class MaintenanceClient(metaclass=MaintenanceClientMeta):
438
358
  client_cert_source = mtls.default_client_cert_source()
439
359
  return client_cert_source
440
360
 
441
- @staticmethod
442
- def _get_api_endpoint(
443
- api_override, client_cert_source, universe_domain, use_mtls_endpoint
444
- ) -> str:
445
- """Return the API endpoint used by the client.
446
-
447
- Args:
448
- api_override (str): The API endpoint override. If specified, this is always
449
- the return value of this function and the other arguments are not used.
450
- client_cert_source (bytes): The client certificate source used by the client.
451
- universe_domain (str): The universe domain used by the client.
452
- use_mtls_endpoint (str): How to use the mTLS endpoint, which depends also on the other parameters.
453
- Possible values are "always", "auto", or "never".
454
-
455
- Returns:
456
- str: The API endpoint to be used by the client.
457
- """
458
- if api_override is not None:
459
- api_endpoint = api_override
460
- elif use_mtls_endpoint == "always" or (
461
- use_mtls_endpoint == "auto" and client_cert_source
462
- ):
463
- _default_universe = MaintenanceClient._DEFAULT_UNIVERSE
464
- if universe_domain != _default_universe:
465
- raise MutualTLSChannelError(
466
- f"mTLS is not supported in any universe other than {_default_universe}."
467
- )
468
- api_endpoint = MaintenanceClient.DEFAULT_MTLS_ENDPOINT
469
- else:
470
- api_endpoint = MaintenanceClient._DEFAULT_ENDPOINT_TEMPLATE.format(
471
- UNIVERSE_DOMAIN=universe_domain
472
- )
473
- return api_endpoint
474
-
475
- @staticmethod
476
- def _get_universe_domain(
477
- client_universe_domain: Optional[str], universe_domain_env: Optional[str]
478
- ) -> str:
479
- """Return the universe domain used by the client.
480
-
481
- Args:
482
- client_universe_domain (Optional[str]): The universe domain configured via the client options.
483
- universe_domain_env (Optional[str]): The universe domain configured via the "GOOGLE_CLOUD_UNIVERSE_DOMAIN" environment variable.
484
-
485
- Returns:
486
- str: The universe domain to be used by the client.
487
-
488
- Raises:
489
- ValueError: If the universe domain is an empty string.
490
- """
491
- universe_domain = MaintenanceClient._DEFAULT_UNIVERSE
492
- if client_universe_domain is not None:
493
- universe_domain = client_universe_domain
494
- elif universe_domain_env is not None:
495
- universe_domain = universe_domain_env
496
- if len(universe_domain.strip()) == 0:
497
- raise ValueError("Universe Domain cannot be an empty string.")
498
- return universe_domain
499
-
500
361
  def _validate_universe_domain(self):
501
362
  """Validates client's and credentials' universe domains are consistent.
502
363
 
@@ -626,13 +487,15 @@ class MaintenanceClient(metaclass=MaintenanceClientMeta):
626
487
  universe_domain_opt = getattr(self._client_options, "universe_domain", None)
627
488
 
628
489
  self._use_client_cert, self._use_mtls_endpoint, self._universe_domain_env = (
629
- MaintenanceClient._read_environment_variables()
490
+ read_environment_variables()
630
491
  )
631
492
  self._client_cert_source = MaintenanceClient._get_client_cert_source(
632
493
  self._client_options.client_cert_source, self._use_client_cert
633
494
  )
634
- self._universe_domain = MaintenanceClient._get_universe_domain(
635
- universe_domain_opt, self._universe_domain_env
495
+ self._universe_domain = get_universe_domain(
496
+ universe_domain_opt,
497
+ self._universe_domain_env,
498
+ default_universe=MaintenanceClient._DEFAULT_UNIVERSE,
636
499
  )
637
500
  self._api_endpoint: str = "" # updated below, depending on `transport`
638
501
 
@@ -667,11 +530,14 @@ class MaintenanceClient(metaclass=MaintenanceClientMeta):
667
530
  self._transport = cast(MaintenanceTransport, transport)
668
531
  self._api_endpoint = self._transport.host
669
532
 
670
- self._api_endpoint = self._api_endpoint or MaintenanceClient._get_api_endpoint(
671
- self._client_options.api_endpoint,
672
- self._client_cert_source,
673
- self._universe_domain,
674
- self._use_mtls_endpoint,
533
+ self._api_endpoint = self._api_endpoint or get_api_endpoint(
534
+ api_override=self._client_options.api_endpoint,
535
+ universe_domain=self._universe_domain,
536
+ default_universe=MaintenanceClient._DEFAULT_UNIVERSE,
537
+ default_mtls_endpoint=MaintenanceClient.DEFAULT_MTLS_ENDPOINT,
538
+ default_endpoint_template=MaintenanceClient._DEFAULT_ENDPOINT_TEMPLATE,
539
+ use_mtls=self._use_mtls_endpoint == "always"
540
+ or (self._use_mtls_endpoint == "auto" and self._client_cert_source),
675
541
  )
676
542
 
677
543
  if not transport_provided:
@@ -1233,8 +1099,6 @@ class MaintenanceClient(metaclass=MaintenanceClientMeta):
1233
1099
  DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
1234
1100
  gapic_version=package_version.__version__
1235
1101
  )
1236
-
1237
- if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER
1238
- DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__
1102
+ DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__
1239
1103
 
1240
1104
  __all__ = ("MaintenanceClient",)
@@ -32,9 +32,7 @@ from google.cloud.maintenance_api_v1.types import maintenance_service
32
32
  DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
33
33
  gapic_version=package_version.__version__
34
34
  )
35
-
36
- if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER
37
- DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__
35
+ DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__
38
36
 
39
37
 
40
38
  class MaintenanceTransport(abc.ABC):