google-cloud-storagebatchoperations 0.8.0__tar.gz → 0.8.1__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 (43) hide show
  1. {google_cloud_storagebatchoperations-0.8.0/google_cloud_storagebatchoperations.egg-info → google_cloud_storagebatchoperations-0.8.1}/PKG-INFO +5 -5
  2. {google_cloud_storagebatchoperations-0.8.0 → google_cloud_storagebatchoperations-0.8.1}/google/cloud/storagebatchoperations/gapic_version.py +1 -1
  3. google_cloud_storagebatchoperations-0.8.1/google/cloud/storagebatchoperations_v1/__init__.py +106 -0
  4. google_cloud_storagebatchoperations-0.8.1/google/cloud/storagebatchoperations_v1/_compat.py +262 -0
  5. {google_cloud_storagebatchoperations-0.8.0 → google_cloud_storagebatchoperations-0.8.1}/google/cloud/storagebatchoperations_v1/gapic_version.py +1 -1
  6. {google_cloud_storagebatchoperations-0.8.0 → google_cloud_storagebatchoperations-0.8.1}/google/cloud/storagebatchoperations_v1/services/storage_batch_operations/async_client.py +1 -3
  7. {google_cloud_storagebatchoperations-0.8.0 → google_cloud_storagebatchoperations-0.8.1}/google/cloud/storagebatchoperations_v1/services/storage_batch_operations/client.py +24 -165
  8. {google_cloud_storagebatchoperations-0.8.0 → google_cloud_storagebatchoperations-0.8.1}/google/cloud/storagebatchoperations_v1/services/storage_batch_operations/transports/base.py +1 -3
  9. {google_cloud_storagebatchoperations-0.8.0 → google_cloud_storagebatchoperations-0.8.1}/google/cloud/storagebatchoperations_v1/services/storage_batch_operations/transports/rest.py +119 -118
  10. google_cloud_storagebatchoperations-0.8.1/google/cloud/storagebatchoperations_v1/services/storage_batch_operations/transports/rest_base.py +298 -0
  11. {google_cloud_storagebatchoperations-0.8.0 → google_cloud_storagebatchoperations-0.8.1/google_cloud_storagebatchoperations.egg-info}/PKG-INFO +5 -5
  12. {google_cloud_storagebatchoperations-0.8.0 → google_cloud_storagebatchoperations-0.8.1}/google_cloud_storagebatchoperations.egg-info/SOURCES.txt +2 -0
  13. google_cloud_storagebatchoperations-0.8.1/google_cloud_storagebatchoperations.egg-info/requires.txt +8 -0
  14. {google_cloud_storagebatchoperations-0.8.0 → google_cloud_storagebatchoperations-0.8.1}/setup.py +8 -5
  15. google_cloud_storagebatchoperations-0.8.1/tests/unit/gapic/storagebatchoperations_v1/test_compat.py +429 -0
  16. {google_cloud_storagebatchoperations-0.8.0 → google_cloud_storagebatchoperations-0.8.1}/tests/unit/gapic/storagebatchoperations_v1/test_storage_batch_operations.py +111 -478
  17. google_cloud_storagebatchoperations-0.8.0/google/cloud/storagebatchoperations_v1/__init__.py +0 -177
  18. google_cloud_storagebatchoperations-0.8.0/google/cloud/storagebatchoperations_v1/services/storage_batch_operations/transports/rest_base.py +0 -606
  19. google_cloud_storagebatchoperations-0.8.0/google_cloud_storagebatchoperations.egg-info/requires.txt +0 -11
  20. {google_cloud_storagebatchoperations-0.8.0 → google_cloud_storagebatchoperations-0.8.1}/LICENSE +0 -0
  21. {google_cloud_storagebatchoperations-0.8.0 → google_cloud_storagebatchoperations-0.8.1}/MANIFEST.in +0 -0
  22. {google_cloud_storagebatchoperations-0.8.0 → google_cloud_storagebatchoperations-0.8.1}/README.rst +0 -0
  23. {google_cloud_storagebatchoperations-0.8.0 → google_cloud_storagebatchoperations-0.8.1}/google/cloud/storagebatchoperations/__init__.py +0 -0
  24. {google_cloud_storagebatchoperations-0.8.0 → google_cloud_storagebatchoperations-0.8.1}/google/cloud/storagebatchoperations/py.typed +0 -0
  25. {google_cloud_storagebatchoperations-0.8.0 → google_cloud_storagebatchoperations-0.8.1}/google/cloud/storagebatchoperations_v1/gapic_metadata.json +0 -0
  26. {google_cloud_storagebatchoperations-0.8.0 → google_cloud_storagebatchoperations-0.8.1}/google/cloud/storagebatchoperations_v1/py.typed +0 -0
  27. {google_cloud_storagebatchoperations-0.8.0 → google_cloud_storagebatchoperations-0.8.1}/google/cloud/storagebatchoperations_v1/services/__init__.py +0 -0
  28. {google_cloud_storagebatchoperations-0.8.0 → google_cloud_storagebatchoperations-0.8.1}/google/cloud/storagebatchoperations_v1/services/storage_batch_operations/__init__.py +0 -0
  29. {google_cloud_storagebatchoperations-0.8.0 → google_cloud_storagebatchoperations-0.8.1}/google/cloud/storagebatchoperations_v1/services/storage_batch_operations/pagers.py +0 -0
  30. {google_cloud_storagebatchoperations-0.8.0 → google_cloud_storagebatchoperations-0.8.1}/google/cloud/storagebatchoperations_v1/services/storage_batch_operations/transports/__init__.py +0 -0
  31. {google_cloud_storagebatchoperations-0.8.0 → google_cloud_storagebatchoperations-0.8.1}/google/cloud/storagebatchoperations_v1/services/storage_batch_operations/transports/grpc.py +0 -0
  32. {google_cloud_storagebatchoperations-0.8.0 → google_cloud_storagebatchoperations-0.8.1}/google/cloud/storagebatchoperations_v1/services/storage_batch_operations/transports/grpc_asyncio.py +0 -0
  33. {google_cloud_storagebatchoperations-0.8.0 → google_cloud_storagebatchoperations-0.8.1}/google/cloud/storagebatchoperations_v1/types/__init__.py +0 -0
  34. {google_cloud_storagebatchoperations-0.8.0 → google_cloud_storagebatchoperations-0.8.1}/google/cloud/storagebatchoperations_v1/types/storage_batch_operations.py +0 -0
  35. {google_cloud_storagebatchoperations-0.8.0 → google_cloud_storagebatchoperations-0.8.1}/google/cloud/storagebatchoperations_v1/types/storage_batch_operations_types.py +0 -0
  36. {google_cloud_storagebatchoperations-0.8.0 → google_cloud_storagebatchoperations-0.8.1}/google_cloud_storagebatchoperations.egg-info/dependency_links.txt +0 -0
  37. {google_cloud_storagebatchoperations-0.8.0 → google_cloud_storagebatchoperations-0.8.1}/google_cloud_storagebatchoperations.egg-info/not-zip-safe +0 -0
  38. {google_cloud_storagebatchoperations-0.8.0 → google_cloud_storagebatchoperations-0.8.1}/google_cloud_storagebatchoperations.egg-info/top_level.txt +0 -0
  39. {google_cloud_storagebatchoperations-0.8.0 → google_cloud_storagebatchoperations-0.8.1}/setup.cfg +0 -0
  40. {google_cloud_storagebatchoperations-0.8.0 → google_cloud_storagebatchoperations-0.8.1}/tests/__init__.py +0 -0
  41. {google_cloud_storagebatchoperations-0.8.0 → google_cloud_storagebatchoperations-0.8.1}/tests/unit/__init__.py +0 -0
  42. {google_cloud_storagebatchoperations-0.8.0 → google_cloud_storagebatchoperations-0.8.1}/tests/unit/gapic/__init__.py +0 -0
  43. {google_cloud_storagebatchoperations-0.8.0 → google_cloud_storagebatchoperations-0.8.1}/tests/unit/gapic/storagebatchoperations_v1/__init__.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: google-cloud-storagebatchoperations
