feat: [google-cloud-run] Add REST Interceptors which support reading metadata (#13489)

BEGIN_COMMIT_OVERRIDE
feat: add BuildConfig to Services for configuring Run functions
feat: add BuildInfo to Revision for displaying BuildConfig used for a
specific revision deployment
feat: add Base Image URI to Container
feat: add creator field to Execution
feat: add project_descriptor to BuildspackBuild
docs: some typos were fixed and formatting changed
feat: Add REST Interceptors which support reading metadata
feat: Add support for reading selective GAPIC generation methods from
service YAML
chore: Update gapic-generator-python to v1.22.0
END_COMMIT_OVERRIDE

- [ ] Regenerate this pull request now.

feat: Add support for reading selective GAPIC generation methods from
service YAML
chore: Update gapic-generator-python to v1.22.0

PiperOrigin-RevId: 724026024

Source-Link:
googleapis/googleapis@ad99638

Source-Link:
googleapis/googleapis-gen@e291c4d
Copy-Tag:
eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLXJ1bi8uT3dsQm90LnlhbWwiLCJoIjoiZTI5MWM0ZGQxZDY3MGVkYTE5OTk4ZGU3NmY5NjdlMTYwM2E0ODk5MyJ9

BEGIN_NESTED_COMMIT
feat: [google-cloud-run] add BuildConfig to Services for configuring Run
functions
feat: add BuildInfo to Revision for displaying BuildConfig used for a
specific revision deployment
feat: add Base Image URI to Container
feat: add creator field to Execution
feat: add project_descriptor to BuildspackBuild
docs: some typos were fixed and formatting changed

PiperOrigin-RevId: 723249447

Source-Link:
googleapis/googleapis@3d19492

Source-Link:
googleapis/googleapis-gen@c7231d3
Copy-Tag:
eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLXJ1bi8uT3dsQm90LnlhbWwiLCJoIjoiYzcyMzFkMzVhMmZiNWViZjRiN2M0ZDdlOWNmYTYyNDYwNzViMTlkYyJ9
END_NESTED_COMMIT

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: ohmayr <[email protected]>

Author: gcf-owl-bot[bot]

packages/google-cloud-run/google/cloud/run/__init__.py

@@ -57,6 +57,7 @@
     UpdateJobRequest,
 )
 from google.cloud.run_v2.types.k8s_min import (
+    BuildInfo,
     CloudSqlInstance,
     Container,
     ContainerPort,
@@ -110,6 +111,7 @@
 )
 from google.cloud.run_v2.types.vendor_settings import (
     BinaryAuthorization,
+    BuildConfig,
     EncryptionKeyRevocationAction,
     ExecutionEnvironment,
     IngressTraffic,
@@ -153,6 +155,7 @@
     "ListJobsResponse",
     "RunJobRequest",
     "UpdateJobRequest",
+    "BuildInfo",
     "CloudSqlInstance",
     "Container",
     "ContainerPort",
@@ -196,6 +199,7 @@
     "TrafficTargetStatus",
     "TrafficTargetAllocationType",
     "BinaryAuthorization",
+    "BuildConfig",
     "NodeSelector",
     "RevisionScaling",
     "ServiceMesh",

packages/google-cloud-run/google/cloud/run/gapic_version.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.10.14"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}

packages/google-cloud-run/google/cloud/run_v2/__init__.py

@@ -47,6 +47,7 @@
     UpdateJobRequest,
 )
 from .types.k8s_min import (
+    BuildInfo,
     CloudSqlInstance,
     Container,
     ContainerPort,
@@ -100,6 +101,7 @@
 )
 from .types.vendor_settings import (
     BinaryAuthorization,
+    BuildConfig,
     EncryptionKeyRevocationAction,
     ExecutionEnvironment,
     IngressTraffic,
@@ -118,6 +120,8 @@
     "ServicesAsyncClient",
     "TasksAsyncClient",
     "BinaryAuthorization",
+    "BuildConfig",
+    "BuildInfo",
     "BuildsClient",
     "CancelExecutionRequest",
     "CloudSqlInstance",

packages/google-cloud-run/google/cloud/run_v2/gapic_version.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.10.14"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}

packages/google-cloud-run/google/cloud/run_v2/services/builds/client.py

@@ -14,6 +14,8 @@
 # limitations under the License.
 #
 from collections import OrderedDict
+from http import HTTPStatus
+import json
 import logging as std_logging
 import os
 import re
@@ -486,6 +488,33 @@ def _validate_universe_domain(self):
         # NOTE (b/349488459): universe validation is disabled until further notice.
         return True
 
+    def _add_cred_info_for_auth_errors(
+        self, error: core_exceptions.GoogleAPICallError
+    ) -> None:
+        """Adds credential info string to error details for 401/403/404 errors.
+
+        Args:
+            error (google.api_core.exceptions.GoogleAPICallError): The error to add the cred info.
+        """
+        if error.code not in [
+            HTTPStatus.UNAUTHORIZED,
+            HTTPStatus.FORBIDDEN,
+            HTTPStatus.NOT_FOUND,
+        ]:
+            return
+
+        cred = self._transport._credentials
+
+        # get_cred_info is only available in google-auth>=2.35.0
+        if not hasattr(cred, "get_cred_info"):
+            return
+
+        # ignore the type check since pypy test fails when get_cred_info
+        # is not available
+        cred_info = cred.get_cred_info()  # type: ignore
+        if cred_info and hasattr(error._details, "append"):
+            error._details.append(json.dumps(cred_info))
+
     @property
     def api_endpoint(self):
         """Return the API endpoint used by the client instance.
@@ -826,16 +855,20 @@ def list_operations(
         # Validate the universe domain.
         self._validate_universe_domain()
 
-        # Send the request.
-        response = rpc(
-            request,
-            retry=retry,
-            timeout=timeout,
-            metadata=metadata,
-        )
+        try:
+            # Send the request.
+            response = rpc(
+                request,
+                retry=retry,
+                timeout=timeout,
+                metadata=metadata,
+            )
 
-        # Done; return the response.
-        return response
+            # Done; return the response.
+            return response
+        except core_exceptions.GoogleAPICallError as e:
+            self._add_cred_info_for_auth_errors(e)
+            raise e
 
     def get_operation(
         self,
@@ -881,16 +914,20 @@ def get_operation(
         # Validate the universe domain.
         self._validate_universe_domain()
 
-        # Send the request.
-        response = rpc(
-            request,
-            retry=retry,
-            timeout=timeout,
-            metadata=metadata,
-        )
+        try:
+            # Send the request.
+            response = rpc(
+                request,
+                retry=retry,
+                timeout=timeout,
+                metadata=metadata,
+            )
 
-        # Done; return the response.
-        return response
+            # Done; return the response.
+            return response
+        except core_exceptions.GoogleAPICallError as e:
+            self._add_cred_info_for_auth_errors(e)
+            raise e
 
     def delete_operation(
         self,
@@ -998,16 +1035,20 @@ def wait_operation(
         # Validate the universe domain.
         self._validate_universe_domain()
 
-        # Send the request.
-        response = rpc(
-            request,
-            retry=retry,
-            timeout=timeout,
-            metadata=metadata,
-        )
+        try:
+            # Send the request.
+            response = rpc(
+                request,
+                retry=retry,
+                timeout=timeout,
+                metadata=metadata,
+            )
 
-        # Done; return the response.
-        return response
+            # Done; return the response.
+            return response
+        except core_exceptions.GoogleAPICallError as e:
+            self._add_cred_info_for_auth_errors(e)
+            raise e
 
 
 DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(

packages/google-cloud-run/google/cloud/run_v2/services/builds/transports/rest.py

@@ -101,12 +101,35 @@ def post_submit_build(
     ) -> build.SubmitBuildResponse:
         """Post-rpc interceptor for submit_build
 
-        Override in a subclass to manipulate the response
+        DEPRECATED. Please use the `post_submit_build_with_metadata`
+        interceptor instead.
+
+        Override in a subclass to read or manipulate the response
         after it is returned by the Builds server but before
-        it is returned to user code.
+        it is returned to user code. This `post_submit_build` interceptor runs
+        before the `post_submit_build_with_metadata` interceptor.
         """
         return response
 
+    def post_submit_build_with_metadata(
+        self,
+        response: build.SubmitBuildResponse,
+        metadata: Sequence[Tuple[str, Union[str, bytes]]],
+    ) -> Tuple[build.SubmitBuildResponse, Sequence[Tuple[str, Union[str, bytes]]]]:
+        """Post-rpc interceptor for submit_build
+
+        Override in a subclass to read or manipulate the response or metadata after it
+        is returned by the Builds server but before it is returned to user code.
+
+        We recommend only using this `post_submit_build_with_metadata`
+        interceptor in new development instead of the `post_submit_build` interceptor.
+        When both interceptors are used, this `post_submit_build_with_metadata` interceptor runs after the
+        `post_submit_build` interceptor. The (possibly modified) response returned by
+        `post_submit_build` will be passed to
+        `post_submit_build_with_metadata`.
+        """
+        return response, metadata
+
     def pre_delete_operation(
         self,
         request: operations_pb2.DeleteOperationRequest,
@@ -418,6 +441,10 @@ def __call__(
             json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True)
 
             resp = self._interceptor.post_submit_build(resp)
+            response_metadata = [(k, str(v)) for k, v in response.headers.items()]
+            resp, _ = self._interceptor.post_submit_build_with_metadata(
+                resp, response_metadata
+            )
             if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(
                 logging.DEBUG
             ):  # pragma: NO COVER

packages/google-cloud-run/google/cloud/run_v2/services/executions/client.py

@@ -14,6 +14,8 @@
 # limitations under the License.
 #
 from collections import OrderedDict
+from http import HTTPStatus
+import json
 import logging as std_logging
 import os
 import re
@@ -598,6 +600,33 @@ def _validate_universe_domain(self):
         # NOTE (b/349488459): universe validation is disabled until further notice.
         return True
 
+    def _add_cred_info_for_auth_errors(
+        self, error: core_exceptions.GoogleAPICallError
+    ) -> None:
+        """Adds credential info string to error details for 401/403/404 errors.
+
+        Args:
+            error (google.api_core.exceptions.GoogleAPICallError): The error to add the cred info.
+        """
+        if error.code not in [
+            HTTPStatus.UNAUTHORIZED,
+            HTTPStatus.FORBIDDEN,
+            HTTPStatus.NOT_FOUND,
+        ]:
+            return
+
+        cred = self._transport._credentials
+
+        # get_cred_info is only available in google-auth>=2.35.0
+        if not hasattr(cred, "get_cred_info"):
+            return
+
+        # ignore the type check since pypy test fails when get_cred_info
+        # is not available
+        cred_info = cred.get_cred_info()  # type: ignore
+        if cred_info and hasattr(error._details, "append"):
+            error._details.append(json.dumps(cred_info))
+
     @property
     def api_endpoint(self):
         """Return the API endpoint used by the client instance.
@@ -1323,16 +1352,20 @@ def list_operations(
         # Validate the universe domain.
         self._validate_universe_domain()
 
-        # Send the request.
-        response = rpc(
-            request,
-            retry=retry,
-            timeout=timeout,
-            metadata=metadata,
-        )
+        try:
+            # Send the request.
+            response = rpc(
+                request,
+                retry=retry,
+                timeout=timeout,
+                metadata=metadata,
+            )
 
-        # Done; return the response.
-        return response
+            # Done; return the response.
+            return response
+        except core_exceptions.GoogleAPICallError as e:
+            self._add_cred_info_for_auth_errors(e)
+            raise e
 
     def get_operation(
         self,
@@ -1378,16 +1411,20 @@ def get_operation(
         # Validate the universe domain.
         self._validate_universe_domain()
 
-        # Send the request.
-        response = rpc(
-            request,
-            retry=retry,
-            timeout=timeout,
-            metadata=metadata,
-        )
+        try:
+            # Send the request.
+            response = rpc(
+                request,
+                retry=retry,
+                timeout=timeout,
+                metadata=metadata,
+            )
 
-        # Done; return the response.
-        return response
+            # Done; return the response.
+            return response
+        except core_exceptions.GoogleAPICallError as e:
+            self._add_cred_info_for_auth_errors(e)
+            raise e
 
     def delete_operation(
         self,
@@ -1495,16 +1532,20 @@ def wait_operation(
         # Validate the universe domain.
         self._validate_universe_domain()
 
-        # Send the request.
-        response = rpc(
-            request,
-            retry=retry,
-            timeout=timeout,
-            metadata=metadata,
-        )
+        try:
+            # Send the request.
+            response = rpc(
+                request,
+                retry=retry,
+                timeout=timeout,
+                metadata=metadata,
+            )
 
-        # Done; return the response.
-        return response
+            # Done; return the response.
+            return response
+        except core_exceptions.GoogleAPICallError as e:
+            self._add_cred_info_for_auth_errors(e)
+            raise e
 
 
 DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(