# -*- 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 as std_logging from collections import OrderedDict import re from typing import Dict, Callable, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union from googlecloudsdk.generated_clients.gapic_clients.run_v2 import gapic_version as package_version from google.api_core.client_options import ClientOptions from google.api_core import exceptions as core_exceptions from google.api_core import gapic_v1 from google.api_core import retry_async as retries from google.auth import credentials as ga_credentials # type: ignore from google.oauth2 import service_account # type: ignore import cloudsdk.google.protobuf try: OptionalRetry = Union[retries.AsyncRetry, gapic_v1.method._MethodDefault, None] except AttributeError: # pragma: NO COVER OptionalRetry = Union[retries.AsyncRetry, object, None] # type: ignore from google.api import launch_stage_pb2 # type: ignore from google.api_core import operation # type: ignore from google.api_core import operation_async # type: ignore from cloudsdk.google.protobuf import timestamp_pb2 # type: ignore from googlecloudsdk.generated_clients.gapic_clients.run_v2.services.executions import pagers from googlecloudsdk.generated_clients.gapic_clients.run_v2.types import condition from googlecloudsdk.generated_clients.gapic_clients.run_v2.types import execution from googlecloudsdk.generated_clients.gapic_clients.run_v2.types import task_template from .transports.base import ExecutionsTransport, DEFAULT_CLIENT_INFO from .transports.grpc_asyncio import ExecutionsGrpcAsyncIOTransport from .client import ExecutionsClient 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 = std_logging.getLogger(__name__) class ExecutionsAsyncClient: """Cloud Run Execution Control Plane API.""" _client: ExecutionsClient # Copy defaults from the synchronous client for use here. # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead. DEFAULT_ENDPOINT = ExecutionsClient.DEFAULT_ENDPOINT DEFAULT_MTLS_ENDPOINT = ExecutionsClient.DEFAULT_MTLS_ENDPOINT _DEFAULT_ENDPOINT_TEMPLATE = ExecutionsClient._DEFAULT_ENDPOINT_TEMPLATE _DEFAULT_UNIVERSE = ExecutionsClient._DEFAULT_UNIVERSE connector_path = staticmethod(ExecutionsClient.connector_path) parse_connector_path = staticmethod(ExecutionsClient.parse_connector_path) crypto_key_path = staticmethod(ExecutionsClient.crypto_key_path) parse_crypto_key_path = staticmethod(ExecutionsClient.parse_crypto_key_path) execution_path = staticmethod(ExecutionsClient.execution_path) parse_execution_path = staticmethod(ExecutionsClient.parse_execution_path) job_path = staticmethod(ExecutionsClient.job_path) parse_job_path = staticmethod(ExecutionsClient.parse_job_path) secret_path = staticmethod(ExecutionsClient.secret_path) parse_secret_path = staticmethod(ExecutionsClient.parse_secret_path) secret_version_path = staticmethod(ExecutionsClient.secret_version_path) parse_secret_version_path = staticmethod(ExecutionsClient.parse_secret_version_path) common_billing_account_path = staticmethod(ExecutionsClient.common_billing_account_path) parse_common_billing_account_path = staticmethod(ExecutionsClient.parse_common_billing_account_path) common_folder_path = staticmethod(ExecutionsClient.common_folder_path) parse_common_folder_path = staticmethod(ExecutionsClient.parse_common_folder_path) common_organization_path = staticmethod(ExecutionsClient.common_organization_path) parse_common_organization_path = staticmethod(ExecutionsClient.parse_common_organization_path) common_project_path = staticmethod(ExecutionsClient.common_project_path) parse_common_project_path = staticmethod(ExecutionsClient.parse_common_project_path) common_location_path = staticmethod(ExecutionsClient.common_location_path) parse_common_location_path = staticmethod(ExecutionsClient.parse_common_location_path) @classmethod def from_service_account_info(cls, info: dict, *args, **kwargs): """Creates an instance of this client using the provided credentials info. Args: info (dict): The service account private key info. args: Additional arguments to pass to the constructor. kwargs: Additional arguments to pass to the constructor. Returns: ExecutionsAsyncClient: The constructed client. """ return ExecutionsClient.from_service_account_info.__func__(ExecutionsAsyncClient, info, *args, **kwargs) # type: ignore @classmethod def from_service_account_file(cls, filename: str, *args, **kwargs): """Creates an instance of this client using the provided credentials file. Args: filename (str): The path to the service account private key json file. args: Additional arguments to pass to the constructor. kwargs: Additional arguments to pass to the constructor. Returns: ExecutionsAsyncClient: The constructed client. """ return ExecutionsClient.from_service_account_file.__func__(ExecutionsAsyncClient, filename, *args, **kwargs) # type: ignore 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 variable 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 ExecutionsClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore @property def transport(self) -> ExecutionsTransport: """Returns the transport used by the client instance. Returns: ExecutionsTransport: The transport used by the client instance. """ 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 = ExecutionsClient.get_transport_class def __init__(self, *, credentials: Optional[ga_credentials.Credentials] = None, transport: Optional[Union[str, ExecutionsTransport, Callable[..., ExecutionsTransport]]] = "grpc_asyncio", client_options: Optional[ClientOptions] = None, client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, ) -> None: """Instantiates the executions async client. Args: 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. transport (Optional[Union[str,ExecutionsTransport,Callable[..., ExecutionsTransport]]]): The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the ExecutionsTransport constructor. If set to None, a transport is chosen automatically. NOTE: "rest" transport functionality is currently in a beta state (preview). We welcome your feedback via an issue in this library's source repository. 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). 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the ``client_cert_source`` property can be used 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. """ self._client = ExecutionsClient( credentials=credentials, transport=transport, client_options=client_options, client_info=client_info, ) if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(std_logging.DEBUG): # pragma: NO COVER _LOGGER.debug( "Created client `google.cloud.run_v2.ExecutionsAsyncClient`.", extra = { "serviceName": "google.cloud.run.v2.Executions", "universeDomain": getattr(self._client._transport._credentials, "universe_domain", ""), "credentialsType": f"{type(self._client._transport._credentials).__module__}.{type(self._client._transport._credentials).__qualname__}", "credentialsInfo": getattr(self.transport._credentials, "get_cred_info", lambda: None)(), } if hasattr(self._client._transport, "_credentials") else { "serviceName": "google.cloud.run.v2.Executions", "credentialsType": None, } ) async def get_execution(self, request: Optional[Union[execution.GetExecutionRequest, dict]] = None, *, name: Optional[str] = None, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> execution.Execution: r"""Gets information about an Execution. .. code-block:: python # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from googlecloudsdk.generated_clients.gapic_clients import run_v2 async def sample_get_execution(): # Create a client client = run_v2.ExecutionsAsyncClient() # Initialize request argument(s) request = run_v2.GetExecutionRequest( name="name_value", ) # Make the request response = await client.get_execution(request=request) # Handle the response print(response) Args: request (Optional[Union[googlecloudsdk.generated_clients.gapic_clients.run_v2.types.GetExecutionRequest, dict]]): The request object. Request message for obtaining a Execution by its full name. name (:class:`str`): Required. The full name of the Execution. Format: ``projects/{project}/locations/{location}/jobs/{job}/executions/{execution}``, where ``{project}`` can be project id or number. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this should not be set. retry (google.api_core.retry_async.AsyncRetry): 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: googlecloudsdk.generated_clients.gapic_clients.run_v2.types.Execution: Execution represents the configuration of a single execution. A execution an immutable resource that references a container image which is run to completion. """ # Create or coerce a protobuf request object. # - Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. flattened_params = [name] has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 if request is not None and has_flattened_params: raise ValueError("If the `request` argument is set, then none of " "the individual field arguments should be set.") # - Use the request object if provided (there's no risk of modifying the input as # there are no flattened fields), or create one. if not isinstance(request, execution.GetExecutionRequest): request = execution.GetExecutionRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if name is not None: request.name = name # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = self._client._transport._wrapped_methods[self._client._transport.get_execution] # Certain fields should be provided within the metadata header; # add these here. metadata = tuple(metadata) + ( 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, retry=retry, timeout=timeout, metadata=metadata, ) # Done; return the response. return response async def list_executions(self, request: Optional[Union[execution.ListExecutionsRequest, dict]] = None, *, parent: Optional[str] = None, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> pagers.ListExecutionsAsyncPager: r"""Lists Executions from a Job. Results are sorted by creation time, descending. .. code-block:: python # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from googlecloudsdk.generated_clients.gapic_clients import run_v2 async def sample_list_executions(): # Create a client client = run_v2.ExecutionsAsyncClient() # Initialize request argument(s) request = run_v2.ListExecutionsRequest( parent="parent_value", ) # Make the request page_result = client.list_executions(request=request) # Handle the response async for response in page_result: print(response) Args: request (Optional[Union[googlecloudsdk.generated_clients.gapic_clients.run_v2.types.ListExecutionsRequest, dict]]): The request object. Request message for retrieving a list of Executions. parent (:class:`str`): Required. The Execution from which the Executions should be listed. To list all Executions across Jobs, use "-" instead of Job name. Format: ``projects/{project}/locations/{location}/jobs/{job}``, where ``{project}`` can be project id or number. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this should not be set. retry (google.api_core.retry_async.AsyncRetry): 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: googlecloudsdk.generated_clients.gapic_clients.run_v2.services.executions.pagers.ListExecutionsAsyncPager: Response message containing a list of Executions. Iterating over this object will yield results and resolve additional pages automatically. """ # Create or coerce a protobuf request object. # - Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. flattened_params = [parent] has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 if request is not None and has_flattened_params: raise ValueError("If the `request` argument is set, then none of " "the individual field arguments should be set.") # - Use the request object if provided (there's no risk of modifying the input as # there are no flattened fields), or create one. if not isinstance(request, execution.ListExecutionsRequest): request = execution.ListExecutionsRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if parent is not None: request.parent = parent # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = self._client._transport._wrapped_methods[self._client._transport.list_executions] # Certain fields should be provided within the metadata header; # add these here. metadata = tuple(metadata) + ( gapic_v1.routing_header.to_grpc_metadata(( ("parent", request.parent), )), ) # Validate the universe domain. self._client._validate_universe_domain() # Send the request. response = await rpc( request, retry=retry, timeout=timeout, metadata=metadata, ) # This method is paged; wrap the response in a pager, which provides # an `__aiter__` convenience method. response = pagers.ListExecutionsAsyncPager( method=rpc, request=request, response=response, retry=retry, timeout=timeout, metadata=metadata, ) # Done; return the response. return response async def delete_execution(self, request: Optional[Union[execution.DeleteExecutionRequest, dict]] = None, *, name: Optional[str] = None, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: r"""Deletes an Execution. .. code-block:: python # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from googlecloudsdk.generated_clients.gapic_clients import run_v2 async def sample_delete_execution(): # Create a client client = run_v2.ExecutionsAsyncClient() # Initialize request argument(s) request = run_v2.DeleteExecutionRequest( name="name_value", ) # Make the request operation = client.delete_execution(request=request) print("Waiting for operation to complete...") response = (await operation).result() # Handle the response print(response) Args: request (Optional[Union[googlecloudsdk.generated_clients.gapic_clients.run_v2.types.DeleteExecutionRequest, dict]]): The request object. Request message for deleting an Execution. name (:class:`str`): Required. The name of the Execution to delete. Format: ``projects/{project}/locations/{location}/jobs/{job}/executions/{execution}``, where ``{project}`` can be project id or number. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this should not be set. retry (google.api_core.retry_async.AsyncRetry): 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: google.api_core.operation_async.AsyncOperation: An object representing a long-running operation. The result type for the operation will be :class:`googlecloudsdk.generated_clients.gapic_clients.run_v2.types.Execution` Execution represents the configuration of a single execution. A execution an immutable resource that references a container image which is run to completion. """ # Create or coerce a protobuf request object. # - Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. flattened_params = [name] has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 if request is not None and has_flattened_params: raise ValueError("If the `request` argument is set, then none of " "the individual field arguments should be set.") # - Use the request object if provided (there's no risk of modifying the input as # there are no flattened fields), or create one. if not isinstance(request, execution.DeleteExecutionRequest): request = execution.DeleteExecutionRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if name is not None: request.name = name # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = self._client._transport._wrapped_methods[self._client._transport.delete_execution] # Certain fields should be provided within the metadata header; # add these here. metadata = tuple(metadata) + ( 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, retry=retry, timeout=timeout, metadata=metadata, ) # Wrap the response in an operation future. response = operation_async.from_gapic( response, self._client._transport.operations_client, execution.Execution, metadata_type=execution.Execution, ) # Done; return the response. return response async def cancel_execution(self, request: Optional[Union[execution.CancelExecutionRequest, dict]] = None, *, name: Optional[str] = None, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), ) -> operation_async.AsyncOperation: r"""Cancels an Execution. .. code-block:: python # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from googlecloudsdk.generated_clients.gapic_clients import run_v2 async def sample_cancel_execution(): # Create a client client = run_v2.ExecutionsAsyncClient() # Initialize request argument(s) request = run_v2.CancelExecutionRequest( name="name_value", ) # Make the request operation = client.cancel_execution(request=request) print("Waiting for operation to complete...") response = (await operation).result() # Handle the response print(response) Args: request (Optional[Union[googlecloudsdk.generated_clients.gapic_clients.run_v2.types.CancelExecutionRequest, dict]]): The request object. Request message for deleting an Execution. name (:class:`str`): Required. The name of the Execution to cancel. Format: ``projects/{project}/locations/{location}/jobs/{job}/executions/{execution}``, where ``{project}`` can be project id or number. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this should not be set. retry (google.api_core.retry_async.AsyncRetry): 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: google.api_core.operation_async.AsyncOperation: An object representing a long-running operation. The result type for the operation will be :class:`googlecloudsdk.generated_clients.gapic_clients.run_v2.types.Execution` Execution represents the configuration of a single execution. A execution an immutable resource that references a container image which is run to completion. """ # Create or coerce a protobuf request object. # - Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. flattened_params = [name] has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 if request is not None and has_flattened_params: raise ValueError("If the `request` argument is set, then none of " "the individual field arguments should be set.") # - Use the request object if provided (there's no risk of modifying the input as # there are no flattened fields), or create one. if not isinstance(request, execution.CancelExecutionRequest): request = execution.CancelExecutionRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if name is not None: request.name = name # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = self._client._transport._wrapped_methods[self._client._transport.cancel_execution] # Certain fields should be provided within the metadata header; # add these here. metadata = tuple(metadata) + ( 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, retry=retry, timeout=timeout, metadata=metadata, ) # Wrap the response in an operation future. response = operation_async.from_gapic( response, self._client._transport.operations_client, execution.Execution, metadata_type=execution.Execution, ) # Done; return the response. return response async def __aenter__(self) -> "ExecutionsAsyncClient": return self async def __aexit__(self, exc_type, exc, tb): await self.transport.close() DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER DEFAULT_CLIENT_INFO.protobuf_runtime_version = cloudsdk.google.protobuf.__version__ __all__ = ( "ExecutionsAsyncClient", )