3
- Version: 0.8.0
3
+ Version: 0.8.1
4
4
  Summary: Google Cloud Storagebatchoperations API client library
5
5
  Home-page: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-storagebatchoperations
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.8.0" # {x-release-please-version}
16
+ __version__ = "0.8.1" # {x-release-please-version}
@@ -0,0 +1,106 @@
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.storagebatchoperations_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.storagebatchoperations_v1.services.storage_batch_operations",
30
+ "google.cloud.storagebatchoperations_v1.types.storage_batch_operations",
31
+ "google.cloud.storagebatchoperations_v1.types.storage_batch_operations_types",
32
+ }
33
+
34
+
35
+ from .services.storage_batch_operations import (
36
+ StorageBatchOperationsAsyncClient,
37
+ StorageBatchOperationsClient,
38
+ )
39
+ from .types.storage_batch_operations import (
40
+ CancelJobRequest,
41
+ CancelJobResponse,
42
+ CreateJobRequest,
43
+ DeleteJobRequest,
44
+ GetBucketOperationRequest,
45
+ GetJobRequest,
46
+ ListBucketOperationsRequest,
47
+ ListBucketOperationsResponse,
48
+ ListJobsRequest,
49
+ ListJobsResponse,
50
+ OperationMetadata,
51
+ )
52
+ from .types.storage_batch_operations_types import (
53
+ BucketList,
54
+ BucketOperation,
55
+ Counters,
56
+ CustomContextUpdates,
57
+ DeleteObject,
58
+ ErrorLogEntry,
59
+ ErrorSummary,
60
+ Job,
61
+ LoggingConfig,
62
+ Manifest,
63
+ ObjectCustomContextPayload,
64
+ ObjectRetention,
65
+ PrefixList,
66
+ PutMetadata,
67
+ PutObjectHold,
68
+ RewriteObject,
69
+ UpdateObjectCustomContext,
70
+ )
71
+
72
+ __all__ = (
73
+ "StorageBatchOperationsAsyncClient",
74
+ "BucketList",
75
+ "BucketOperation",
76
+ "CancelJobRequest",
77
+ "CancelJobResponse",
78
+ "Counters",
79
+ "CreateJobRequest",
80
+ "CustomContextUpdates",
81
+ "DeleteJobRequest",
82
+ "DeleteObject",
83
+ "ErrorLogEntry",
84
+ "ErrorSummary",
85
+ "GetBucketOperationRequest",
86
+ "GetJobRequest",
87
+ "Job",
88
+ "ListBucketOperationsRequest",
89
+ "ListBucketOperationsResponse",
90
+ "ListJobsRequest",
91
+ "ListJobsResponse",
92
+ "LoggingConfig",
93
+ "Manifest",
94
+ "ObjectCustomContextPayload",
95
+ "ObjectRetention",
96
+ "OperationMetadata",
97
+ "PrefixList",
98
+ "PutMetadata",
99
+ "PutObjectHold",
100
+ "RewriteObject",
101
+ "StorageBatchOperationsClient",
102
+ "UpdateObjectCustomContext",
103
+ )
104
+
105
+ api_core.check_python_version("google.cloud.storagebatchoperations_v1")
106
+ api_core.check_dependency_versions("google.cloud.storagebatchoperations_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.8.0" # {x-release-please-version}
16
+ __version__ = "0.8.1" # {x-release-please-version}
@@ -1534,9 +1534,7 @@ class StorageBatchOperationsAsyncClient:
1534
1534
  DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
1535
1535
  gapic_version=package_version.__version__
1536
1536
  )
