feat: add new types ExplainOptions, ExplainMetrics, PlanSummary, ExecutionStats (#521)

* feat: Allow users to explicitly configure universe domain chore: Update gapic-generator-python to v1.14.0 PiperOrigin-RevId: 603108274 Source-Link: googleapis/googleapis@3d83e36 Source-Link: googleapis/googleapis-gen@baf5e9b Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYmFmNWU5YmJiMTRhNzY4YjJiNGM5ZWFlOWZlYjc4ZjE4ZjE3NTdmYSJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * fix: Resolve AttributeError 'Credentials' object has no attribute 'universe_domain' fix: Add google-auth as a direct dependency fix: Add staticmethod decorator to methods added in v1.14.0 chore: Update gapic-generator-python to v1.14.1 PiperOrigin-RevId: 603728206 Source-Link: googleapis/googleapis@9063da8 Source-Link: googleapis/googleapis-gen@891c67d Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiODkxYzY3ZDBhODU1YjA4MDg1ZWIzMDFkYWJiMTQwNjRlZjRiMmM2ZCJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * fix(diregapic): s/bazel/bazelisk/ in DIREGAPIC build GitHub action PiperOrigin-RevId: 604714585 Source-Link: googleapis/googleapis@e4dce13 Source-Link: googleapis/googleapis-gen@4036f78 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNDAzNmY3ODMwNWM1YzJhYWI4MGZmOTE5NjBiM2EzZDk4M2ZmNGIwMyJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * fix(deps): Require `google-api-core>=1.34.1` fix: Resolve issue with missing import for certain enums in `**/types/…` PiperOrigin-RevId: 607041732 Source-Link: googleapis/googleapis@b453267 Source-Link: googleapis/googleapis-gen@cd79641 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiY2Q3OTY0MTZmMGY1NGNiMjJiMmM0NGZiMmQ0ODY5NjBlNjkzYTM0NiJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * fix(deps): Exclude google-auth 2.24.0 and 2.25.0 chore: Update gapic-generator-python to v1.14.4 PiperOrigin-RevId: 611561820 Source-Link: googleapis/googleapis@87ef1fe Source-Link: googleapis/googleapis-gen@1973161 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMTk3MzE2MTM3NTk0YWFmYWQ5NGRlYTMxMjI2NTI4ZmJjYzM5MzEwYyJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * feat: Add include_recaptcha_script for as a new action in firewall policies PiperOrigin-RevId: 612851792 Source-Link: googleapis/googleapis@49ea2c0 Source-Link: googleapis/googleapis-gen@460fdcb Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNDYwZmRjYmJiZTAwZjM1YjFjNTkxYjFmM2VmMGM3N2ViZDNjZTI3NyJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * fix coverage * fix(deps): require google-auth >= 2.14.1 * feat: add new types ExplainOptions, ExplainMetrics, PlanSummary, ExecutionStats feat: add ExplainOptions field to RunQueryRequest feat: add ExplainMetrics field to RunQueryResponse feat: add ExplainOptions field to RunAggregationQueryRequest feat: add ExplainMetrics field to RunAggregationQueryResponse PiperOrigin-RevId: 615158168 Source-Link: googleapis/googleapis@4d535ac Source-Link: googleapis/googleapis-gen@02e272d Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMDJlMjcyZGVkNTM4YjBmOTc4MzJiZmFkNDdkZWNiYzNkYzY1YTg5YSJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Anthonios Partheniou <partheniou@google.com>

Author: gcf-owl-bot[bot]

google/cloud/datastore_admin/__init__.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Copyright 2023 Google LLC
+# Copyright 2024 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

google/cloud/datastore_admin_v1/__init__.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Copyright 2023 Google LLC
+# Copyright 2024 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

google/cloud/datastore_admin_v1/services/__init__.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Copyright 2023 Google LLC
+# Copyright 2024 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

google/cloud/datastore_admin_v1/services/datastore_admin/__init__.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Copyright 2023 Google LLC
+# Copyright 2024 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

google/cloud/datastore_admin_v1/services/datastore_admin/async_client.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Copyright 2023 Google LLC
+# Copyright 2024 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -38,9 +38,9 @@
 from google.oauth2 import service_account # type: ignore
 
 try:
- OptionalRetry = Union[retries.AsyncRetry, gapic_v1.method._MethodDefault]
+ OptionalRetry = Union[retries.AsyncRetry, gapic_v1.method._MethodDefault, None]
 except AttributeError: # pragma: NO COVER
- OptionalRetry = Union[retries.AsyncRetry, object] # type: ignore
+ OptionalRetry = Union[retries.AsyncRetry, object, None] # type: ignore
 
 from google.api_core import operation # type: ignore
 from google.api_core import operation_async # type: ignore
@@ -113,8 +113,12 @@ class DatastoreAdminAsyncClient:
 
  _client: DatastoreAdminClient
 
+ # Copy defaults from the synchronous client for use here.
+ # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead.
  DEFAULT_ENDPOINT = DatastoreAdminClient.DEFAULT_ENDPOINT
  DEFAULT_MTLS_ENDPOINT = DatastoreAdminClient.DEFAULT_MTLS_ENDPOINT
+ _DEFAULT_ENDPOINT_TEMPLATE = DatastoreAdminClient._DEFAULT_ENDPOINT_TEMPLATE
+ _DEFAULT_UNIVERSE = DatastoreAdminClient._DEFAULT_UNIVERSE
 
  common_billing_account_path = staticmethod(
  DatastoreAdminClient.common_billing_account_path
@@ -219,6 +223,25 @@ def transport(self) -> DatastoreAdminTransport:
  """
  return self._client.transport
 
+ @property
+ def api_endpoint(self):
+ """Return the API endpoint used by the client instance.
+
+ Returns:
+ str: The API endpoint used by the client instance.
+ """
+ return self._client._api_endpoint
+
+ @property
+ def universe_domain(self) -> str:
+ """Return the universe domain used by the client instance.
+
+ Returns:
+ str: The universe domain used
+ by the client instance.
+ """
+ return self._client._universe_domain
+
  get_transport_class = functools.partial(
  type(DatastoreAdminClient).get_transport_class, type(DatastoreAdminClient)
  )
@@ -231,7 +254,7 @@ def __init__(
  client_options: Optional[ClientOptions] = None,
  client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO,
  ) -> None:
- """Instantiates the datastore admin client.
+ """Instantiates the datastore admin async client.
 
  Args:
  credentials (Optional[google.auth.credentials.Credentials]): The
@@ -242,23 +265,38 @@ def __init__(
  transport (Union[str, ~.DatastoreAdminTransport]): The
  transport to use. If set to None, a transport is chosen
  automatically.
- client_options (ClientOptions): Custom options for the client. It
- won't take effect if a ``transport`` instance is provided.
- (1) The ``api_endpoint`` property can be used to override the
- default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT
- environment variable can also be used to override the endpoint:
+ client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]):
+ Custom options for the client.
+
+ 1. The ``api_endpoint`` property can be used to override the
+ default endpoint provided by the client when ``transport`` is
+ not explicitly provided. Only if this property is not set and
+ ``transport`` was not explicitly provided, the endpoint is
+ determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment
+ variable, which have one of the following values:
  "always" (always use the default mTLS endpoint), "never" (always
- use the default regular endpoint) and "auto" (auto switch to the
- default mTLS endpoint if client certificate is present, this is
- the default value). However, the ``api_endpoint`` property takes
- precedence if provided.
- (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable
+ use the default regular endpoint) and "auto" (auto-switch to the
+ default mTLS endpoint if client certificate is present; this is
+ the default value).
+
+ 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable
  is "true", then the ``client_cert_source`` property can be used
- to provide client certificate for mutual TLS transport. If
+ to provide a client certificate for mTLS transport. If
  not provided, the default SSL client certificate will be used if
  present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not
  set, no client certificate will be used.
 
+ 3. The ``universe_domain`` property can be used to override the
+ default "googleapis.com" universe. Note that ``api_endpoint``
+ property still takes precedence; and ``universe_domain`` is
+ currently not supported for mTLS.
+
+ client_info (google.api_core.gapic_v1.client_info.ClientInfo):
+ The client info used to send a user-agent string along with
+ API requests. If ``None``, then default info will be used.
+ Generally, you only need to set this if you're developing
+ your own client library.
+
  Raises:
  google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport
  creation failed for any reason.
@@ -432,6 +470,9 @@ async def sample_export_entities():
  ),
  )
 
+ # Validate the universe domain.
+ self._client._validate_universe_domain()
+
  # Send the request.
  response = await rpc(
  request,
@@ -611,6 +652,9 @@ async def sample_import_entities():
  ),
  )
 
+ # Validate the universe domain.
+ self._client._validate_universe_domain()
+
  # Send the request.
  response = await rpc(
  request,
@@ -721,6 +765,9 @@ async def sample_create_index():
  ),
  )
 
+ # Validate the universe domain.
+ self._client._validate_universe_domain()
+
  # Send the request.
  response = await rpc(
  request,
@@ -833,6 +880,9 @@ async def sample_delete_index():
  ),
  )
 
+ # Validate the universe domain.
+ self._client._validate_universe_domain()
+
  # Send the request.
  response = await rpc(
  request,
@@ -933,6 +983,9 @@ async def sample_get_index():
  ),
  )
 
+ # Validate the universe domain.
+ self._client._validate_universe_domain()
+
  # Send the request.
  response = await rpc(
  request,
@@ -1031,6 +1084,9 @@ async def sample_list_indexes():
  ),
  )
 
+ # Validate the universe domain.
+ self._client._validate_universe_domain()
+
  # Send the request.
  response = await rpc(
  request,
@@ -1094,6 +1150,9 @@ async def list_operations(
  gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
  )
 
+ # Validate the universe domain.
+ self._client._validate_universe_domain()
+
  # Send the request.
  response = await rpc(
  request,
@@ -1148,6 +1207,9 @@ async def get_operation(
  gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
  )
 
+ # Validate the universe domain.
+ self._client._validate_universe_domain()
+
  # Send the request.
  response = await rpc(
  request,
@@ -1206,6 +1268,9 @@ async def delete_operation(
  gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
  )
 
+ # Validate the universe domain.
+ self._client._validate_universe_domain()
+
  # Send the request.
  await rpc(
  request,
@@ -1260,6 +1325,9 @@ async def cancel_operation(
  gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
  )
 
+ # Validate the universe domain.
+ self._client._validate_universe_domain()
+
  # Send the request.
  await rpc(
  request,