feat: add api key support (#78)

- [ ] Regenerate this pull request now.

PiperOrigin-RevId: 423842556

Source-Link: googleapis/googleapis@a616ca0

Source-Link: googleapis/googleapis-gen@29b938c
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMjliOTM4YzU4YzFlNTFkMDE5ZjJlZTUzOWQ1NWRjMGEzYzg2YTkwNSJ9

feat: generate snippet metadata

packages/google-cloud-private-catalog/google/cloud/privatecatalog_v1beta1/services/private_catalog/async_client.py

@@ -16,7 +16,7 @@
 from collections import OrderedDict
 import functools
 import re
-from typing import Dict, Sequence, Tuple, Type, Union
+from typing import Dict, Optional, Sequence, Tuple, Type, Union
 import pkg_resources
 
 from google.api_core.client_options import ClientOptions
@@ -132,6 +132,42 @@ def from_service_account_file(cls, filename: str, *args, **kwargs):
 
     from_service_account_json = from_service_account_file
 
+    @classmethod
+    def get_mtls_endpoint_and_cert_source(
+        cls, client_options: Optional[ClientOptions] = None
+    ):
+        """Return the API endpoint and client cert source for mutual TLS.
+
+        The client cert source is determined in the following order:
+        (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the
+        client cert source is None.
+        (2) if `client_options.client_cert_source` is provided, use the provided one; if the
+        default client cert source exists, use the default one; otherwise the client cert
+        source is None.
+
+        The API endpoint is determined in the following order:
+        (1) if `client_options.api_endpoint` if provided, use the provided one.
+        (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the
+        default mTLS endpoint; if the environment variabel is "never", use the default API
+        endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
+        use the default API endpoint.
+
+        More details can be found at https://google.aip.dev/auth/4114.
+
+        Args:
+            client_options (google.api_core.client_options.ClientOptions): Custom options for the
+                client. Only the `api_endpoint` and `client_cert_source` properties may be used
+                in this method.
+
+        Returns:
+            Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the
+                client cert source to use.
+
+        Raises:
+            google.auth.exceptions.MutualTLSChannelError: If any errors happen.
+        """
+        return PrivateCatalogClient.get_mtls_endpoint_and_cert_source(client_options)  # type: ignore
+
     @property
     def transport(self) -> PrivateCatalogTransport:
         """Returns the transport used by the client instance.
@@ -204,6 +240,25 @@ async def search_catalogs(
         resources that consumers have access to, within the scope of the
         consumer cloud resource hierarchy context.
 
+
+        .. code-block::
+
+            from google.cloud import privatecatalog_v1beta1
+
+            def sample_search_catalogs():
+                # Create a client
+                client = privatecatalog_v1beta1.PrivateCatalogClient()
+
+                # Initialize request argument(s)
+                request = privatecatalog_v1beta1.SearchCatalogsRequest(
+                    resource="resource_value",
+                )
+
+                # Make the request
+                page_result = client.search_catalogs(request=request)
+                for response in page_result:
+                    print(response)
+
         Args:
             request (Union[google.cloud.privatecatalog_v1beta1.types.SearchCatalogsRequest, dict]):
                 The request object. Request message for
@@ -264,6 +319,25 @@ async def search_products(
         resources that consumers have access to, within the scope of the
         consumer cloud resource hierarchy context.
 
+
+        .. code-block::
+
+            from google.cloud import privatecatalog_v1beta1
+
+            def sample_search_products():
+                # Create a client
+                client = privatecatalog_v1beta1.PrivateCatalogClient()
+
+                # Initialize request argument(s)
+                request = privatecatalog_v1beta1.SearchProductsRequest(
+                    resource="resource_value",
+                )
+
+                # Make the request
+                page_result = client.search_products(request=request)
+                for response in page_result:
+                    print(response)
+
         Args:
             request (Union[google.cloud.privatecatalog_v1beta1.types.SearchProductsRequest, dict]):
                 The request object. Request message for
@@ -324,6 +398,26 @@ async def search_versions(
         resources that consumers have access to, within the scope of the
         consumer cloud resource hierarchy context.
 
+
+        .. code-block::
+
+            from google.cloud import privatecatalog_v1beta1
+
+            def sample_search_versions():
+                # Create a client
+                client = privatecatalog_v1beta1.PrivateCatalogClient()
+
+                # Initialize request argument(s)
+                request = privatecatalog_v1beta1.SearchVersionsRequest(
+                    resource="resource_value",
+                    query="query_value",
+                )
+
+                # Make the request
+                page_result = client.search_versions(request=request)
+                for response in page_result:
+                    print(response)
+
         Args:
             request (Union[google.cloud.privatecatalog_v1beta1.types.SearchVersionsRequest, dict]):
                 The request object. Request message for

packages/google-cloud-private-catalog/google/cloud/privatecatalog_v1beta1/services/private_catalog/client.py

@@ -278,6 +278,73 @@ def parse_common_location_path(path: str) -> Dict[str, str]:
         m = re.match(r"^projects/(?P<project>.+?)/locations/(?P<location>.+?)$", path)
         return m.groupdict() if m else {}
 
+    @classmethod
+    def get_mtls_endpoint_and_cert_source(
+        cls, client_options: Optional[client_options_lib.ClientOptions] = None
+    ):
+        """Return the API endpoint and client cert source for mutual TLS.
+
+        The client cert source is determined in the following order:
+        (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the
+        client cert source is None.
+        (2) if `client_options.client_cert_source` is provided, use the provided one; if the
+        default client cert source exists, use the default one; otherwise the client cert
+        source is None.
+
+        The API endpoint is determined in the following order:
+        (1) if `client_options.api_endpoint` if provided, use the provided one.
+        (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the
+        default mTLS endpoint; if the environment variabel is "never", use the default API
+        endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
+        use the default API endpoint.
+
+        More details can be found at https://google.aip.dev/auth/4114.
+
+        Args:
+            client_options (google.api_core.client_options.ClientOptions): Custom options for the
+                client. Only the `api_endpoint` and `client_cert_source` properties may be used
+                in this method.
+
+        Returns:
+            Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the
+                client cert source to use.
+
+        Raises:
+            google.auth.exceptions.MutualTLSChannelError: If any errors happen.
+        """
+        if client_options is None:
+            client_options = client_options_lib.ClientOptions()
+        use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false")
+        use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto")
+        if use_client_cert not in ("true", "false"):
+            raise ValueError(
+                "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`"
+            )
+        if use_mtls_endpoint not in ("auto", "never", "always"):
+            raise MutualTLSChannelError(
+                "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`"
+            )
+
+        # Figure out the client cert source to use.
+        client_cert_source = None
+        if use_client_cert == "true":
+            if client_options.client_cert_source:
+                client_cert_source = client_options.client_cert_source
+            elif mtls.has_default_client_cert_source():
+                client_cert_source = mtls.default_client_cert_source()
+
+        # Figure out which api endpoint to use.
+        if client_options.api_endpoint is not None:
+            api_endpoint = client_options.api_endpoint
+        elif use_mtls_endpoint == "always" or (
+            use_mtls_endpoint == "auto" and client_cert_source
+        ):
+            api_endpoint = cls.DEFAULT_MTLS_ENDPOINT
+        else:
+            api_endpoint = cls.DEFAULT_ENDPOINT
+
+        return api_endpoint, client_cert_source
+
     def __init__(
         self,
         *,
@@ -328,57 +395,22 @@ def __init__(
         if client_options is None:
             client_options = client_options_lib.ClientOptions()
 
-        # Create SSL credentials for mutual TLS if needed.
-        if os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") not in (
-            "true",
-            "false",
-        ):
-            raise ValueError(
-                "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`"
-            )
-        use_client_cert = (
-            os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") == "true"
+        api_endpoint, client_cert_source_func = self.get_mtls_endpoint_and_cert_source(
+            client_options
         )
 
-        client_cert_source_func = None
-        is_mtls = False
-        if use_client_cert:
-            if client_options.client_cert_source:
-                is_mtls = True
-                client_cert_source_func = client_options.client_cert_source
-            else:
-                is_mtls = mtls.has_default_client_cert_source()
-                if is_mtls:
-                    client_cert_source_func = mtls.default_client_cert_source()
-                else:
-                    client_cert_source_func = None
-
-        # Figure out which api endpoint to use.
-        if client_options.api_endpoint is not None:
-            api_endpoint = client_options.api_endpoint
-        else:
-            use_mtls_env = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto")
-            if use_mtls_env == "never":
-                api_endpoint = self.DEFAULT_ENDPOINT
-            elif use_mtls_env == "always":
-                api_endpoint = self.DEFAULT_MTLS_ENDPOINT
-            elif use_mtls_env == "auto":
-                if is_mtls:
-                    api_endpoint = self.DEFAULT_MTLS_ENDPOINT
-                else:
-                    api_endpoint = self.DEFAULT_ENDPOINT
-            else:
-                raise MutualTLSChannelError(
-                    "Unsupported GOOGLE_API_USE_MTLS_ENDPOINT value. Accepted "
-                    "values: never, auto, always"
-                )
+        api_key_value = getattr(client_options, "api_key", None)
+        if api_key_value and credentials:
+            raise ValueError(
+                "client_options.api_key and credentials are mutually exclusive"
+            )
 
         # Save or instantiate the transport.
         # Ordinarily, we provide the transport, but allowing a custom transport
         # instance provides an extensibility point for unusual situations.
         if isinstance(transport, PrivateCatalogTransport):
             # transport is a PrivateCatalogTransport instance.
-            if credentials or client_options.credentials_file:
+            if credentials or client_options.credentials_file or api_key_value:
                 raise ValueError(
                     "When providing a transport instance, "
                     "provide its credentials directly."
@@ -390,6 +422,15 @@ def __init__(
                 )
             self._transport = transport
         else:
+            import google.auth._default  # type: ignore
+
+            if api_key_value and hasattr(
+                google.auth._default, "get_api_key_credentials"
+            ):
+                credentials = google.auth._default.get_api_key_credentials(
+                    api_key_value
+                )
+
             Transport = type(self).get_transport_class(transport)
             self._transport = Transport(
                 credentials=credentials,
@@ -414,6 +455,26 @@ def search_catalogs(
         resources that consumers have access to, within the scope of the
         consumer cloud resource hierarchy context.
 
+
+
+        .. code-block::
+
+            from google.cloud import privatecatalog_v1beta1
+
+            def sample_search_catalogs():
+                # Create a client
+                client = privatecatalog_v1beta1.PrivateCatalogClient()
+
+                # Initialize request argument(s)
+                request = privatecatalog_v1beta1.SearchCatalogsRequest(
+                    resource="resource_value",
+                )
+
+                # Make the request
+                page_result = client.search_catalogs(request=request)
+                for response in page_result:
+                    print(response)
+
         Args:
             request (Union[google.cloud.privatecatalog_v1beta1.types.SearchCatalogsRequest, dict]):
                 The request object. Request message for
@@ -475,6 +536,26 @@ def search_products(
         resources that consumers have access to, within the scope of the
         consumer cloud resource hierarchy context.
 
+
+
+        .. code-block::
+
+            from google.cloud import privatecatalog_v1beta1
+
+            def sample_search_products():
+                # Create a client
+                client = privatecatalog_v1beta1.PrivateCatalogClient()
+
+                # Initialize request argument(s)
+                request = privatecatalog_v1beta1.SearchProductsRequest(
+                    resource="resource_value",
+                )
+
+                # Make the request
+                page_result = client.search_products(request=request)
+                for response in page_result:
+                    print(response)
+
         Args:
             request (Union[google.cloud.privatecatalog_v1beta1.types.SearchProductsRequest, dict]):
                 The request object. Request message for
@@ -536,6 +617,27 @@ def search_versions(
         resources that consumers have access to, within the scope of the
         consumer cloud resource hierarchy context.
 
+
+
+        .. code-block::
+
+            from google.cloud import privatecatalog_v1beta1
+
+            def sample_search_versions():
+                # Create a client
+                client = privatecatalog_v1beta1.PrivateCatalogClient()
+
+                # Initialize request argument(s)
+                request = privatecatalog_v1beta1.SearchVersionsRequest(
+                    resource="resource_value",
+                    query="query_value",
+                )
+
+                # Make the request
+                page_result = client.search_versions(request=request)
+                for response in page_result:
+                    print(response)
+
         Args:
             request (Union[google.cloud.privatecatalog_v1beta1.types.SearchVersionsRequest, dict]):
                 The request object. Request message for

packages/google-cloud-private-catalog/samples/generated_samples/cloudprivatecatalog_generated_privatecatalog_v1beta1_private_catalog_search_catalogs_async.py

@@ -28,8 +28,6 @@
 
 
 async def sample_search_catalogs():
-    """Snippet for search_catalogs"""
-
     # Create a client
     client = privatecatalog_v1beta1.PrivateCatalogAsyncClient()
 

packages/google-cloud-private-catalog/samples/generated_samples/cloudprivatecatalog_generated_privatecatalog_v1beta1_private_catalog_search_catalogs_sync.py

@@ -28,8 +28,6 @@
 
 
 def sample_search_catalogs():
-    """Snippet for search_catalogs"""
-
     # Create a client
     client = privatecatalog_v1beta1.PrivateCatalogClient()
 

packages/google-cloud-private-catalog/samples/generated_samples/cloudprivatecatalog_generated_privatecatalog_v1beta1_private_catalog_search_products_async.py

@@ -28,8 +28,6 @@
 
 
 async def sample_search_products():
-    """Snippet for search_products"""
-
     # Create a client
     client = privatecatalog_v1beta1.PrivateCatalogAsyncClient()