1537
-
1538
- if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER
1539
- DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__
1537
+ DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__
1540
1538
 
1541
1539
 
1542
1540
  __all__ = ("StorageBatchOperationsAsyncClient",)
@@ -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.storagebatchoperations_v1 import gapic_version as package_version
49
+ from google.cloud.storagebatchoperations_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]
@@ -124,77 +131,13 @@ class StorageBatchOperationsClient(metaclass=StorageBatchOperationsClientMeta):
124
131
  objects.
125
132
  """
126
133
 
127
- @staticmethod
128
- def _get_default_mtls_endpoint(api_endpoint) -> Optional[str]:
129
- """Converts api endpoint to mTLS endpoint.
130
-
131
- Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to
132
- "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively.
133
- Args:
134
- api_endpoint (Optional[str]): the api endpoint to convert.
135
- Returns:
136
- Optional[str]: converted mTLS api endpoint.
137
- """
138
- if not api_endpoint:
139
- return api_endpoint
140
-
141
- mtls_endpoint_re = re.compile(
142
- r"(?P<name>[^.]+)(?P<mtls>\.mtls)?(?P<sandbox>\.sandbox)?(?P<googledomain>\.googleapis\.com)?"
143
- )
144
-
145
- m = mtls_endpoint_re.match(api_endpoint)
146
- if m is None:
147
- # Could not parse api_endpoint; return as-is.
148
- return api_endpoint
149
-
150
- name, mtls, sandbox, googledomain = m.groups()
151
- if mtls or not googledomain:
152
- return api_endpoint
153
-
154
- if sandbox:
155
- return api_endpoint.replace(
156
- "sandbox.googleapis.com", "mtls.sandbox.googleapis.com"
157
- )
158
-
159
- return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com")
160
-
161
134
  # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead.
162
135
  DEFAULT_ENDPOINT = "storagebatchoperations.googleapis.com"
163
- DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore
164
- DEFAULT_ENDPOINT
165
- )
136
+ DEFAULT_MTLS_ENDPOINT = get_default_mtls_endpoint(DEFAULT_ENDPOINT)
166
137
 
167
138
  _DEFAULT_ENDPOINT_TEMPLATE = "storagebatchoperations.{UNIVERSE_DOMAIN}"
168
139
  _DEFAULT_UNIVERSE = "googleapis.com"
169
140
 
170
- @staticmethod
171
- def _use_client_cert_effective():
172
- """Returns whether client certificate should be used for mTLS if the
173
- google-auth version supports should_use_client_cert automatic mTLS enablement.
174
-
175
- Alternatively, read from the GOOGLE_API_USE_CLIENT_CERTIFICATE env var.
176
-
177
- Returns:
178
- bool: whether client certificate should be used for mTLS
179
- Raises:
180
- ValueError: (If using a version of google-auth without should_use_client_cert and
181
- GOOGLE_API_USE_CLIENT_CERTIFICATE is set to an unexpected value.)
182
- """
183
- # check if google-auth version supports should_use_client_cert for automatic mTLS enablement
184
- if hasattr(mtls, "should_use_client_cert"): # pragma: NO COVER
185
- return mtls.should_use_client_cert()
186
- else: # pragma: NO COVER
187
- # if unsupported, fallback to reading from env var
188
- use_client_cert_str = os.getenv(
189
- "GOOGLE_API_USE_CLIENT_CERTIFICATE", "false"
190
- ).lower()
191
- if use_client_cert_str not in ("true", "false"):
192
- raise ValueError(
193
- "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be"
194
- " either `true` or `false`"
195
- )
196
- return use_client_cert_str == "true"
197
-
198
141
  @classmethod
199
142
  def from_service_account_info(cls, info: dict, *args, **kwargs):
200
143
  """Creates an instance of this client using the provided credentials
