# -*- coding: utf-8 -*- # Copyright 2025 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # import logging import json # type: ignore from google.auth.transport.requests import AuthorizedSession # type: ignore from google.auth import credentials as ga_credentials # type: ignore from google.api_core import exceptions as core_exceptions from google.api_core import retry as retries from google.api_core import rest_helpers from google.api_core import rest_streaming from google.api_core import gapic_v1 import cloudsdk.google.protobuf from cloudsdk.google.protobuf import json_format from requests import __version__ as requests_version import dataclasses from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union import warnings from googlecloudsdk.generated_clients.gapic_clients.run_v2.types import task from .rest_base import _BaseTasksRestTransport from .base import DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO try: OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None] except AttributeError: # pragma: NO COVER OptionalRetry = Union[retries.Retry, object, None] # type: ignore try: from google.api_core import client_logging # type: ignore CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER except ImportError: # pragma: NO COVER CLIENT_LOGGING_SUPPORTED = False _LOGGER = logging.getLogger(__name__) DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, grpc_version=None, rest_version=f"requests@{requests_version}", ) if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER DEFAULT_CLIENT_INFO.protobuf_runtime_version = cloudsdk.google.protobuf.__version__ class TasksRestInterceptor: """Interceptor for Tasks. Interceptors are used to manipulate requests, request metadata, and responses in arbitrary ways. Example use cases include: * Logging * Verifying requests according to service or custom semantics * Stripping extraneous information from responses These use cases and more can be enabled by injecting an instance of a custom subclass when constructing the TasksRestTransport. .. code-block:: python class MyCustomTasksInterceptor(TasksRestInterceptor): def pre_get_task(self, request, metadata): logging.log(f"Received request: {request}") return request, metadata def post_get_task(self, response): logging.log(f"Received response: {response}") return response def pre_list_tasks(self, request, metadata): logging.log(f"Received request: {request}") return request, metadata def post_list_tasks(self, response): logging.log(f"Received response: {response}") return response transport = TasksRestTransport(interceptor=MyCustomTasksInterceptor()) client = TasksClient(transport=transport) """ def pre_get_task(self, request: task.GetTaskRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[task.GetTaskRequest, Sequence[Tuple[str, Union[str, bytes]]]]: """Pre-rpc interceptor for get_task Override in a subclass to manipulate the request or metadata before they are sent to the Tasks server. """ return request, metadata def post_get_task(self, response: task.Task) -> task.Task: """Post-rpc interceptor for get_task DEPRECATED. Please use the `post_get_task_with_metadata` interceptor instead. Override in a subclass to read or manipulate the response after it is returned by the Tasks server but before it is returned to user code. This `post_get_task` interceptor runs before the `post_get_task_with_metadata` interceptor. """ return response def post_get_task_with_metadata(self, response: task.Task, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[task.Task, Sequence[Tuple[str, Union[str, bytes]]]]: """Post-rpc interceptor for get_task Override in a subclass to read or manipulate the response or metadata after it is returned by the Tasks server but before it is returned to user code. We recommend only using this `post_get_task_with_metadata` interceptor in new development instead of the `post_get_task` interceptor. When both interceptors are used, this `post_get_task_with_metadata` interceptor runs after the `post_get_task` interceptor. The (possibly modified) response returned by `post_get_task` will be passed to `post_get_task_with_metadata`. """ return response, metadata def pre_list_tasks(self, request: task.ListTasksRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[task.ListTasksRequest, Sequence[Tuple[str, Union[str, bytes]]]]: """Pre-rpc interceptor for list_tasks Override in a subclass to manipulate the request or metadata before they are sent to the Tasks server. """ return request, metadata def post_list_tasks(self, response: task.ListTasksResponse) -> task.ListTasksResponse: """Post-rpc interceptor for list_tasks DEPRECATED. Please use the `post_list_tasks_with_metadata` interceptor instead. Override in a subclass to read or manipulate the response after it is returned by the Tasks server but before it is returned to user code. This `post_list_tasks` interceptor runs before the `post_list_tasks_with_metadata` interceptor. """ return response def post_list_tasks_with_metadata(self, response: task.ListTasksResponse, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[task.ListTasksResponse, Sequence[Tuple[str, Union[str, bytes]]]]: """Post-rpc interceptor for list_tasks Override in a subclass to read or manipulate the response or metadata after it is returned by the Tasks server but before it is returned to user code. We recommend only using this `post_list_tasks_with_metadata` interceptor in new development instead of the `post_list_tasks` interceptor. When both interceptors are used, this `post_list_tasks_with_metadata` interceptor runs after the `post_list_tasks` interceptor. The (possibly modified) response returned by `post_list_tasks` will be passed to `post_list_tasks_with_metadata`. """ return response, metadata @dataclasses.dataclass class TasksRestStub: _session: AuthorizedSession _host: str _interceptor: TasksRestInterceptor class TasksRestTransport(_BaseTasksRestTransport): """REST backend synchronous transport for Tasks. Cloud Run Task Control Plane API. This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation and call it. It sends JSON representations of protocol buffers over HTTP/1.1 """ def __init__(self, *, host: str = 'run.googleapis.com', credentials: Optional[ga_credentials.Credentials] = None, credentials_file: Optional[str] = None, scopes: Optional[Sequence[str]] = None, client_cert_source_for_mtls: Optional[Callable[[ ], Tuple[bytes, bytes]]] = None, quota_project_id: Optional[str] = None, client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, always_use_jwt_access: Optional[bool] = False, url_scheme: str = 'https', interceptor: Optional[TasksRestInterceptor] = None, api_audience: Optional[str] = None, ) -> None: """Instantiate the transport. NOTE: This REST transport functionality is currently in a beta state (preview). We welcome your feedback via a GitHub issue in this library's repository. Thank you! Args: host (Optional[str]): The hostname to connect to (default: 'run.googleapis.com'). credentials (Optional[google.auth.credentials.Credentials]): The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. credentials_file (Optional[str]): Deprecated. A file with credentials that can be loaded with :func:`google.auth.load_credentials_from_file`. This argument is ignored if ``channel`` is provided. This argument will be removed in the next major version of this library. scopes (Optional(Sequence[str])): A list of scopes. This argument is ignored if ``channel`` is provided. client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client certificate to configure mutual TLS HTTP channel. It is ignored if ``channel`` is provided. quota_project_id (Optional[str]): An optional project to use for billing and quota. 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 are developing your own client library. always_use_jwt_access (Optional[bool]): Whether self signed JWT should be used for service account credentials. url_scheme: the protocol scheme for the API endpoint. Normally "https", but for testing or local servers, "http" can be specified. """ # Run the base constructor # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the # credentials object super().__init__( host=host, credentials=credentials, client_info=client_info, always_use_jwt_access=always_use_jwt_access, url_scheme=url_scheme, api_audience=api_audience ) self._session = AuthorizedSession( self._credentials, default_host=self.DEFAULT_HOST) if client_cert_source_for_mtls: self._session.configure_mtls_channel(client_cert_source_for_mtls) self._interceptor = interceptor or TasksRestInterceptor() self._prep_wrapped_messages(client_info) class _GetTask(_BaseTasksRestTransport._BaseGetTask, TasksRestStub): def __hash__(self): return hash("TasksRestTransport.GetTask") @staticmethod def _get_response( host, metadata, query_params, session, timeout, transcoded_request, body=None): uri = transcoded_request['uri'] method = transcoded_request['method'] headers = dict(metadata) headers['Content-Type'] = 'application/json' response = getattr(session, method)( "{host}{uri}".format(host=host, uri=uri), timeout=timeout, headers=headers, params=rest_helpers.flatten_query_params(query_params, strict=True), ) return response def __call__(self, request: task.GetTaskRequest, *, retry: OptionalRetry=gapic_v1.method.DEFAULT, timeout: Optional[float]=None, metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), ) -> task.Task: r"""Call the get task method over HTTP. Args: request (~.task.GetTaskRequest): The request object. Request message for obtaining a Task by its full name. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. Returns: ~.task.Task: Task represents a single run of a container to completion. """ http_options = _BaseTasksRestTransport._BaseGetTask._get_http_options() request, metadata = self._interceptor.pre_get_task(request, metadata) transcoded_request = _BaseTasksRestTransport._BaseGetTask._get_transcoded_request(http_options, request) # Jsonify the query params query_params = _BaseTasksRestTransport._BaseGetTask._get_query_params_json(transcoded_request) if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) method = transcoded_request['method'] try: request_payload = type(request).to_json(request) except: request_payload = None http_request = { "payload": request_payload, "requestMethod": method, "requestUrl": request_url, "headers": dict(metadata), } _LOGGER.debug( f"Sending request for google.cloud.run_v2.TasksClient.GetTask", extra = { "serviceName": "google.cloud.run.v2.Tasks", "rpcName": "GetTask", "httpRequest": http_request, "metadata": http_request["headers"], }, ) # Send the request response = TasksRestTransport._GetTask._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request) # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception # subclass. if response.status_code >= 400: raise core_exceptions.from_http_response(response) # Return the response resp = task.Task() pb_resp = task.Task.pb(resp) json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) resp = self._interceptor.post_get_task(resp) response_metadata = [(k, str(v)) for k, v in response.headers.items()] resp, _ = self._interceptor.post_get_task_with_metadata(resp, response_metadata) if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER try: response_payload = task.Task.to_json(response) except: response_payload = None http_response = { "payload": response_payload, "headers": dict(response.headers), "status": response.status_code, } _LOGGER.debug( "Received response for google.cloud.run_v2.TasksClient.get_task", extra = { "serviceName": "google.cloud.run.v2.Tasks", "rpcName": "GetTask", "metadata": http_response["headers"], "httpResponse": http_response, }, ) return resp class _ListTasks(_BaseTasksRestTransport._BaseListTasks, TasksRestStub): def __hash__(self): return hash("TasksRestTransport.ListTasks") @staticmethod def _get_response( host, metadata, query_params, session, timeout, transcoded_request, body=None): uri = transcoded_request['uri'] method = transcoded_request['method'] headers = dict(metadata) headers['Content-Type'] = 'application/json' response = getattr(session, method)( "{host}{uri}".format(host=host, uri=uri), timeout=timeout, headers=headers, params=rest_helpers.flatten_query_params(query_params, strict=True), ) return response def __call__(self, request: task.ListTasksRequest, *, retry: OptionalRetry=gapic_v1.method.DEFAULT, timeout: Optional[float]=None, metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), ) -> task.ListTasksResponse: r"""Call the list tasks method over HTTP. Args: request (~.task.ListTasksRequest): The request object. Request message for retrieving a list of Tasks. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. Returns: ~.task.ListTasksResponse: Response message containing a list of Tasks. """ http_options = _BaseTasksRestTransport._BaseListTasks._get_http_options() request, metadata = self._interceptor.pre_list_tasks(request, metadata) transcoded_request = _BaseTasksRestTransport._BaseListTasks._get_transcoded_request(http_options, request) # Jsonify the query params query_params = _BaseTasksRestTransport._BaseListTasks._get_query_params_json(transcoded_request) if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) method = transcoded_request['method'] try: request_payload = type(request).to_json(request) except: request_payload = None http_request = { "payload": request_payload, "requestMethod": method, "requestUrl": request_url, "headers": dict(metadata), } _LOGGER.debug( f"Sending request for google.cloud.run_v2.TasksClient.ListTasks", extra = { "serviceName": "google.cloud.run.v2.Tasks", "rpcName": "ListTasks", "httpRequest": http_request, "metadata": http_request["headers"], }, ) # Send the request response = TasksRestTransport._ListTasks._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request) # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception # subclass. if response.status_code >= 400: raise core_exceptions.from_http_response(response) # Return the response resp = task.ListTasksResponse() pb_resp = task.ListTasksResponse.pb(resp) json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) resp = self._interceptor.post_list_tasks(resp) response_metadata = [(k, str(v)) for k, v in response.headers.items()] resp, _ = self._interceptor.post_list_tasks_with_metadata(resp, response_metadata) if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER try: response_payload = task.ListTasksResponse.to_json(response) except: response_payload = None http_response = { "payload": response_payload, "headers": dict(response.headers), "status": response.status_code, } _LOGGER.debug( "Received response for google.cloud.run_v2.TasksClient.list_tasks", extra = { "serviceName": "google.cloud.run.v2.Tasks", "rpcName": "ListTasks", "metadata": http_response["headers"], "httpResponse": http_response, }, ) return resp @property def get_task(self) -> Callable[ [task.GetTaskRequest], task.Task]: # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. # In C++ this would require a dynamic_cast return self._GetTask(self._session, self._host, self._interceptor) # type: ignore @property def list_tasks(self) -> Callable[ [task.ListTasksRequest], task.ListTasksResponse]: # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. # In C++ this would require a dynamic_cast return self._ListTasks(self._session, self._host, self._interceptor) # type: ignore @property def kind(self) -> str: return "rest" def close(self): self._session.close() __all__=( 'TasksRestTransport', )