@@ -430,7 +373,7 @@ class StorageBatchOperationsClient(metaclass=StorageBatchOperationsClientMeta):
430
373
  )
431
374
  if client_options is None:
432
375
  client_options = client_options_lib.ClientOptions()
433
- use_client_cert = StorageBatchOperationsClient._use_client_cert_effective()
376
+ use_client_cert = should_use_client_cert()
434
377
  use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto")
435
378
  if use_mtls_endpoint not in ("auto", "never", "always"):
436
379
  raise MutualTLSChannelError(
@@ -451,35 +394,12 @@ class StorageBatchOperationsClient(metaclass=StorageBatchOperationsClientMeta):
451
394
  elif use_mtls_endpoint == "always" or (
452
395
  use_mtls_endpoint == "auto" and client_cert_source
453
396
  ):
454
- api_endpoint = cls.DEFAULT_MTLS_ENDPOINT
397
+ api_endpoint = cls.DEFAULT_MTLS_ENDPOINT # type: ignore
455
398
  else:
456
399
  api_endpoint = cls.DEFAULT_ENDPOINT
457
400
 
458
401
  return api_endpoint, client_cert_source
459
402
 
460
- @staticmethod
461
- def _read_environment_variables():
462
- """Returns the environment variables used by the client.
463
-
464
- Returns:
465
- Tuple[bool, str, str]: returns the GOOGLE_API_USE_CLIENT_CERTIFICATE,
466
- GOOGLE_API_USE_MTLS_ENDPOINT, and GOOGLE_CLOUD_UNIVERSE_DOMAIN environment variables.
467
-
468
- Raises:
469
- ValueError: If GOOGLE_API_USE_CLIENT_CERTIFICATE is not
470
- any of ["true", "false"].
471
- google.auth.exceptions.MutualTLSChannelError: If GOOGLE_API_USE_MTLS_ENDPOINT
472
- is not any of ["auto", "never", "always"].
473
- """
474
- use_client_cert = StorageBatchOperationsClient._use_client_cert_effective()
475
- use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto").lower()
476
- universe_domain_env = os.getenv("GOOGLE_CLOUD_UNIVERSE_DOMAIN")
477
- if use_mtls_endpoint not in ("auto", "never", "always"):
478
- raise MutualTLSChannelError(
479
- "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`"
480
- )
481
- return use_client_cert, use_mtls_endpoint, universe_domain_env
482
-
483
403
  @staticmethod
484
404
  def _get_client_cert_source(provided_cert_source, use_cert_flag):
485
405
  """Return the client cert source to be used by the client.
@@ -499,67 +419,6 @@ class StorageBatchOperationsClient(metaclass=StorageBatchOperationsClientMeta):
499
419
  client_cert_source = mtls.default_client_cert_source()
500
420
  return client_cert_source
501
421
 
502
- @staticmethod
503
- def _get_api_endpoint(
504
- api_override, client_cert_source, universe_domain, use_mtls_endpoint
505
- ) -> str:
506
- """Return the API endpoint used by the client.
507
-
508
- Args:
509
- api_override (str): The API endpoint override. If specified, this is always
510
- the return value of this function and the other arguments are not used.
511
- client_cert_source (bytes): The client certificate source used by the client.
512
- universe_domain (str): The universe domain used by the client.
513
- use_mtls_endpoint (str): How to use the mTLS endpoint, which depends also on the other parameters.
514
- Possible values are "always", "auto", or "never".
515
-
516
- Returns:
517
- str: The API endpoint to be used by the client.
518
- """
519
- if api_override is not None:
520
- api_endpoint = api_override
521
- elif use_mtls_endpoint == "always" or (
522
- use_mtls_endpoint == "auto" and client_cert_source
523
- ):
524
- _default_universe = StorageBatchOperationsClient._DEFAULT_UNIVERSE
525
- if universe_domain != _default_universe:
526
- raise MutualTLSChannelError(
527
- f"mTLS is not supported in any universe other than {_default_universe}."
528
- )
529
- api_endpoint = StorageBatchOperationsClient.DEFAULT_MTLS_ENDPOINT
530
- else:
531
- api_endpoint = (
532
- StorageBatchOperationsClient._DEFAULT_ENDPOINT_TEMPLATE.format(
533
- UNIVERSE_DOMAIN=universe_domain
534
- )
535
- )
536
- return api_endpoint
537
-
538
- @staticmethod
539
- def _get_universe_domain(
540
- client_universe_domain: Optional[str], universe_domain_env: Optional[str]
541
- ) -> str:
542
- """Return the universe domain used by the client.
543
-
544
- Args:
545
- client_universe_domain (Optional[str]): The universe domain configured via the client options.
546
- universe_domain_env (Optional[str]): The universe domain configured via the "GOOGLE_CLOUD_UNIVERSE_DOMAIN" environment variable.
547
-
548
- Returns:
549
- str: The universe domain to be used by the client.
550
-
551
- Raises:
552
- ValueError: If the universe domain is an empty string.
553
- """
554
- universe_domain = StorageBatchOperationsClient._DEFAULT_UNIVERSE
555
- if client_universe_domain is not None:
556
- universe_domain = client_universe_domain
557
- elif universe_domain_env is not None:
558
- universe_domain = universe_domain_env
559
- if len(universe_domain.strip()) == 0:
560
- raise ValueError("Universe Domain cannot be an empty string.")
561
- return universe_domain
562
-
563
422
  def _validate_universe_domain(self):
564
423
  """Validates client's and credentials' universe domains are consistent.
565
424
 
@@ -693,13 +552,15 @@ class StorageBatchOperationsClient(metaclass=StorageBatchOperationsClientMeta):
693
552
  universe_domain_opt = getattr(self._client_options, "universe_domain", None)
694
553
 
695
554
  self._use_client_cert, self._use_mtls_endpoint, self._universe_domain_env = (
696
- StorageBatchOperationsClient._read_environment_variables()
555
+ read_environment_variables()
697
556
  )
698
557
  self._client_cert_source = StorageBatchOperationsClient._get_client_cert_source(
699
558
  self._client_options.client_cert_source, self._use_client_cert
700
559
  )
701
- self._universe_domain = StorageBatchOperationsClient._get_universe_domain(
702
- universe_domain_opt, self._universe_domain_env
560
+ self._universe_domain = get_universe_domain(
561
+ universe_domain_opt,
562
+ self._universe_domain_env,
563
+ default_universe=StorageBatchOperationsClient._DEFAULT_UNIVERSE,
703
564
  )
704
565
  self._api_endpoint: str = "" # updated below, depending on `transport`
705
566
 
@@ -734,14 +595,14 @@ class StorageBatchOperationsClient(metaclass=StorageBatchOperationsClientMeta):
734
595
  self._transport = cast(StorageBatchOperationsTransport, transport)
735
596
  self._api_endpoint = self._transport.host
736
597
 
737
- self._api_endpoint = (
738
- self._api_endpoint
739
- or StorageBatchOperationsClient._get_api_endpoint(
740
- self._client_options.api_endpoint,
741
- self._client_cert_source,
742
- self._universe_domain,
743
- self._use_mtls_endpoint,
744
- )
598
+ self._api_endpoint = self._api_endpoint or get_api_endpoint(
599
+ api_override=self._client_options.api_endpoint,
600
+ universe_domain=self._universe_domain,
601
+ default_universe=StorageBatchOperationsClient._DEFAULT_UNIVERSE,
602
+ default_mtls_endpoint=StorageBatchOperationsClient.DEFAULT_MTLS_ENDPOINT,
603
+ default_endpoint_template=StorageBatchOperationsClient._DEFAULT_ENDPOINT_TEMPLATE,
604
+ use_mtls=self._use_mtls_endpoint == "always"
605
+ or (self._use_mtls_endpoint == "auto" and self._client_cert_source),
745
606
  )
746
607
 
747
608
  if not transport_provided:
@@ -2007,8 +1868,6 @@ class StorageBatchOperationsClient(metaclass=StorageBatchOperationsClientMeta):
2007
1868
  DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
2008
1869
  gapic_version=package_version.__version__
2009
1870
  )
2010
-
2011
- if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER
2012
- DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__
1871
+ DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__
2013
1872
 
2014
1873
  __all__ = ("StorageBatchOperationsClient",)