diff --git a/packages/google-cloud-quotas/docs/cloudquotas_v1beta/cloud_quotas.rst b/packages/google-cloud-quotas/docs/cloudquotas_v1beta/cloud_quotas.rst new file mode 100644 index 000000000000..b203d75a111f --- /dev/null +++ b/packages/google-cloud-quotas/docs/cloudquotas_v1beta/cloud_quotas.rst @@ -0,0 +1,10 @@ +CloudQuotas +----------------------------- + +.. automodule:: google.cloud.cloudquotas_v1beta.services.cloud_quotas + :members: + :inherited-members: + +.. automodule:: google.cloud.cloudquotas_v1beta.services.cloud_quotas.pagers + :members: + :inherited-members: diff --git a/packages/google-cloud-quotas/docs/cloudquotas_v1beta/quota_adjuster_settings_manager.rst b/packages/google-cloud-quotas/docs/cloudquotas_v1beta/quota_adjuster_settings_manager.rst new file mode 100644 index 000000000000..7b7c38f66876 --- /dev/null +++ b/packages/google-cloud-quotas/docs/cloudquotas_v1beta/quota_adjuster_settings_manager.rst @@ -0,0 +1,6 @@ +QuotaAdjusterSettingsManager +---------------------------------------------- + +.. automodule:: google.cloud.cloudquotas_v1beta.services.quota_adjuster_settings_manager + :members: + :inherited-members: diff --git a/packages/google-cloud-quotas/docs/cloudquotas_v1beta/services_.rst b/packages/google-cloud-quotas/docs/cloudquotas_v1beta/services_.rst new file mode 100644 index 000000000000..1ee2bd84c089 --- /dev/null +++ b/packages/google-cloud-quotas/docs/cloudquotas_v1beta/services_.rst @@ -0,0 +1,7 @@ +Services for Google Cloud Cloudquotas v1beta API +================================================ +.. toctree:: + :maxdepth: 2 + + cloud_quotas + quota_adjuster_settings_manager diff --git a/packages/google-cloud-quotas/docs/cloudquotas_v1beta/types_.rst b/packages/google-cloud-quotas/docs/cloudquotas_v1beta/types_.rst new file mode 100644 index 000000000000..ed8f11f70362 --- /dev/null +++ b/packages/google-cloud-quotas/docs/cloudquotas_v1beta/types_.rst @@ -0,0 +1,6 @@ +Types for Google Cloud Cloudquotas v1beta API +============================================= + +.. automodule:: google.cloud.cloudquotas_v1beta.types + :members: + :show-inheritance: diff --git a/packages/google-cloud-quotas/docs/index.rst b/packages/google-cloud-quotas/docs/index.rst index 84d8ca576a4c..d3154683073d 100644 --- a/packages/google-cloud-quotas/docs/index.rst +++ b/packages/google-cloud-quotas/docs/index.rst @@ -2,6 +2,9 @@ .. include:: multiprocessing.rst +This package includes clients for multiple versions of Cloud Quotas API. +By default, you will get version ``cloudquotas_v1``. + API Reference ------------- @@ -11,6 +14,14 @@ API Reference cloudquotas_v1/services_ cloudquotas_v1/types_ +API Reference +------------- +.. toctree:: + :maxdepth: 2 + + cloudquotas_v1beta/services_ + cloudquotas_v1beta/types_ + Changelog --------- diff --git a/packages/google-cloud-quotas/google/cloud/cloudquotas/gapic_version.py b/packages/google-cloud-quotas/google/cloud/cloudquotas/gapic_version.py index 7a4d810a47da..558c8aab67c5 100644 --- a/packages/google-cloud-quotas/google/cloud/cloudquotas/gapic_version.py +++ b/packages/google-cloud-quotas/google/cloud/cloudquotas/gapic_version.py @@ -13,4 +13,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # -__version__ = "0.1.14" # {x-release-please-version} +__version__ = "0.0.0" # {x-release-please-version} diff --git a/packages/google-cloud-quotas/google/cloud/cloudquotas_v1/gapic_version.py b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1/gapic_version.py index 7a4d810a47da..558c8aab67c5 100644 --- a/packages/google-cloud-quotas/google/cloud/cloudquotas_v1/gapic_version.py +++ b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1/gapic_version.py @@ -13,4 +13,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # -__version__ = "0.1.14" # {x-release-please-version} +__version__ = "0.0.0" # {x-release-please-version} diff --git a/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/__init__.py b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/__init__.py new file mode 100644 index 000000000000..e885b14ee379 --- /dev/null +++ b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/__init__.py @@ -0,0 +1,76 @@ +# -*- coding: utf-8 -*- +# 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. +# 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. +# +from google.cloud.cloudquotas_v1beta import gapic_version as package_version + +__version__ = package_version.__version__ + + +from .services.cloud_quotas import CloudQuotasAsyncClient, CloudQuotasClient +from .services.quota_adjuster_settings_manager import ( + QuotaAdjusterSettingsManagerAsyncClient, + QuotaAdjusterSettingsManagerClient, +) +from .types.cloudquotas import ( + CreateQuotaPreferenceRequest, + GetQuotaInfoRequest, + GetQuotaPreferenceRequest, + ListQuotaInfosRequest, + ListQuotaInfosResponse, + ListQuotaPreferencesRequest, + ListQuotaPreferencesResponse, + UpdateQuotaPreferenceRequest, +) +from .types.quota_adjuster_settings import ( + GetQuotaAdjusterSettingsRequest, + QuotaAdjusterSettings, + UpdateQuotaAdjusterSettingsRequest, +) +from .types.resources import ( + DimensionsInfo, + QuotaConfig, + QuotaDetails, + QuotaIncreaseEligibility, + QuotaInfo, + QuotaPreference, + QuotaSafetyCheck, + RolloutInfo, +) + +__all__ = ( + "CloudQuotasAsyncClient", + "QuotaAdjusterSettingsManagerAsyncClient", + "CloudQuotasClient", + "CreateQuotaPreferenceRequest", + "DimensionsInfo", + "GetQuotaAdjusterSettingsRequest", + "GetQuotaInfoRequest", + "GetQuotaPreferenceRequest", + "ListQuotaInfosRequest", + "ListQuotaInfosResponse", + "ListQuotaPreferencesRequest", + "ListQuotaPreferencesResponse", + "QuotaAdjusterSettings", + "QuotaAdjusterSettingsManagerClient", + "QuotaConfig", + "QuotaDetails", + "QuotaIncreaseEligibility", + "QuotaInfo", + "QuotaPreference", + "QuotaSafetyCheck", + "RolloutInfo", + "UpdateQuotaAdjusterSettingsRequest", + "UpdateQuotaPreferenceRequest", +) diff --git a/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/gapic_metadata.json b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/gapic_metadata.json new file mode 100644 index 000000000000..6a2036b411df --- /dev/null +++ b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/gapic_metadata.json @@ -0,0 +1,167 @@ + { + "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", + "language": "python", + "libraryPackage": "google.cloud.cloudquotas_v1beta", + "protoPackage": "google.api.cloudquotas.v1beta", + "schema": "1.0", + "services": { + "CloudQuotas": { + "clients": { + "grpc": { + "libraryClient": "CloudQuotasClient", + "rpcs": { + "CreateQuotaPreference": { + "methods": [ + "create_quota_preference" + ] + }, + "GetQuotaInfo": { + "methods": [ + "get_quota_info" + ] + }, + "GetQuotaPreference": { + "methods": [ + "get_quota_preference" + ] + }, + "ListQuotaInfos": { + "methods": [ + "list_quota_infos" + ] + }, + "ListQuotaPreferences": { + "methods": [ + "list_quota_preferences" + ] + }, + "UpdateQuotaPreference": { + "methods": [ + "update_quota_preference" + ] + } + } + }, + "grpc-async": { + "libraryClient": "CloudQuotasAsyncClient", + "rpcs": { + "CreateQuotaPreference": { + "methods": [ + "create_quota_preference" + ] + }, + "GetQuotaInfo": { + "methods": [ + "get_quota_info" + ] + }, + "GetQuotaPreference": { + "methods": [ + "get_quota_preference" + ] + }, + "ListQuotaInfos": { + "methods": [ + "list_quota_infos" + ] + }, + "ListQuotaPreferences": { + "methods": [ + "list_quota_preferences" + ] + }, + "UpdateQuotaPreference": { + "methods": [ + "update_quota_preference" + ] + } + } + }, + "rest": { + "libraryClient": "CloudQuotasClient", + "rpcs": { + "CreateQuotaPreference": { + "methods": [ + "create_quota_preference" + ] + }, + "GetQuotaInfo": { + "methods": [ + "get_quota_info" + ] + }, + "GetQuotaPreference": { + "methods": [ + "get_quota_preference" + ] + }, + "ListQuotaInfos": { + "methods": [ + "list_quota_infos" + ] + }, + "ListQuotaPreferences": { + "methods": [ + "list_quota_preferences" + ] + }, + "UpdateQuotaPreference": { + "methods": [ + "update_quota_preference" + ] + } + } + } + } + }, + "QuotaAdjusterSettingsManager": { + "clients": { + "grpc": { + "libraryClient": "QuotaAdjusterSettingsManagerClient", + "rpcs": { + "GetQuotaAdjusterSettings": { + "methods": [ + "get_quota_adjuster_settings" + ] + }, + "UpdateQuotaAdjusterSettings": { + "methods": [ + "update_quota_adjuster_settings" + ] + } + } + }, + "grpc-async": { + "libraryClient": "QuotaAdjusterSettingsManagerAsyncClient", + "rpcs": { + "GetQuotaAdjusterSettings": { + "methods": [ + "get_quota_adjuster_settings" + ] + }, + "UpdateQuotaAdjusterSettings": { + "methods": [ + "update_quota_adjuster_settings" + ] + } + } + }, + "rest": { + "libraryClient": "QuotaAdjusterSettingsManagerClient", + "rpcs": { + "GetQuotaAdjusterSettings": { + "methods": [ + "get_quota_adjuster_settings" + ] + }, + "UpdateQuotaAdjusterSettings": { + "methods": [ + "update_quota_adjuster_settings" + ] + } + } + } + } + } + } +} diff --git a/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/gapic_version.py b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/gapic_version.py new file mode 100644 index 000000000000..558c8aab67c5 --- /dev/null +++ b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# 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. +# 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. +# +__version__ = "0.0.0" # {x-release-please-version} diff --git a/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/py.typed b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/py.typed new file mode 100644 index 000000000000..13b6e7a7c797 --- /dev/null +++ b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-quotas package uses inline types. diff --git a/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/__init__.py b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/__init__.py new file mode 100644 index 000000000000..8f6cf068242c --- /dev/null +++ b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# 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. +# 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. +# diff --git a/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/cloud_quotas/__init__.py b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/cloud_quotas/__init__.py new file mode 100644 index 000000000000..ae38dafef437 --- /dev/null +++ b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/cloud_quotas/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# 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. +# 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. +# +from .async_client import CloudQuotasAsyncClient +from .client import CloudQuotasClient + +__all__ = ( + "CloudQuotasClient", + "CloudQuotasAsyncClient", +) diff --git a/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/cloud_quotas/async_client.py b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/cloud_quotas/async_client.py new file mode 100644 index 000000000000..d83c6a4a9dfa --- /dev/null +++ b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/cloud_quotas/async_client.py @@ -0,0 +1,1074 @@ +# -*- coding: utf-8 -*- +# 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. +# 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. +# +from collections import OrderedDict +import logging as std_logging +import re +from typing import ( + Callable, + Dict, + Mapping, + MutableMapping, + MutableSequence, + Optional, + Sequence, + Tuple, + Type, + Union, +) + +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.api_core.client_options import ClientOptions +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.cloudquotas_v1beta import gapic_version as package_version + +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.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore + +from google.cloud.cloudquotas_v1beta.services.cloud_quotas import pagers +from google.cloud.cloudquotas_v1beta.types import cloudquotas, resources + +from .client import CloudQuotasClient +from .transports.base import DEFAULT_CLIENT_INFO, CloudQuotasTransport +from .transports.grpc_asyncio import CloudQuotasGrpcAsyncIOTransport + +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 CloudQuotasAsyncClient: + """The Cloud Quotas API is an infrastructure service for Google + Cloud that lets service consumers list and manage their resource + usage limits. + + - List/Get the metadata and current status of the quotas for a + service. + - Create/Update quota preferencess that declare the preferred + quota values. + - Check the status of a quota preference request. + - List/Get pending and historical quota preference. + """ + + _client: CloudQuotasClient + + # Copy defaults from the synchronous client for use here. + # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead. + DEFAULT_ENDPOINT = CloudQuotasClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = CloudQuotasClient.DEFAULT_MTLS_ENDPOINT + _DEFAULT_ENDPOINT_TEMPLATE = CloudQuotasClient._DEFAULT_ENDPOINT_TEMPLATE + _DEFAULT_UNIVERSE = CloudQuotasClient._DEFAULT_UNIVERSE + + quota_info_path = staticmethod(CloudQuotasClient.quota_info_path) + parse_quota_info_path = staticmethod(CloudQuotasClient.parse_quota_info_path) + quota_preference_path = staticmethod(CloudQuotasClient.quota_preference_path) + parse_quota_preference_path = staticmethod( + CloudQuotasClient.parse_quota_preference_path + ) + common_billing_account_path = staticmethod( + CloudQuotasClient.common_billing_account_path + ) + parse_common_billing_account_path = staticmethod( + CloudQuotasClient.parse_common_billing_account_path + ) + common_folder_path = staticmethod(CloudQuotasClient.common_folder_path) + parse_common_folder_path = staticmethod(CloudQuotasClient.parse_common_folder_path) + common_organization_path = staticmethod(CloudQuotasClient.common_organization_path) + parse_common_organization_path = staticmethod( + CloudQuotasClient.parse_common_organization_path + ) + common_project_path = staticmethod(CloudQuotasClient.common_project_path) + parse_common_project_path = staticmethod( + CloudQuotasClient.parse_common_project_path + ) + common_location_path = staticmethod(CloudQuotasClient.common_location_path) + parse_common_location_path = staticmethod( + CloudQuotasClient.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: + CloudQuotasAsyncClient: The constructed client. + """ + return CloudQuotasClient.from_service_account_info.__func__(CloudQuotasAsyncClient, 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: + CloudQuotasAsyncClient: The constructed client. + """ + return CloudQuotasClient.from_service_account_file.__func__(CloudQuotasAsyncClient, 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 CloudQuotasClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore + + @property + def transport(self) -> CloudQuotasTransport: + """Returns the transport used by the client instance. + + Returns: + CloudQuotasTransport: 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 = CloudQuotasClient.get_transport_class + + def __init__( + self, + *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Optional[ + Union[str, CloudQuotasTransport, Callable[..., CloudQuotasTransport]] + ] = "grpc_asyncio", + client_options: Optional[ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the cloud quotas 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,CloudQuotasTransport,Callable[..., CloudQuotasTransport]]]): + 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 CloudQuotasTransport constructor. + If set to None, a transport is chosen automatically. + 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 = CloudQuotasClient( + 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.api.cloudquotas_v1beta.CloudQuotasAsyncClient`.", + extra={ + "serviceName": "google.api.cloudquotas.v1beta.CloudQuotas", + "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.api.cloudquotas.v1beta.CloudQuotas", + "credentialsType": None, + }, + ) + + async def list_quota_infos( + self, + request: Optional[Union[cloudquotas.ListQuotaInfosRequest, 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.ListQuotaInfosAsyncPager: + r"""Lists QuotaInfos of all quotas for a given project, + folder or organization. + + .. 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 google.cloud import cloudquotas_v1beta + + async def sample_list_quota_infos(): + # Create a client + client = cloudquotas_v1beta.CloudQuotasAsyncClient() + + # Initialize request argument(s) + request = cloudquotas_v1beta.ListQuotaInfosRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_quota_infos(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.cloudquotas_v1beta.types.ListQuotaInfosRequest, dict]]): + The request object. Message for requesting list of + QuotaInfos + parent (:class:`str`): + Required. Parent value of QuotaInfo resources. Listing + across different resource containers (such as + 'projects/-') is not allowed. + + Example names: + ``projects/123/locations/global/services/compute.googleapis.com`` + ``folders/234/locations/global/services/compute.googleapis.com`` + ``organizations/345/locations/global/services/compute.googleapis.com`` + + 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: + google.cloud.cloudquotas_v1beta.services.cloud_quotas.pagers.ListQuotaInfosAsyncPager: + Message for response to listing + QuotaInfos + 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. + has_flattened_params = any([parent]) + 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, cloudquotas.ListQuotaInfosRequest): + request = cloudquotas.ListQuotaInfosRequest(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_quota_infos + ] + + # 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.ListQuotaInfosAsyncPager( + method=rpc, + request=request, + response=response, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_quota_info( + self, + request: Optional[Union[cloudquotas.GetQuotaInfoRequest, 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]]] = (), + ) -> resources.QuotaInfo: + r"""Retrieve the QuotaInfo of a quota for a project, + folder or organization. + + .. 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 google.cloud import cloudquotas_v1beta + + async def sample_get_quota_info(): + # Create a client + client = cloudquotas_v1beta.CloudQuotasAsyncClient() + + # Initialize request argument(s) + request = cloudquotas_v1beta.GetQuotaInfoRequest( + name="name_value", + ) + + # Make the request + response = await client.get_quota_info(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.cloudquotas_v1beta.types.GetQuotaInfoRequest, dict]]): + The request object. Message for getting a QuotaInfo + name (:class:`str`): + Required. The resource name of the quota info. + + An example name: + ``projects/123/locations/global/services/compute.googleapis.com/quotaInfos/CpusPerProjectPerRegion`` + + 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.cloud.cloudquotas_v1beta.types.QuotaInfo: + QuotaInfo represents information + about a particular quota for a given + project, folder or organization. + + """ + # 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. + has_flattened_params = any([name]) + 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, cloudquotas.GetQuotaInfoRequest): + request = cloudquotas.GetQuotaInfoRequest(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_quota_info + ] + + # 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_quota_preferences( + self, + request: Optional[Union[cloudquotas.ListQuotaPreferencesRequest, 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.ListQuotaPreferencesAsyncPager: + r"""Lists QuotaPreferences in a given project, folder or + organization. + + .. 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 google.cloud import cloudquotas_v1beta + + async def sample_list_quota_preferences(): + # Create a client + client = cloudquotas_v1beta.CloudQuotasAsyncClient() + + # Initialize request argument(s) + request = cloudquotas_v1beta.ListQuotaPreferencesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_quota_preferences(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.cloudquotas_v1beta.types.ListQuotaPreferencesRequest, dict]]): + The request object. Message for requesting list of + QuotaPreferences + parent (:class:`str`): + Required. Parent value of QuotaPreference resources. + Listing across different resource containers (such as + 'projects/-') is not allowed. + + When the value starts with 'folders' or 'organizations', + it lists the QuotaPreferences for org quotas in the + container. It does not list the QuotaPreferences in the + descendant projects of the container. + + Example parents: ``projects/123/locations/global`` + + 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: + google.cloud.cloudquotas_v1beta.services.cloud_quotas.pagers.ListQuotaPreferencesAsyncPager: + Message for response to listing + QuotaPreferences + 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. + has_flattened_params = any([parent]) + 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, cloudquotas.ListQuotaPreferencesRequest): + request = cloudquotas.ListQuotaPreferencesRequest(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_quota_preferences + ] + + # 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.ListQuotaPreferencesAsyncPager( + method=rpc, + request=request, + response=response, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_quota_preference( + self, + request: Optional[Union[cloudquotas.GetQuotaPreferenceRequest, 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]]] = (), + ) -> resources.QuotaPreference: + r"""Gets details of a single QuotaPreference. + + .. 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 google.cloud import cloudquotas_v1beta + + async def sample_get_quota_preference(): + # Create a client + client = cloudquotas_v1beta.CloudQuotasAsyncClient() + + # Initialize request argument(s) + request = cloudquotas_v1beta.GetQuotaPreferenceRequest( + name="name_value", + ) + + # Make the request + response = await client.get_quota_preference(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.cloudquotas_v1beta.types.GetQuotaPreferenceRequest, dict]]): + The request object. Message for getting a QuotaPreference + name (:class:`str`): + Required. Name of the resource + + Example name: + ``projects/123/locations/global/quota_preferences/my-config-for-us-east1`` + + 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.cloud.cloudquotas_v1beta.types.QuotaPreference: + QuotaPreference represents the + preferred quota configuration specified + for a project, folder or organization. + There is only one QuotaPreference + resource for a quota value targeting a + unique set of dimensions. + + """ + # 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. + has_flattened_params = any([name]) + 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, cloudquotas.GetQuotaPreferenceRequest): + request = cloudquotas.GetQuotaPreferenceRequest(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_quota_preference + ] + + # 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 create_quota_preference( + self, + request: Optional[Union[cloudquotas.CreateQuotaPreferenceRequest, dict]] = None, + *, + parent: Optional[str] = None, + quota_preference: Optional[resources.QuotaPreference] = None, + quota_preference_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> resources.QuotaPreference: + r"""Creates a new QuotaPreference that declares the + desired value for a quota. + + .. 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 google.cloud import cloudquotas_v1beta + + async def sample_create_quota_preference(): + # Create a client + client = cloudquotas_v1beta.CloudQuotasAsyncClient() + + # Initialize request argument(s) + quota_preference = cloudquotas_v1beta.QuotaPreference() + quota_preference.quota_config.preferred_value = 1595 + quota_preference.service = "service_value" + quota_preference.quota_id = "quota_id_value" + + request = cloudquotas_v1beta.CreateQuotaPreferenceRequest( + parent="parent_value", + quota_preference=quota_preference, + ) + + # Make the request + response = await client.create_quota_preference(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.cloudquotas_v1beta.types.CreateQuotaPreferenceRequest, dict]]): + The request object. Message for creating a + QuotaPreference + parent (:class:`str`): + Required. Value for parent. + + Example: ``projects/123/locations/global`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + quota_preference (:class:`google.cloud.cloudquotas_v1beta.types.QuotaPreference`): + Required. The resource being created + This corresponds to the ``quota_preference`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + quota_preference_id (:class:`str`): + Optional. Id of the requesting + object, must be unique under its parent. + If client does not set this field, the + service will generate one. + + This corresponds to the ``quota_preference_id`` 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.cloud.cloudquotas_v1beta.types.QuotaPreference: + QuotaPreference represents the + preferred quota configuration specified + for a project, folder or organization. + There is only one QuotaPreference + resource for a quota value targeting a + unique set of dimensions. + + """ + # 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. + has_flattened_params = any([parent, quota_preference, quota_preference_id]) + 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, cloudquotas.CreateQuotaPreferenceRequest): + request = cloudquotas.CreateQuotaPreferenceRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if quota_preference is not None: + request.quota_preference = quota_preference + if quota_preference_id is not None: + request.quota_preference_id = quota_preference_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._client._transport._wrapped_methods[ + self._client._transport.create_quota_preference + ] + + # 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, + ) + + # Done; return the response. + return response + + async def update_quota_preference( + self, + request: Optional[Union[cloudquotas.UpdateQuotaPreferenceRequest, dict]] = None, + *, + quota_preference: Optional[resources.QuotaPreference] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> resources.QuotaPreference: + r"""Updates the parameters of a single QuotaPreference. + It can updates the config in any states, not just the + ones pending approval. + + .. 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 google.cloud import cloudquotas_v1beta + + async def sample_update_quota_preference(): + # Create a client + client = cloudquotas_v1beta.CloudQuotasAsyncClient() + + # Initialize request argument(s) + quota_preference = cloudquotas_v1beta.QuotaPreference() + quota_preference.quota_config.preferred_value = 1595 + quota_preference.service = "service_value" + quota_preference.quota_id = "quota_id_value" + + request = cloudquotas_v1beta.UpdateQuotaPreferenceRequest( + quota_preference=quota_preference, + ) + + # Make the request + response = await client.update_quota_preference(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.cloudquotas_v1beta.types.UpdateQuotaPreferenceRequest, dict]]): + The request object. Message for updating a + QuotaPreference + quota_preference (:class:`google.cloud.cloudquotas_v1beta.types.QuotaPreference`): + Required. The resource being updated + This corresponds to the ``quota_preference`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): + Optional. Field mask is used to specify the fields to be + overwritten in the QuotaPreference resource by the + update. The fields specified in the update_mask are + relative to the resource, not the full request. A field + will be overwritten if it is in the mask. If the user + does not provide a mask then all fields will be + overwritten. + + This corresponds to the ``update_mask`` 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.cloud.cloudquotas_v1beta.types.QuotaPreference: + QuotaPreference represents the + preferred quota configuration specified + for a project, folder or organization. + There is only one QuotaPreference + resource for a quota value targeting a + unique set of dimensions. + + """ + # 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. + has_flattened_params = any([quota_preference, update_mask]) + 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, cloudquotas.UpdateQuotaPreferenceRequest): + request = cloudquotas.UpdateQuotaPreferenceRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if quota_preference is not None: + request.quota_preference = quota_preference + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._client._transport._wrapped_methods[ + self._client._transport.update_quota_preference + ] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("quota_preference.name", request.quota_preference.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 __aenter__(self) -> "CloudQuotasAsyncClient": + 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__ +) + + +__all__ = ("CloudQuotasAsyncClient",) diff --git a/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/cloud_quotas/client.py b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/cloud_quotas/client.py new file mode 100644 index 000000000000..59d8de236aa8 --- /dev/null +++ b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/cloud_quotas/client.py @@ -0,0 +1,1476 @@ +# -*- coding: utf-8 -*- +# 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. +# 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. +# +from collections import OrderedDict +import logging as std_logging +import os +import re +from typing import ( + Callable, + Dict, + Mapping, + MutableMapping, + MutableSequence, + Optional, + Sequence, + Tuple, + Type, + Union, + cast, +) +import warnings + +from google.api_core import client_options as client_options_lib +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.exceptions import MutualTLSChannelError # type: ignore +from google.auth.transport import mtls # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.cloudquotas_v1beta import gapic_version as package_version + +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 = std_logging.getLogger(__name__) + +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore + +from google.cloud.cloudquotas_v1beta.services.cloud_quotas import pagers +from google.cloud.cloudquotas_v1beta.types import cloudquotas, resources + +from .transports.base import DEFAULT_CLIENT_INFO, CloudQuotasTransport +from .transports.grpc import CloudQuotasGrpcTransport +from .transports.grpc_asyncio import CloudQuotasGrpcAsyncIOTransport +from .transports.rest import CloudQuotasRestTransport + + +class CloudQuotasClientMeta(type): + """Metaclass for the CloudQuotas client. + + This provides class-level methods for building and retrieving + support objects (e.g. transport) without polluting the client instance + objects. + """ + + _transport_registry = OrderedDict() # type: Dict[str, Type[CloudQuotasTransport]] + _transport_registry["grpc"] = CloudQuotasGrpcTransport + _transport_registry["grpc_asyncio"] = CloudQuotasGrpcAsyncIOTransport + _transport_registry["rest"] = CloudQuotasRestTransport + + def get_transport_class( + cls, + label: Optional[str] = None, + ) -> Type[CloudQuotasTransport]: + """Returns an appropriate transport class. + + Args: + label: The name of the desired transport. If none is + provided, then the first transport in the registry is used. + + Returns: + The transport class to use. + """ + # If a specific transport is requested, return that one. + if label: + return cls._transport_registry[label] + + # No transport is requested; return the default (that is, the first one + # in the dictionary). + return next(iter(cls._transport_registry.values())) + + +class CloudQuotasClient(metaclass=CloudQuotasClientMeta): + """The Cloud Quotas API is an infrastructure service for Google + Cloud that lets service consumers list and manage their resource + usage limits. + + - List/Get the metadata and current status of the quotas for a + service. + - Create/Update quota preferencess that declare the preferred + quota values. + - Check the status of a quota preference request. + - List/Get pending and historical quota preference. + """ + + @staticmethod + def _get_default_mtls_endpoint(api_endpoint): + """Converts api endpoint to mTLS endpoint. + + Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to + "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. + Args: + api_endpoint (Optional[str]): the api endpoint to convert. + Returns: + str: converted mTLS api endpoint. + """ + if not api_endpoint: + return api_endpoint + + mtls_endpoint_re = re.compile( + r"(?P[^.]+)(?P\.mtls)?(?P\.sandbox)?(?P\.googleapis\.com)?" + ) + + m = mtls_endpoint_re.match(api_endpoint) + name, mtls, sandbox, googledomain = m.groups() + if mtls or not googledomain: + return api_endpoint + + if sandbox: + return api_endpoint.replace( + "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" + ) + + return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") + + # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead. + DEFAULT_ENDPOINT = "cloudquotas.googleapis.com" + DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore + DEFAULT_ENDPOINT + ) + + _DEFAULT_ENDPOINT_TEMPLATE = "cloudquotas.{UNIVERSE_DOMAIN}" + _DEFAULT_UNIVERSE = "googleapis.com" + + @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: + CloudQuotasClient: The constructed client. + """ + credentials = service_account.Credentials.from_service_account_info(info) + kwargs["credentials"] = credentials + return cls(*args, **kwargs) + + @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: + CloudQuotasClient: The constructed client. + """ + credentials = service_account.Credentials.from_service_account_file(filename) + kwargs["credentials"] = credentials + return cls(*args, **kwargs) + + from_service_account_json = from_service_account_file + + @property + def transport(self) -> CloudQuotasTransport: + """Returns the transport used by the client instance. + + Returns: + CloudQuotasTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def quota_info_path( + project: str, + location: str, + service: str, + quota_info: str, + ) -> str: + """Returns a fully-qualified quota_info string.""" + return "projects/{project}/locations/{location}/services/{service}/quotaInfos/{quota_info}".format( + project=project, + location=location, + service=service, + quota_info=quota_info, + ) + + @staticmethod + def parse_quota_info_path(path: str) -> Dict[str, str]: + """Parses a quota_info path into its component segments.""" + m = re.match( + r"^projects/(?P.+?)/locations/(?P.+?)/services/(?P.+?)/quotaInfos/(?P.+?)$", + path, + ) + return m.groupdict() if m else {} + + @staticmethod + def quota_preference_path( + project: str, + location: str, + quota_preference: str, + ) -> str: + """Returns a fully-qualified quota_preference string.""" + return "projects/{project}/locations/{location}/quotaPreferences/{quota_preference}".format( + project=project, + location=location, + quota_preference=quota_preference, + ) + + @staticmethod + def parse_quota_preference_path(path: str) -> Dict[str, str]: + """Parses a quota_preference path into its component segments.""" + m = re.match( + r"^projects/(?P.+?)/locations/(?P.+?)/quotaPreferences/(?P.+?)$", + path, + ) + return m.groupdict() if m else {} + + @staticmethod + def common_billing_account_path( + billing_account: str, + ) -> str: + """Returns a fully-qualified billing_account string.""" + return "billingAccounts/{billing_account}".format( + billing_account=billing_account, + ) + + @staticmethod + def parse_common_billing_account_path(path: str) -> Dict[str, str]: + """Parse a billing_account path into its component segments.""" + m = re.match(r"^billingAccounts/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_folder_path( + folder: str, + ) -> str: + """Returns a fully-qualified folder string.""" + return "folders/{folder}".format( + folder=folder, + ) + + @staticmethod + def parse_common_folder_path(path: str) -> Dict[str, str]: + """Parse a folder path into its component segments.""" + m = re.match(r"^folders/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_organization_path( + organization: str, + ) -> str: + """Returns a fully-qualified organization string.""" + return "organizations/{organization}".format( + organization=organization, + ) + + @staticmethod + def parse_common_organization_path(path: str) -> Dict[str, str]: + """Parse a organization path into its component segments.""" + m = re.match(r"^organizations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_project_path( + project: str, + ) -> str: + """Returns a fully-qualified project string.""" + return "projects/{project}".format( + project=project, + ) + + @staticmethod + def parse_common_project_path(path: str) -> Dict[str, str]: + """Parse a project path into its component segments.""" + m = re.match(r"^projects/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_location_path( + project: str, + location: str, + ) -> str: + """Returns a fully-qualified location string.""" + return "projects/{project}/locations/{location}".format( + project=project, + location=location, + ) + + @staticmethod + def parse_common_location_path(path: str) -> Dict[str, str]: + """Parse a location path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @classmethod + def get_mtls_endpoint_and_cert_source( + cls, client_options: Optional[client_options_lib.ClientOptions] = None + ): + """Deprecated. 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. + """ + + warnings.warn( + "get_mtls_endpoint_and_cert_source is deprecated. Use the api_endpoint property instead.", + DeprecationWarning, + ) + 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 + + @staticmethod + def _read_environment_variables(): + """Returns the environment variables used by the client. + + Returns: + Tuple[bool, str, str]: returns the GOOGLE_API_USE_CLIENT_CERTIFICATE, + GOOGLE_API_USE_MTLS_ENDPOINT, and GOOGLE_CLOUD_UNIVERSE_DOMAIN environment variables. + + Raises: + ValueError: If GOOGLE_API_USE_CLIENT_CERTIFICATE is not + any of ["true", "false"]. + google.auth.exceptions.MutualTLSChannelError: If GOOGLE_API_USE_MTLS_ENDPOINT + is not any of ["auto", "never", "always"]. + """ + use_client_cert = os.getenv( + "GOOGLE_API_USE_CLIENT_CERTIFICATE", "false" + ).lower() + use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto").lower() + universe_domain_env = os.getenv("GOOGLE_CLOUD_UNIVERSE_DOMAIN") + 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`" + ) + return use_client_cert == "true", use_mtls_endpoint, universe_domain_env + + @staticmethod + def _get_client_cert_source(provided_cert_source, use_cert_flag): + """Return the client cert source to be used by the client. + + Args: + provided_cert_source (bytes): The client certificate source provided. + use_cert_flag (bool): A flag indicating whether to use the client certificate. + + Returns: + bytes or None: The client cert source to be used by the client. + """ + client_cert_source = None + if use_cert_flag: + if provided_cert_source: + client_cert_source = provided_cert_source + elif mtls.has_default_client_cert_source(): + client_cert_source = mtls.default_client_cert_source() + return client_cert_source + + @staticmethod + def _get_api_endpoint( + api_override, client_cert_source, universe_domain, use_mtls_endpoint + ): + """Return the API endpoint used by the client. + + Args: + api_override (str): The API endpoint override. If specified, this is always + the return value of this function and the other arguments are not used. + client_cert_source (bytes): The client certificate source used by the client. + universe_domain (str): The universe domain used by the client. + use_mtls_endpoint (str): How to use the mTLS endpoint, which depends also on the other parameters. + Possible values are "always", "auto", or "never". + + Returns: + str: The API endpoint to be used by the client. + """ + if api_override is not None: + api_endpoint = api_override + elif use_mtls_endpoint == "always" or ( + use_mtls_endpoint == "auto" and client_cert_source + ): + _default_universe = CloudQuotasClient._DEFAULT_UNIVERSE + if universe_domain != _default_universe: + raise MutualTLSChannelError( + f"mTLS is not supported in any universe other than {_default_universe}." + ) + api_endpoint = CloudQuotasClient.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = CloudQuotasClient._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=universe_domain + ) + return api_endpoint + + @staticmethod + def _get_universe_domain( + client_universe_domain: Optional[str], universe_domain_env: Optional[str] + ) -> str: + """Return the universe domain used by the client. + + Args: + client_universe_domain (Optional[str]): The universe domain configured via the client options. + universe_domain_env (Optional[str]): The universe domain configured via the "GOOGLE_CLOUD_UNIVERSE_DOMAIN" environment variable. + + Returns: + str: The universe domain to be used by the client. + + Raises: + ValueError: If the universe domain is an empty string. + """ + universe_domain = CloudQuotasClient._DEFAULT_UNIVERSE + if client_universe_domain is not None: + universe_domain = client_universe_domain + elif universe_domain_env is not None: + universe_domain = universe_domain_env + if len(universe_domain.strip()) == 0: + raise ValueError("Universe Domain cannot be an empty string.") + return universe_domain + + def _validate_universe_domain(self): + """Validates client's and credentials' universe domains are consistent. + + Returns: + bool: True iff the configured universe domain is valid. + + Raises: + ValueError: If the configured universe domain is not valid. + """ + + # NOTE (b/349488459): universe validation is disabled until further notice. + return True + + @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._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._universe_domain + + def __init__( + self, + *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Optional[ + Union[str, CloudQuotasTransport, Callable[..., CloudQuotasTransport]] + ] = None, + client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the cloud quotas 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,CloudQuotasTransport,Callable[..., CloudQuotasTransport]]]): + The transport to use, or a Callable that constructs and returns a new transport. + If a Callable is given, it will be called with the same set of initialization + arguments as used in the CloudQuotasTransport constructor. + If set to None, a transport is chosen automatically. + 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 the ``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_options = client_options + if isinstance(self._client_options, dict): + self._client_options = client_options_lib.from_dict(self._client_options) + if self._client_options is None: + self._client_options = client_options_lib.ClientOptions() + self._client_options = cast( + client_options_lib.ClientOptions, self._client_options + ) + + universe_domain_opt = getattr(self._client_options, "universe_domain", None) + + ( + self._use_client_cert, + self._use_mtls_endpoint, + self._universe_domain_env, + ) = CloudQuotasClient._read_environment_variables() + self._client_cert_source = CloudQuotasClient._get_client_cert_source( + self._client_options.client_cert_source, self._use_client_cert + ) + self._universe_domain = CloudQuotasClient._get_universe_domain( + universe_domain_opt, self._universe_domain_env + ) + self._api_endpoint = None # updated below, depending on `transport` + + # Initialize the universe domain validation. + self._is_universe_domain_valid = False + + if CLIENT_LOGGING_SUPPORTED: # pragma: NO COVER + # Setup logging. + client_logging.initialize_logging() + + api_key_value = getattr(self._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. + transport_provided = isinstance(transport, CloudQuotasTransport) + if transport_provided: + # transport is a CloudQuotasTransport instance. + if credentials or self._client_options.credentials_file or api_key_value: + raise ValueError( + "When providing a transport instance, " + "provide its credentials directly." + ) + if self._client_options.scopes: + raise ValueError( + "When providing a transport instance, provide its scopes " + "directly." + ) + self._transport = cast(CloudQuotasTransport, transport) + self._api_endpoint = self._transport.host + + self._api_endpoint = self._api_endpoint or CloudQuotasClient._get_api_endpoint( + self._client_options.api_endpoint, + self._client_cert_source, + self._universe_domain, + self._use_mtls_endpoint, + ) + + if not transport_provided: + 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_init: Union[ + Type[CloudQuotasTransport], Callable[..., CloudQuotasTransport] + ] = ( + CloudQuotasClient.get_transport_class(transport) + if isinstance(transport, str) or transport is None + else cast(Callable[..., CloudQuotasTransport], transport) + ) + # initialize with the provided callable or the passed in class + self._transport = transport_init( + credentials=credentials, + credentials_file=self._client_options.credentials_file, + host=self._api_endpoint, + scopes=self._client_options.scopes, + client_cert_source_for_mtls=self._client_cert_source, + quota_project_id=self._client_options.quota_project_id, + client_info=client_info, + always_use_jwt_access=True, + api_audience=self._client_options.api_audience, + ) + + if "async" not in str(self._transport): + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + std_logging.DEBUG + ): # pragma: NO COVER + _LOGGER.debug( + "Created client `google.api.cloudquotas_v1beta.CloudQuotasClient`.", + extra={ + "serviceName": "google.api.cloudquotas.v1beta.CloudQuotas", + "universeDomain": getattr( + self._transport._credentials, "universe_domain", "" + ), + "credentialsType": f"{type(self._transport._credentials).__module__}.{type(self._transport._credentials).__qualname__}", + "credentialsInfo": getattr( + self.transport._credentials, "get_cred_info", lambda: None + )(), + } + if hasattr(self._transport, "_credentials") + else { + "serviceName": "google.api.cloudquotas.v1beta.CloudQuotas", + "credentialsType": None, + }, + ) + + def list_quota_infos( + self, + request: Optional[Union[cloudquotas.ListQuotaInfosRequest, 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.ListQuotaInfosPager: + r"""Lists QuotaInfos of all quotas for a given project, + folder or organization. + + .. 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 google.cloud import cloudquotas_v1beta + + def sample_list_quota_infos(): + # Create a client + client = cloudquotas_v1beta.CloudQuotasClient() + + # Initialize request argument(s) + request = cloudquotas_v1beta.ListQuotaInfosRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_quota_infos(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.cloudquotas_v1beta.types.ListQuotaInfosRequest, dict]): + The request object. Message for requesting list of + QuotaInfos + parent (str): + Required. Parent value of QuotaInfo resources. Listing + across different resource containers (such as + 'projects/-') is not allowed. + + Example names: + ``projects/123/locations/global/services/compute.googleapis.com`` + ``folders/234/locations/global/services/compute.googleapis.com`` + ``organizations/345/locations/global/services/compute.googleapis.com`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + 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: + google.cloud.cloudquotas_v1beta.services.cloud_quotas.pagers.ListQuotaInfosPager: + Message for response to listing + QuotaInfos + 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. + has_flattened_params = any([parent]) + 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, cloudquotas.ListQuotaInfosRequest): + request = cloudquotas.ListQuotaInfosRequest(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._transport._wrapped_methods[self._transport.list_quota_infos] + + # 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._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.ListQuotaInfosPager( + method=rpc, + request=request, + response=response, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_quota_info( + self, + request: Optional[Union[cloudquotas.GetQuotaInfoRequest, 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]]] = (), + ) -> resources.QuotaInfo: + r"""Retrieve the QuotaInfo of a quota for a project, + folder or organization. + + .. 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 google.cloud import cloudquotas_v1beta + + def sample_get_quota_info(): + # Create a client + client = cloudquotas_v1beta.CloudQuotasClient() + + # Initialize request argument(s) + request = cloudquotas_v1beta.GetQuotaInfoRequest( + name="name_value", + ) + + # Make the request + response = client.get_quota_info(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.cloudquotas_v1beta.types.GetQuotaInfoRequest, dict]): + The request object. Message for getting a QuotaInfo + name (str): + Required. The resource name of the quota info. + + An example name: + ``projects/123/locations/global/services/compute.googleapis.com/quotaInfos/CpusPerProjectPerRegion`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + 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: + google.cloud.cloudquotas_v1beta.types.QuotaInfo: + QuotaInfo represents information + about a particular quota for a given + project, folder or organization. + + """ + # 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. + has_flattened_params = any([name]) + 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, cloudquotas.GetQuotaInfoRequest): + request = cloudquotas.GetQuotaInfoRequest(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._transport._wrapped_methods[self._transport.get_quota_info] + + # 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._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def list_quota_preferences( + self, + request: Optional[Union[cloudquotas.ListQuotaPreferencesRequest, 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.ListQuotaPreferencesPager: + r"""Lists QuotaPreferences in a given project, folder or + organization. + + .. 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 google.cloud import cloudquotas_v1beta + + def sample_list_quota_preferences(): + # Create a client + client = cloudquotas_v1beta.CloudQuotasClient() + + # Initialize request argument(s) + request = cloudquotas_v1beta.ListQuotaPreferencesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_quota_preferences(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.cloudquotas_v1beta.types.ListQuotaPreferencesRequest, dict]): + The request object. Message for requesting list of + QuotaPreferences + parent (str): + Required. Parent value of QuotaPreference resources. + Listing across different resource containers (such as + 'projects/-') is not allowed. + + When the value starts with 'folders' or 'organizations', + it lists the QuotaPreferences for org quotas in the + container. It does not list the QuotaPreferences in the + descendant projects of the container. + + Example parents: ``projects/123/locations/global`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + 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: + google.cloud.cloudquotas_v1beta.services.cloud_quotas.pagers.ListQuotaPreferencesPager: + Message for response to listing + QuotaPreferences + 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. + has_flattened_params = any([parent]) + 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, cloudquotas.ListQuotaPreferencesRequest): + request = cloudquotas.ListQuotaPreferencesRequest(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._transport._wrapped_methods[self._transport.list_quota_preferences] + + # 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._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.ListQuotaPreferencesPager( + method=rpc, + request=request, + response=response, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_quota_preference( + self, + request: Optional[Union[cloudquotas.GetQuotaPreferenceRequest, 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]]] = (), + ) -> resources.QuotaPreference: + r"""Gets details of a single QuotaPreference. + + .. 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 google.cloud import cloudquotas_v1beta + + def sample_get_quota_preference(): + # Create a client + client = cloudquotas_v1beta.CloudQuotasClient() + + # Initialize request argument(s) + request = cloudquotas_v1beta.GetQuotaPreferenceRequest( + name="name_value", + ) + + # Make the request + response = client.get_quota_preference(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.cloudquotas_v1beta.types.GetQuotaPreferenceRequest, dict]): + The request object. Message for getting a QuotaPreference + name (str): + Required. Name of the resource + + Example name: + ``projects/123/locations/global/quota_preferences/my-config-for-us-east1`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + 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: + google.cloud.cloudquotas_v1beta.types.QuotaPreference: + QuotaPreference represents the + preferred quota configuration specified + for a project, folder or organization. + There is only one QuotaPreference + resource for a quota value targeting a + unique set of dimensions. + + """ + # 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. + has_flattened_params = any([name]) + 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, cloudquotas.GetQuotaPreferenceRequest): + request = cloudquotas.GetQuotaPreferenceRequest(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._transport._wrapped_methods[self._transport.get_quota_preference] + + # 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._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def create_quota_preference( + self, + request: Optional[Union[cloudquotas.CreateQuotaPreferenceRequest, dict]] = None, + *, + parent: Optional[str] = None, + quota_preference: Optional[resources.QuotaPreference] = None, + quota_preference_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> resources.QuotaPreference: + r"""Creates a new QuotaPreference that declares the + desired value for a quota. + + .. 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 google.cloud import cloudquotas_v1beta + + def sample_create_quota_preference(): + # Create a client + client = cloudquotas_v1beta.CloudQuotasClient() + + # Initialize request argument(s) + quota_preference = cloudquotas_v1beta.QuotaPreference() + quota_preference.quota_config.preferred_value = 1595 + quota_preference.service = "service_value" + quota_preference.quota_id = "quota_id_value" + + request = cloudquotas_v1beta.CreateQuotaPreferenceRequest( + parent="parent_value", + quota_preference=quota_preference, + ) + + # Make the request + response = client.create_quota_preference(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.cloudquotas_v1beta.types.CreateQuotaPreferenceRequest, dict]): + The request object. Message for creating a + QuotaPreference + parent (str): + Required. Value for parent. + + Example: ``projects/123/locations/global`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + quota_preference (google.cloud.cloudquotas_v1beta.types.QuotaPreference): + Required. The resource being created + This corresponds to the ``quota_preference`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + quota_preference_id (str): + Optional. Id of the requesting + object, must be unique under its parent. + If client does not set this field, the + service will generate one. + + This corresponds to the ``quota_preference_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + 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: + google.cloud.cloudquotas_v1beta.types.QuotaPreference: + QuotaPreference represents the + preferred quota configuration specified + for a project, folder or organization. + There is only one QuotaPreference + resource for a quota value targeting a + unique set of dimensions. + + """ + # 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. + has_flattened_params = any([parent, quota_preference, quota_preference_id]) + 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, cloudquotas.CreateQuotaPreferenceRequest): + request = cloudquotas.CreateQuotaPreferenceRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if quota_preference is not None: + request.quota_preference = quota_preference + if quota_preference_id is not None: + request.quota_preference_id = quota_preference_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_quota_preference] + + # 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._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def update_quota_preference( + self, + request: Optional[Union[cloudquotas.UpdateQuotaPreferenceRequest, dict]] = None, + *, + quota_preference: Optional[resources.QuotaPreference] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> resources.QuotaPreference: + r"""Updates the parameters of a single QuotaPreference. + It can updates the config in any states, not just the + ones pending approval. + + .. 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 google.cloud import cloudquotas_v1beta + + def sample_update_quota_preference(): + # Create a client + client = cloudquotas_v1beta.CloudQuotasClient() + + # Initialize request argument(s) + quota_preference = cloudquotas_v1beta.QuotaPreference() + quota_preference.quota_config.preferred_value = 1595 + quota_preference.service = "service_value" + quota_preference.quota_id = "quota_id_value" + + request = cloudquotas_v1beta.UpdateQuotaPreferenceRequest( + quota_preference=quota_preference, + ) + + # Make the request + response = client.update_quota_preference(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.cloudquotas_v1beta.types.UpdateQuotaPreferenceRequest, dict]): + The request object. Message for updating a + QuotaPreference + quota_preference (google.cloud.cloudquotas_v1beta.types.QuotaPreference): + Required. The resource being updated + This corresponds to the ``quota_preference`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Optional. Field mask is used to specify the fields to be + overwritten in the QuotaPreference resource by the + update. The fields specified in the update_mask are + relative to the resource, not the full request. A field + will be overwritten if it is in the mask. If the user + does not provide a mask then all fields will be + overwritten. + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + 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: + google.cloud.cloudquotas_v1beta.types.QuotaPreference: + QuotaPreference represents the + preferred quota configuration specified + for a project, folder or organization. + There is only one QuotaPreference + resource for a quota value targeting a + unique set of dimensions. + + """ + # 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. + has_flattened_params = any([quota_preference, update_mask]) + 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, cloudquotas.UpdateQuotaPreferenceRequest): + request = cloudquotas.UpdateQuotaPreferenceRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if quota_preference is not None: + request.quota_preference = quota_preference + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.update_quota_preference] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("quota_preference.name", request.quota_preference.name),) + ), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def __enter__(self) -> "CloudQuotasClient": + return self + + def __exit__(self, type, value, traceback): + """Releases underlying transport's resources. + + .. warning:: + ONLY use as a context manager if the transport is NOT shared + with other clients! Exiting the with block will CLOSE the transport + and may cause errors in other clients! + """ + self.transport.close() + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=package_version.__version__ +) + + +__all__ = ("CloudQuotasClient",) diff --git a/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/cloud_quotas/pagers.py b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/cloud_quotas/pagers.py new file mode 100644 index 000000000000..12eb819851e8 --- /dev/null +++ b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/cloud_quotas/pagers.py @@ -0,0 +1,353 @@ +# -*- coding: utf-8 -*- +# 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. +# 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. +# +from typing import ( + Any, + AsyncIterator, + Awaitable, + Callable, + Iterator, + Optional, + Sequence, + Tuple, + Union, +) + +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.api_core import retry_async as retries_async + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None] + OptionalAsyncRetry = Union[ + retries_async.AsyncRetry, gapic_v1.method._MethodDefault, None + ] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object, None] # type: ignore + OptionalAsyncRetry = Union[retries_async.AsyncRetry, object, None] # type: ignore + +from google.cloud.cloudquotas_v1beta.types import cloudquotas, resources + + +class ListQuotaInfosPager: + """A pager for iterating through ``list_quota_infos`` requests. + + This class thinly wraps an initial + :class:`google.cloud.cloudquotas_v1beta.types.ListQuotaInfosResponse` object, and + provides an ``__iter__`` method to iterate through its + ``quota_infos`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListQuotaInfos`` requests and continue to iterate + through the ``quota_infos`` field on the + corresponding responses. + + All the usual :class:`google.cloud.cloudquotas_v1beta.types.ListQuotaInfosResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + + def __init__( + self, + method: Callable[..., cloudquotas.ListQuotaInfosResponse], + request: cloudquotas.ListQuotaInfosRequest, + response: cloudquotas.ListQuotaInfosResponse, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = () + ): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.cloudquotas_v1beta.types.ListQuotaInfosRequest): + The initial request object. + response (google.cloud.cloudquotas_v1beta.types.ListQuotaInfosResponse): + The initial response object. + 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`. + """ + self._method = method + self._request = cloudquotas.ListQuotaInfosRequest(request) + self._response = response + self._retry = retry + self._timeout = timeout + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[cloudquotas.ListQuotaInfosResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method( + self._request, + retry=self._retry, + timeout=self._timeout, + metadata=self._metadata, + ) + yield self._response + + def __iter__(self) -> Iterator[resources.QuotaInfo]: + for page in self.pages: + yield from page.quota_infos + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) + + +class ListQuotaInfosAsyncPager: + """A pager for iterating through ``list_quota_infos`` requests. + + This class thinly wraps an initial + :class:`google.cloud.cloudquotas_v1beta.types.ListQuotaInfosResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``quota_infos`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListQuotaInfos`` requests and continue to iterate + through the ``quota_infos`` field on the + corresponding responses. + + All the usual :class:`google.cloud.cloudquotas_v1beta.types.ListQuotaInfosResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + + def __init__( + self, + method: Callable[..., Awaitable[cloudquotas.ListQuotaInfosResponse]], + request: cloudquotas.ListQuotaInfosRequest, + response: cloudquotas.ListQuotaInfosResponse, + *, + retry: OptionalAsyncRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = () + ): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.cloudquotas_v1beta.types.ListQuotaInfosRequest): + The initial request object. + response (google.cloud.cloudquotas_v1beta.types.ListQuotaInfosResponse): + The initial response object. + retry (google.api_core.retry.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`. + """ + self._method = method + self._request = cloudquotas.ListQuotaInfosRequest(request) + self._response = response + self._retry = retry + self._timeout = timeout + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[cloudquotas.ListQuotaInfosResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method( + self._request, + retry=self._retry, + timeout=self._timeout, + metadata=self._metadata, + ) + yield self._response + + def __aiter__(self) -> AsyncIterator[resources.QuotaInfo]: + async def async_generator(): + async for page in self.pages: + for response in page.quota_infos: + yield response + + return async_generator() + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) + + +class ListQuotaPreferencesPager: + """A pager for iterating through ``list_quota_preferences`` requests. + + This class thinly wraps an initial + :class:`google.cloud.cloudquotas_v1beta.types.ListQuotaPreferencesResponse` object, and + provides an ``__iter__`` method to iterate through its + ``quota_preferences`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListQuotaPreferences`` requests and continue to iterate + through the ``quota_preferences`` field on the + corresponding responses. + + All the usual :class:`google.cloud.cloudquotas_v1beta.types.ListQuotaPreferencesResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + + def __init__( + self, + method: Callable[..., cloudquotas.ListQuotaPreferencesResponse], + request: cloudquotas.ListQuotaPreferencesRequest, + response: cloudquotas.ListQuotaPreferencesResponse, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = () + ): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.cloudquotas_v1beta.types.ListQuotaPreferencesRequest): + The initial request object. + response (google.cloud.cloudquotas_v1beta.types.ListQuotaPreferencesResponse): + The initial response object. + 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`. + """ + self._method = method + self._request = cloudquotas.ListQuotaPreferencesRequest(request) + self._response = response + self._retry = retry + self._timeout = timeout + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[cloudquotas.ListQuotaPreferencesResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method( + self._request, + retry=self._retry, + timeout=self._timeout, + metadata=self._metadata, + ) + yield self._response + + def __iter__(self) -> Iterator[resources.QuotaPreference]: + for page in self.pages: + yield from page.quota_preferences + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) + + +class ListQuotaPreferencesAsyncPager: + """A pager for iterating through ``list_quota_preferences`` requests. + + This class thinly wraps an initial + :class:`google.cloud.cloudquotas_v1beta.types.ListQuotaPreferencesResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``quota_preferences`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListQuotaPreferences`` requests and continue to iterate + through the ``quota_preferences`` field on the + corresponding responses. + + All the usual :class:`google.cloud.cloudquotas_v1beta.types.ListQuotaPreferencesResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + + def __init__( + self, + method: Callable[..., Awaitable[cloudquotas.ListQuotaPreferencesResponse]], + request: cloudquotas.ListQuotaPreferencesRequest, + response: cloudquotas.ListQuotaPreferencesResponse, + *, + retry: OptionalAsyncRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = () + ): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.cloudquotas_v1beta.types.ListQuotaPreferencesRequest): + The initial request object. + response (google.cloud.cloudquotas_v1beta.types.ListQuotaPreferencesResponse): + The initial response object. + retry (google.api_core.retry.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`. + """ + self._method = method + self._request = cloudquotas.ListQuotaPreferencesRequest(request) + self._response = response + self._retry = retry + self._timeout = timeout + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[cloudquotas.ListQuotaPreferencesResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method( + self._request, + retry=self._retry, + timeout=self._timeout, + metadata=self._metadata, + ) + yield self._response + + def __aiter__(self) -> AsyncIterator[resources.QuotaPreference]: + async def async_generator(): + async for page in self.pages: + for response in page.quota_preferences: + yield response + + return async_generator() + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) diff --git a/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/cloud_quotas/transports/README.rst b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/cloud_quotas/transports/README.rst new file mode 100644 index 000000000000..318b0588640f --- /dev/null +++ b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/cloud_quotas/transports/README.rst @@ -0,0 +1,9 @@ + +transport inheritance structure +_______________________________ + +`CloudQuotasTransport` is the ABC for all transports. +- public child `CloudQuotasGrpcTransport` for sync gRPC transport (defined in `grpc.py`). +- public child `CloudQuotasGrpcAsyncIOTransport` for async gRPC transport (defined in `grpc_asyncio.py`). +- private child `_BaseCloudQuotasRestTransport` for base REST transport with inner classes `_BaseMETHOD` (defined in `rest_base.py`). +- public child `CloudQuotasRestTransport` for sync REST transport with inner classes `METHOD` derived from the parent's corresponding `_BaseMETHOD` classes (defined in `rest.py`). diff --git a/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/cloud_quotas/transports/__init__.py b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/cloud_quotas/transports/__init__.py new file mode 100644 index 000000000000..99da65afbbb2 --- /dev/null +++ b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/cloud_quotas/transports/__init__.py @@ -0,0 +1,36 @@ +# -*- coding: utf-8 -*- +# 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. +# 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. +# +from collections import OrderedDict +from typing import Dict, Type + +from .base import CloudQuotasTransport +from .grpc import CloudQuotasGrpcTransport +from .grpc_asyncio import CloudQuotasGrpcAsyncIOTransport +from .rest import CloudQuotasRestInterceptor, CloudQuotasRestTransport + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[CloudQuotasTransport]] +_transport_registry["grpc"] = CloudQuotasGrpcTransport +_transport_registry["grpc_asyncio"] = CloudQuotasGrpcAsyncIOTransport +_transport_registry["rest"] = CloudQuotasRestTransport + +__all__ = ( + "CloudQuotasTransport", + "CloudQuotasGrpcTransport", + "CloudQuotasGrpcAsyncIOTransport", + "CloudQuotasRestTransport", + "CloudQuotasRestInterceptor", +) diff --git a/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/cloud_quotas/transports/base.py b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/cloud_quotas/transports/base.py new file mode 100644 index 000000000000..e49756cb4359 --- /dev/null +++ b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/cloud_quotas/transports/base.py @@ -0,0 +1,291 @@ +# -*- coding: utf-8 -*- +# 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. +# 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 abc +from typing import Awaitable, Callable, Dict, Optional, Sequence, Union + +import google.api_core +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +import google.auth # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.cloudquotas_v1beta import gapic_version as package_version +from google.cloud.cloudquotas_v1beta.types import cloudquotas, resources + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=package_version.__version__ +) + + +class CloudQuotasTransport(abc.ABC): + """Abstract transport class for CloudQuotas.""" + + AUTH_SCOPES = ("https://www.googleapis.com/auth/cloud-platform",) + + DEFAULT_HOST: str = "cloudquotas.googleapis.com" + + def __init__( + self, + *, + host: str = DEFAULT_HOST, + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + **kwargs, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to (default: 'cloudquotas.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]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A list of scopes. + 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're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + """ + + scopes_kwargs = {"scopes": scopes, "default_scopes": self.AUTH_SCOPES} + + # Save the scopes. + self._scopes = scopes + if not hasattr(self, "_ignore_credentials"): + self._ignore_credentials: bool = False + + # If no credentials are provided, then determine the appropriate + # defaults. + if credentials and credentials_file: + raise core_exceptions.DuplicateCredentialArgs( + "'credentials_file' and 'credentials' are mutually exclusive" + ) + + if credentials_file is not None: + credentials, _ = google.auth.load_credentials_from_file( + credentials_file, **scopes_kwargs, quota_project_id=quota_project_id + ) + elif credentials is None and not self._ignore_credentials: + credentials, _ = google.auth.default( + **scopes_kwargs, quota_project_id=quota_project_id + ) + # Don't apply audience if the credentials file passed from user. + if hasattr(credentials, "with_gdch_audience"): + credentials = credentials.with_gdch_audience( + api_audience if api_audience else host + ) + + # If the credentials are service account credentials, then always try to use self signed JWT. + if ( + always_use_jwt_access + and isinstance(credentials, service_account.Credentials) + and hasattr(service_account.Credentials, "with_always_use_jwt_access") + ): + credentials = credentials.with_always_use_jwt_access(True) + + # Save the credentials. + self._credentials = credentials + + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ":" not in host: + host += ":443" + self._host = host + + @property + def host(self): + return self._host + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.list_quota_infos: gapic_v1.method.wrap_method( + self.list_quota_infos, + default_retry=retries.Retry( + initial=1.0, + maximum=10.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.get_quota_info: gapic_v1.method.wrap_method( + self.get_quota_info, + default_retry=retries.Retry( + initial=1.0, + maximum=10.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.list_quota_preferences: gapic_v1.method.wrap_method( + self.list_quota_preferences, + default_retry=retries.Retry( + initial=1.0, + maximum=10.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.get_quota_preference: gapic_v1.method.wrap_method( + self.get_quota_preference, + default_retry=retries.Retry( + initial=1.0, + maximum=10.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.create_quota_preference: gapic_v1.method.wrap_method( + self.create_quota_preference, + default_retry=retries.Retry( + initial=1.0, + maximum=10.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.update_quota_preference: gapic_v1.method.wrap_method( + self.update_quota_preference, + default_retry=retries.Retry( + initial=1.0, + maximum=10.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + } + + def close(self): + """Closes resources associated with the transport. + + .. warning:: + Only call this method if the transport is NOT shared + with other clients - this may cause errors in other clients! + """ + raise NotImplementedError() + + @property + def list_quota_infos( + self, + ) -> Callable[ + [cloudquotas.ListQuotaInfosRequest], + Union[ + cloudquotas.ListQuotaInfosResponse, + Awaitable[cloudquotas.ListQuotaInfosResponse], + ], + ]: + raise NotImplementedError() + + @property + def get_quota_info( + self, + ) -> Callable[ + [cloudquotas.GetQuotaInfoRequest], + Union[resources.QuotaInfo, Awaitable[resources.QuotaInfo]], + ]: + raise NotImplementedError() + + @property + def list_quota_preferences( + self, + ) -> Callable[ + [cloudquotas.ListQuotaPreferencesRequest], + Union[ + cloudquotas.ListQuotaPreferencesResponse, + Awaitable[cloudquotas.ListQuotaPreferencesResponse], + ], + ]: + raise NotImplementedError() + + @property + def get_quota_preference( + self, + ) -> Callable[ + [cloudquotas.GetQuotaPreferenceRequest], + Union[resources.QuotaPreference, Awaitable[resources.QuotaPreference]], + ]: + raise NotImplementedError() + + @property + def create_quota_preference( + self, + ) -> Callable[ + [cloudquotas.CreateQuotaPreferenceRequest], + Union[resources.QuotaPreference, Awaitable[resources.QuotaPreference]], + ]: + raise NotImplementedError() + + @property + def update_quota_preference( + self, + ) -> Callable[ + [cloudquotas.UpdateQuotaPreferenceRequest], + Union[resources.QuotaPreference, Awaitable[resources.QuotaPreference]], + ]: + raise NotImplementedError() + + @property + def kind(self) -> str: + raise NotImplementedError() + + +__all__ = ("CloudQuotasTransport",) diff --git a/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/cloud_quotas/transports/grpc.py b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/cloud_quotas/transports/grpc.py new file mode 100644 index 000000000000..cd957a114e16 --- /dev/null +++ b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/cloud_quotas/transports/grpc.py @@ -0,0 +1,511 @@ +# -*- coding: utf-8 -*- +# 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. +# 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 json +import logging as std_logging +import pickle +from typing import Callable, Dict, Optional, Sequence, Tuple, Union +import warnings + +from google.api_core import gapic_v1, grpc_helpers +import google.auth # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.protobuf.json_format import MessageToJson +import google.protobuf.message +import grpc # type: ignore +import proto # type: ignore + +from google.cloud.cloudquotas_v1beta.types import cloudquotas, resources + +from .base import DEFAULT_CLIENT_INFO, CloudQuotasTransport + +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 _LoggingClientInterceptor(grpc.UnaryUnaryClientInterceptor): # pragma: NO COVER + def intercept_unary_unary(self, continuation, client_call_details, request): + logging_enabled = CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + std_logging.DEBUG + ) + if logging_enabled: # pragma: NO COVER + request_metadata = client_call_details.metadata + if isinstance(request, proto.Message): + request_payload = type(request).to_json(request) + elif isinstance(request, google.protobuf.message.Message): + request_payload = MessageToJson(request) + else: + request_payload = f"{type(request).__name__}: {pickle.dumps(request)}" + + request_metadata = { + key: value.decode("utf-8") if isinstance(value, bytes) else value + for key, value in request_metadata + } + grpc_request = { + "payload": request_payload, + "requestMethod": "grpc", + "metadata": dict(request_metadata), + } + _LOGGER.debug( + f"Sending request for {client_call_details.method}", + extra={ + "serviceName": "google.api.cloudquotas.v1beta.CloudQuotas", + "rpcName": client_call_details.method, + "request": grpc_request, + "metadata": grpc_request["metadata"], + }, + ) + + response = continuation(client_call_details, request) + if logging_enabled: # pragma: NO COVER + response_metadata = response.trailing_metadata() + # Convert gRPC metadata `` to list of tuples + metadata = ( + dict([(k, str(v)) for k, v in response_metadata]) + if response_metadata + else None + ) + result = response.result() + if isinstance(result, proto.Message): + response_payload = type(result).to_json(result) + elif isinstance(result, google.protobuf.message.Message): + response_payload = MessageToJson(result) + else: + response_payload = f"{type(result).__name__}: {pickle.dumps(result)}" + grpc_response = { + "payload": response_payload, + "metadata": metadata, + "status": "OK", + } + _LOGGER.debug( + f"Received response for {client_call_details.method}.", + extra={ + "serviceName": "google.api.cloudquotas.v1beta.CloudQuotas", + "rpcName": client_call_details.method, + "response": grpc_response, + "metadata": grpc_response["metadata"], + }, + ) + return response + + +class CloudQuotasGrpcTransport(CloudQuotasTransport): + """gRPC backend transport for CloudQuotas. + + The Cloud Quotas API is an infrastructure service for Google + Cloud that lets service consumers list and manage their resource + usage limits. + + - List/Get the metadata and current status of the quotas for a + service. + - Create/Update quota preferencess that declare the preferred + quota values. + - Check the status of a quota preference request. + - List/Get pending and historical quota preference. + + 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 protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + + _stubs: Dict[str, Callable] + + def __init__( + self, + *, + host: str = "cloudquotas.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[Union[grpc.Channel, Callable[..., grpc.Channel]]] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = 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, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to (default: 'cloudquotas.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. + This argument is ignored if a ``channel`` instance is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if a ``channel`` instance is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if a ``channel`` instance is provided. + channel (Optional[Union[grpc.Channel, Callable[..., grpc.Channel]]]): + A ``Channel`` instance through which to make calls, or a Callable + that constructs and returns one. If set to None, ``self.create_channel`` + is used to create the channel. If a Callable is given, it will be called + with the same arguments as used in ``self.create_channel``. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if a ``channel`` instance is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if a ``channel`` instance or ``ssl_channel_credentials`` 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're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if isinstance(channel, grpc.Channel): + # Ignore credentials if a channel was passed. + credentials = None + self._ignore_credentials = True + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + # initialize with the provided callable or the default channel + channel_init = channel or type(self).create_channel + self._grpc_channel = channel_init( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + self._interceptor = _LoggingClientInterceptor() + self._logged_channel = grpc.intercept_channel( + self._grpc_channel, self._interceptor + ) + + # Wrap messages. This must be done after self._logged_channel exists + self._prep_wrapped_messages(client_info) + + @classmethod + def create_channel( + cls, + host: str = "cloudquotas.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs, + ) -> grpc.Channel: + """Create and return a gRPC channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + grpc.Channel: A gRPC channel object. + + Raises: + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + + return grpc_helpers.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs, + ) + + @property + def grpc_channel(self) -> grpc.Channel: + """Return the channel designed to connect to this service.""" + return self._grpc_channel + + @property + def list_quota_infos( + self, + ) -> Callable[ + [cloudquotas.ListQuotaInfosRequest], cloudquotas.ListQuotaInfosResponse + ]: + r"""Return a callable for the list quota infos method over gRPC. + + Lists QuotaInfos of all quotas for a given project, + folder or organization. + + Returns: + Callable[[~.ListQuotaInfosRequest], + ~.ListQuotaInfosResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_quota_infos" not in self._stubs: + self._stubs["list_quota_infos"] = self._logged_channel.unary_unary( + "/google.api.cloudquotas.v1beta.CloudQuotas/ListQuotaInfos", + request_serializer=cloudquotas.ListQuotaInfosRequest.serialize, + response_deserializer=cloudquotas.ListQuotaInfosResponse.deserialize, + ) + return self._stubs["list_quota_infos"] + + @property + def get_quota_info( + self, + ) -> Callable[[cloudquotas.GetQuotaInfoRequest], resources.QuotaInfo]: + r"""Return a callable for the get quota info method over gRPC. + + Retrieve the QuotaInfo of a quota for a project, + folder or organization. + + Returns: + Callable[[~.GetQuotaInfoRequest], + ~.QuotaInfo]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_quota_info" not in self._stubs: + self._stubs["get_quota_info"] = self._logged_channel.unary_unary( + "/google.api.cloudquotas.v1beta.CloudQuotas/GetQuotaInfo", + request_serializer=cloudquotas.GetQuotaInfoRequest.serialize, + response_deserializer=resources.QuotaInfo.deserialize, + ) + return self._stubs["get_quota_info"] + + @property + def list_quota_preferences( + self, + ) -> Callable[ + [cloudquotas.ListQuotaPreferencesRequest], + cloudquotas.ListQuotaPreferencesResponse, + ]: + r"""Return a callable for the list quota preferences method over gRPC. + + Lists QuotaPreferences in a given project, folder or + organization. + + Returns: + Callable[[~.ListQuotaPreferencesRequest], + ~.ListQuotaPreferencesResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_quota_preferences" not in self._stubs: + self._stubs["list_quota_preferences"] = self._logged_channel.unary_unary( + "/google.api.cloudquotas.v1beta.CloudQuotas/ListQuotaPreferences", + request_serializer=cloudquotas.ListQuotaPreferencesRequest.serialize, + response_deserializer=cloudquotas.ListQuotaPreferencesResponse.deserialize, + ) + return self._stubs["list_quota_preferences"] + + @property + def get_quota_preference( + self, + ) -> Callable[[cloudquotas.GetQuotaPreferenceRequest], resources.QuotaPreference]: + r"""Return a callable for the get quota preference method over gRPC. + + Gets details of a single QuotaPreference. + + Returns: + Callable[[~.GetQuotaPreferenceRequest], + ~.QuotaPreference]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_quota_preference" not in self._stubs: + self._stubs["get_quota_preference"] = self._logged_channel.unary_unary( + "/google.api.cloudquotas.v1beta.CloudQuotas/GetQuotaPreference", + request_serializer=cloudquotas.GetQuotaPreferenceRequest.serialize, + response_deserializer=resources.QuotaPreference.deserialize, + ) + return self._stubs["get_quota_preference"] + + @property + def create_quota_preference( + self, + ) -> Callable[ + [cloudquotas.CreateQuotaPreferenceRequest], resources.QuotaPreference + ]: + r"""Return a callable for the create quota preference method over gRPC. + + Creates a new QuotaPreference that declares the + desired value for a quota. + + Returns: + Callable[[~.CreateQuotaPreferenceRequest], + ~.QuotaPreference]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "create_quota_preference" not in self._stubs: + self._stubs["create_quota_preference"] = self._logged_channel.unary_unary( + "/google.api.cloudquotas.v1beta.CloudQuotas/CreateQuotaPreference", + request_serializer=cloudquotas.CreateQuotaPreferenceRequest.serialize, + response_deserializer=resources.QuotaPreference.deserialize, + ) + return self._stubs["create_quota_preference"] + + @property + def update_quota_preference( + self, + ) -> Callable[ + [cloudquotas.UpdateQuotaPreferenceRequest], resources.QuotaPreference + ]: + r"""Return a callable for the update quota preference method over gRPC. + + Updates the parameters of a single QuotaPreference. + It can updates the config in any states, not just the + ones pending approval. + + Returns: + Callable[[~.UpdateQuotaPreferenceRequest], + ~.QuotaPreference]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "update_quota_preference" not in self._stubs: + self._stubs["update_quota_preference"] = self._logged_channel.unary_unary( + "/google.api.cloudquotas.v1beta.CloudQuotas/UpdateQuotaPreference", + request_serializer=cloudquotas.UpdateQuotaPreferenceRequest.serialize, + response_deserializer=resources.QuotaPreference.deserialize, + ) + return self._stubs["update_quota_preference"] + + def close(self): + self._logged_channel.close() + + @property + def kind(self) -> str: + return "grpc" + + +__all__ = ("CloudQuotasGrpcTransport",) diff --git a/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/cloud_quotas/transports/grpc_asyncio.py b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/cloud_quotas/transports/grpc_asyncio.py new file mode 100644 index 000000000000..807679dfabef --- /dev/null +++ b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/cloud_quotas/transports/grpc_asyncio.py @@ -0,0 +1,615 @@ +# -*- coding: utf-8 -*- +# 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. +# 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 inspect +import json +import logging as std_logging +import pickle +from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union +import warnings + +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1, grpc_helpers_async +from google.api_core import retry_async as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.protobuf.json_format import MessageToJson +import google.protobuf.message +import grpc # type: ignore +from grpc.experimental import aio # type: ignore +import proto # type: ignore + +from google.cloud.cloudquotas_v1beta.types import cloudquotas, resources + +from .base import DEFAULT_CLIENT_INFO, CloudQuotasTransport +from .grpc import CloudQuotasGrpcTransport + +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 _LoggingClientAIOInterceptor( + grpc.aio.UnaryUnaryClientInterceptor +): # pragma: NO COVER + async def intercept_unary_unary(self, continuation, client_call_details, request): + logging_enabled = CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + std_logging.DEBUG + ) + if logging_enabled: # pragma: NO COVER + request_metadata = client_call_details.metadata + if isinstance(request, proto.Message): + request_payload = type(request).to_json(request) + elif isinstance(request, google.protobuf.message.Message): + request_payload = MessageToJson(request) + else: + request_payload = f"{type(request).__name__}: {pickle.dumps(request)}" + + request_metadata = { + key: value.decode("utf-8") if isinstance(value, bytes) else value + for key, value in request_metadata + } + grpc_request = { + "payload": request_payload, + "requestMethod": "grpc", + "metadata": dict(request_metadata), + } + _LOGGER.debug( + f"Sending request for {client_call_details.method}", + extra={ + "serviceName": "google.api.cloudquotas.v1beta.CloudQuotas", + "rpcName": str(client_call_details.method), + "request": grpc_request, + "metadata": grpc_request["metadata"], + }, + ) + response = await continuation(client_call_details, request) + if logging_enabled: # pragma: NO COVER + response_metadata = await response.trailing_metadata() + # Convert gRPC metadata `` to list of tuples + metadata = ( + dict([(k, str(v)) for k, v in response_metadata]) + if response_metadata + else None + ) + result = await response + if isinstance(result, proto.Message): + response_payload = type(result).to_json(result) + elif isinstance(result, google.protobuf.message.Message): + response_payload = MessageToJson(result) + else: + response_payload = f"{type(result).__name__}: {pickle.dumps(result)}" + grpc_response = { + "payload": response_payload, + "metadata": metadata, + "status": "OK", + } + _LOGGER.debug( + f"Received response to rpc {client_call_details.method}.", + extra={ + "serviceName": "google.api.cloudquotas.v1beta.CloudQuotas", + "rpcName": str(client_call_details.method), + "response": grpc_response, + "metadata": grpc_response["metadata"], + }, + ) + return response + + +class CloudQuotasGrpcAsyncIOTransport(CloudQuotasTransport): + """gRPC AsyncIO backend transport for CloudQuotas. + + The Cloud Quotas API is an infrastructure service for Google + Cloud that lets service consumers list and manage their resource + usage limits. + + - List/Get the metadata and current status of the quotas for a + service. + - Create/Update quota preferencess that declare the preferred + quota values. + - Check the status of a quota preference request. + - List/Get pending and historical quota preference. + + 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 protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + + _grpc_channel: aio.Channel + _stubs: Dict[str, Callable] = {} + + @classmethod + def create_channel( + cls, + host: str = "cloudquotas.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs, + ) -> aio.Channel: + """Create and return a gRPC AsyncIO channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + aio.Channel: A gRPC AsyncIO channel object. + """ + + return grpc_helpers_async.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs, + ) + + def __init__( + self, + *, + host: str = "cloudquotas.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[Union[aio.Channel, Callable[..., aio.Channel]]] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = 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, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to (default: 'cloudquotas.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. + This argument is ignored if a ``channel`` instance is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if a ``channel`` instance is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + channel (Optional[Union[aio.Channel, Callable[..., aio.Channel]]]): + A ``Channel`` instance through which to make calls, or a Callable + that constructs and returns one. If set to None, ``self.create_channel`` + is used to create the channel. If a Callable is given, it will be called + with the same arguments as used in ``self.create_channel``. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if a ``channel`` instance is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if a ``channel`` instance or ``ssl_channel_credentials`` 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're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if isinstance(channel, aio.Channel): + # Ignore credentials if a channel was passed. + credentials = None + self._ignore_credentials = True + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + # initialize with the provided callable or the default channel + channel_init = channel or type(self).create_channel + self._grpc_channel = channel_init( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + self._interceptor = _LoggingClientAIOInterceptor() + self._grpc_channel._unary_unary_interceptors.append(self._interceptor) + self._logged_channel = self._grpc_channel + self._wrap_with_kind = ( + "kind" in inspect.signature(gapic_v1.method_async.wrap_method).parameters + ) + # Wrap messages. This must be done after self._logged_channel exists + self._prep_wrapped_messages(client_info) + + @property + def grpc_channel(self) -> aio.Channel: + """Create the channel designed to connect to this service. + + This property caches on the instance; repeated calls return + the same channel. + """ + # Return the channel from cache. + return self._grpc_channel + + @property + def list_quota_infos( + self, + ) -> Callable[ + [cloudquotas.ListQuotaInfosRequest], + Awaitable[cloudquotas.ListQuotaInfosResponse], + ]: + r"""Return a callable for the list quota infos method over gRPC. + + Lists QuotaInfos of all quotas for a given project, + folder or organization. + + Returns: + Callable[[~.ListQuotaInfosRequest], + Awaitable[~.ListQuotaInfosResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_quota_infos" not in self._stubs: + self._stubs["list_quota_infos"] = self._logged_channel.unary_unary( + "/google.api.cloudquotas.v1beta.CloudQuotas/ListQuotaInfos", + request_serializer=cloudquotas.ListQuotaInfosRequest.serialize, + response_deserializer=cloudquotas.ListQuotaInfosResponse.deserialize, + ) + return self._stubs["list_quota_infos"] + + @property + def get_quota_info( + self, + ) -> Callable[[cloudquotas.GetQuotaInfoRequest], Awaitable[resources.QuotaInfo]]: + r"""Return a callable for the get quota info method over gRPC. + + Retrieve the QuotaInfo of a quota for a project, + folder or organization. + + Returns: + Callable[[~.GetQuotaInfoRequest], + Awaitable[~.QuotaInfo]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_quota_info" not in self._stubs: + self._stubs["get_quota_info"] = self._logged_channel.unary_unary( + "/google.api.cloudquotas.v1beta.CloudQuotas/GetQuotaInfo", + request_serializer=cloudquotas.GetQuotaInfoRequest.serialize, + response_deserializer=resources.QuotaInfo.deserialize, + ) + return self._stubs["get_quota_info"] + + @property + def list_quota_preferences( + self, + ) -> Callable[ + [cloudquotas.ListQuotaPreferencesRequest], + Awaitable[cloudquotas.ListQuotaPreferencesResponse], + ]: + r"""Return a callable for the list quota preferences method over gRPC. + + Lists QuotaPreferences in a given project, folder or + organization. + + Returns: + Callable[[~.ListQuotaPreferencesRequest], + Awaitable[~.ListQuotaPreferencesResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_quota_preferences" not in self._stubs: + self._stubs["list_quota_preferences"] = self._logged_channel.unary_unary( + "/google.api.cloudquotas.v1beta.CloudQuotas/ListQuotaPreferences", + request_serializer=cloudquotas.ListQuotaPreferencesRequest.serialize, + response_deserializer=cloudquotas.ListQuotaPreferencesResponse.deserialize, + ) + return self._stubs["list_quota_preferences"] + + @property + def get_quota_preference( + self, + ) -> Callable[ + [cloudquotas.GetQuotaPreferenceRequest], Awaitable[resources.QuotaPreference] + ]: + r"""Return a callable for the get quota preference method over gRPC. + + Gets details of a single QuotaPreference. + + Returns: + Callable[[~.GetQuotaPreferenceRequest], + Awaitable[~.QuotaPreference]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_quota_preference" not in self._stubs: + self._stubs["get_quota_preference"] = self._logged_channel.unary_unary( + "/google.api.cloudquotas.v1beta.CloudQuotas/GetQuotaPreference", + request_serializer=cloudquotas.GetQuotaPreferenceRequest.serialize, + response_deserializer=resources.QuotaPreference.deserialize, + ) + return self._stubs["get_quota_preference"] + + @property + def create_quota_preference( + self, + ) -> Callable[ + [cloudquotas.CreateQuotaPreferenceRequest], Awaitable[resources.QuotaPreference] + ]: + r"""Return a callable for the create quota preference method over gRPC. + + Creates a new QuotaPreference that declares the + desired value for a quota. + + Returns: + Callable[[~.CreateQuotaPreferenceRequest], + Awaitable[~.QuotaPreference]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "create_quota_preference" not in self._stubs: + self._stubs["create_quota_preference"] = self._logged_channel.unary_unary( + "/google.api.cloudquotas.v1beta.CloudQuotas/CreateQuotaPreference", + request_serializer=cloudquotas.CreateQuotaPreferenceRequest.serialize, + response_deserializer=resources.QuotaPreference.deserialize, + ) + return self._stubs["create_quota_preference"] + + @property + def update_quota_preference( + self, + ) -> Callable[ + [cloudquotas.UpdateQuotaPreferenceRequest], Awaitable[resources.QuotaPreference] + ]: + r"""Return a callable for the update quota preference method over gRPC. + + Updates the parameters of a single QuotaPreference. + It can updates the config in any states, not just the + ones pending approval. + + Returns: + Callable[[~.UpdateQuotaPreferenceRequest], + Awaitable[~.QuotaPreference]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "update_quota_preference" not in self._stubs: + self._stubs["update_quota_preference"] = self._logged_channel.unary_unary( + "/google.api.cloudquotas.v1beta.CloudQuotas/UpdateQuotaPreference", + request_serializer=cloudquotas.UpdateQuotaPreferenceRequest.serialize, + response_deserializer=resources.QuotaPreference.deserialize, + ) + return self._stubs["update_quota_preference"] + + def _prep_wrapped_messages(self, client_info): + """Precompute the wrapped methods, overriding the base class method to use async wrappers.""" + self._wrapped_methods = { + self.list_quota_infos: self._wrap_method( + self.list_quota_infos, + default_retry=retries.AsyncRetry( + initial=1.0, + maximum=10.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.get_quota_info: self._wrap_method( + self.get_quota_info, + default_retry=retries.AsyncRetry( + initial=1.0, + maximum=10.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.list_quota_preferences: self._wrap_method( + self.list_quota_preferences, + default_retry=retries.AsyncRetry( + initial=1.0, + maximum=10.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.get_quota_preference: self._wrap_method( + self.get_quota_preference, + default_retry=retries.AsyncRetry( + initial=1.0, + maximum=10.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.create_quota_preference: self._wrap_method( + self.create_quota_preference, + default_retry=retries.AsyncRetry( + initial=1.0, + maximum=10.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.update_quota_preference: self._wrap_method( + self.update_quota_preference, + default_retry=retries.AsyncRetry( + initial=1.0, + maximum=10.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + } + + def _wrap_method(self, func, *args, **kwargs): + if self._wrap_with_kind: # pragma: NO COVER + kwargs["kind"] = self.kind + return gapic_v1.method_async.wrap_method(func, *args, **kwargs) + + def close(self): + return self._logged_channel.close() + + @property + def kind(self) -> str: + return "grpc_asyncio" + + +__all__ = ("CloudQuotasGrpcAsyncIOTransport",) diff --git a/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/cloud_quotas/transports/rest.py b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/cloud_quotas/transports/rest.py new file mode 100644 index 000000000000..886b606fc1b7 --- /dev/null +++ b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/cloud_quotas/transports/rest.py @@ -0,0 +1,1335 @@ +# -*- coding: utf-8 -*- +# 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. +# 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 dataclasses +import json # type: ignore +import logging +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1, rest_helpers, rest_streaming +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.requests import AuthorizedSession # type: ignore +from google.protobuf import json_format +from requests import __version__ as requests_version + +from google.cloud.cloudquotas_v1beta.types import cloudquotas, resources + +from .base import DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO +from .rest_base import _BaseCloudQuotasRestTransport + +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}", +) + + +class CloudQuotasRestInterceptor: + """Interceptor for CloudQuotas. + + 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 CloudQuotasRestTransport. + + .. code-block:: python + class MyCustomCloudQuotasInterceptor(CloudQuotasRestInterceptor): + def pre_create_quota_preference(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_create_quota_preference(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_get_quota_info(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_quota_info(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_get_quota_preference(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_quota_preference(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_quota_infos(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_quota_infos(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_quota_preferences(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_quota_preferences(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_update_quota_preference(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_quota_preference(self, response): + logging.log(f"Received response: {response}") + return response + + transport = CloudQuotasRestTransport(interceptor=MyCustomCloudQuotasInterceptor()) + client = CloudQuotasClient(transport=transport) + + + """ + + def pre_create_quota_preference( + self, + request: cloudquotas.CreateQuotaPreferenceRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + cloudquotas.CreateQuotaPreferenceRequest, + Sequence[Tuple[str, Union[str, bytes]]], + ]: + """Pre-rpc interceptor for create_quota_preference + + Override in a subclass to manipulate the request or metadata + before they are sent to the CloudQuotas server. + """ + return request, metadata + + def post_create_quota_preference( + self, response: resources.QuotaPreference + ) -> resources.QuotaPreference: + """Post-rpc interceptor for create_quota_preference + + Override in a subclass to manipulate the response + after it is returned by the CloudQuotas server but before + it is returned to user code. + """ + return response + + def pre_get_quota_info( + self, + request: cloudquotas.GetQuotaInfoRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + cloudquotas.GetQuotaInfoRequest, Sequence[Tuple[str, Union[str, bytes]]] + ]: + """Pre-rpc interceptor for get_quota_info + + Override in a subclass to manipulate the request or metadata + before they are sent to the CloudQuotas server. + """ + return request, metadata + + def post_get_quota_info(self, response: resources.QuotaInfo) -> resources.QuotaInfo: + """Post-rpc interceptor for get_quota_info + + Override in a subclass to manipulate the response + after it is returned by the CloudQuotas server but before + it is returned to user code. + """ + return response + + def pre_get_quota_preference( + self, + request: cloudquotas.GetQuotaPreferenceRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + cloudquotas.GetQuotaPreferenceRequest, Sequence[Tuple[str, Union[str, bytes]]] + ]: + """Pre-rpc interceptor for get_quota_preference + + Override in a subclass to manipulate the request or metadata + before they are sent to the CloudQuotas server. + """ + return request, metadata + + def post_get_quota_preference( + self, response: resources.QuotaPreference + ) -> resources.QuotaPreference: + """Post-rpc interceptor for get_quota_preference + + Override in a subclass to manipulate the response + after it is returned by the CloudQuotas server but before + it is returned to user code. + """ + return response + + def pre_list_quota_infos( + self, + request: cloudquotas.ListQuotaInfosRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + cloudquotas.ListQuotaInfosRequest, Sequence[Tuple[str, Union[str, bytes]]] + ]: + """Pre-rpc interceptor for list_quota_infos + + Override in a subclass to manipulate the request or metadata + before they are sent to the CloudQuotas server. + """ + return request, metadata + + def post_list_quota_infos( + self, response: cloudquotas.ListQuotaInfosResponse + ) -> cloudquotas.ListQuotaInfosResponse: + """Post-rpc interceptor for list_quota_infos + + Override in a subclass to manipulate the response + after it is returned by the CloudQuotas server but before + it is returned to user code. + """ + return response + + def pre_list_quota_preferences( + self, + request: cloudquotas.ListQuotaPreferencesRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + cloudquotas.ListQuotaPreferencesRequest, Sequence[Tuple[str, Union[str, bytes]]] + ]: + """Pre-rpc interceptor for list_quota_preferences + + Override in a subclass to manipulate the request or metadata + before they are sent to the CloudQuotas server. + """ + return request, metadata + + def post_list_quota_preferences( + self, response: cloudquotas.ListQuotaPreferencesResponse + ) -> cloudquotas.ListQuotaPreferencesResponse: + """Post-rpc interceptor for list_quota_preferences + + Override in a subclass to manipulate the response + after it is returned by the CloudQuotas server but before + it is returned to user code. + """ + return response + + def pre_update_quota_preference( + self, + request: cloudquotas.UpdateQuotaPreferenceRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + cloudquotas.UpdateQuotaPreferenceRequest, + Sequence[Tuple[str, Union[str, bytes]]], + ]: + """Pre-rpc interceptor for update_quota_preference + + Override in a subclass to manipulate the request or metadata + before they are sent to the CloudQuotas server. + """ + return request, metadata + + def post_update_quota_preference( + self, response: resources.QuotaPreference + ) -> resources.QuotaPreference: + """Post-rpc interceptor for update_quota_preference + + Override in a subclass to manipulate the response + after it is returned by the CloudQuotas server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class CloudQuotasRestStub: + _session: AuthorizedSession + _host: str + _interceptor: CloudQuotasRestInterceptor + + +class CloudQuotasRestTransport(_BaseCloudQuotasRestTransport): + """REST backend synchronous transport for CloudQuotas. + + The Cloud Quotas API is an infrastructure service for Google + Cloud that lets service consumers list and manage their resource + usage limits. + + - List/Get the metadata and current status of the quotas for a + service. + - Create/Update quota preferencess that declare the preferred + quota values. + - Check the status of a quota preference request. + - List/Get pending and historical quota preference. + + 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 = "cloudquotas.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[CloudQuotasRestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to (default: 'cloudquotas.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]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + 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 CloudQuotasRestInterceptor() + self._prep_wrapped_messages(client_info) + + class _CreateQuotaPreference( + _BaseCloudQuotasRestTransport._BaseCreateQuotaPreference, CloudQuotasRestStub + ): + def __hash__(self): + return hash("CloudQuotasRestTransport.CreateQuotaPreference") + + @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), + data=body, + ) + return response + + def __call__( + self, + request: cloudquotas.CreateQuotaPreferenceRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> resources.QuotaPreference: + r"""Call the create quota preference method over HTTP. + + Args: + request (~.cloudquotas.CreateQuotaPreferenceRequest): + The request object. Message for creating a + QuotaPreference + 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: + ~.resources.QuotaPreference: + QuotaPreference represents the + preferred quota configuration specified + for a project, folder or organization. + There is only one QuotaPreference + resource for a quota value targeting a + unique set of dimensions. + + """ + + http_options = ( + _BaseCloudQuotasRestTransport._BaseCreateQuotaPreference._get_http_options() + ) + + request, metadata = self._interceptor.pre_create_quota_preference( + request, metadata + ) + transcoded_request = _BaseCloudQuotasRestTransport._BaseCreateQuotaPreference._get_transcoded_request( + http_options, request + ) + + body = _BaseCloudQuotasRestTransport._BaseCreateQuotaPreference._get_request_body_json( + transcoded_request + ) + + # Jsonify the query params + query_params = _BaseCloudQuotasRestTransport._BaseCreateQuotaPreference._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.api.cloudquotas_v1beta.CloudQuotasClient.CreateQuotaPreference", + extra={ + "serviceName": "google.api.cloudquotas.v1beta.CloudQuotas", + "rpcName": "CreateQuotaPreference", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = CloudQuotasRestTransport._CreateQuotaPreference._get_response( + self._host, + metadata, + query_params, + self._session, + timeout, + transcoded_request, + body, + ) + + # 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 = resources.QuotaPreference() + pb_resp = resources.QuotaPreference.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_create_quota_preference(resp) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + try: + response_payload = resources.QuotaPreference.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.api.cloudquotas_v1beta.CloudQuotasClient.create_quota_preference", + extra={ + "serviceName": "google.api.cloudquotas.v1beta.CloudQuotas", + "rpcName": "CreateQuotaPreference", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _GetQuotaInfo( + _BaseCloudQuotasRestTransport._BaseGetQuotaInfo, CloudQuotasRestStub + ): + def __hash__(self): + return hash("CloudQuotasRestTransport.GetQuotaInfo") + + @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: cloudquotas.GetQuotaInfoRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> resources.QuotaInfo: + r"""Call the get quota info method over HTTP. + + Args: + request (~.cloudquotas.GetQuotaInfoRequest): + The request object. Message for getting a QuotaInfo + 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: + ~.resources.QuotaInfo: + QuotaInfo represents information + about a particular quota for a given + project, folder or organization. + + """ + + http_options = ( + _BaseCloudQuotasRestTransport._BaseGetQuotaInfo._get_http_options() + ) + + request, metadata = self._interceptor.pre_get_quota_info(request, metadata) + transcoded_request = ( + _BaseCloudQuotasRestTransport._BaseGetQuotaInfo._get_transcoded_request( + http_options, request + ) + ) + + # Jsonify the query params + query_params = ( + _BaseCloudQuotasRestTransport._BaseGetQuotaInfo._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.api.cloudquotas_v1beta.CloudQuotasClient.GetQuotaInfo", + extra={ + "serviceName": "google.api.cloudquotas.v1beta.CloudQuotas", + "rpcName": "GetQuotaInfo", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = CloudQuotasRestTransport._GetQuotaInfo._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 = resources.QuotaInfo() + pb_resp = resources.QuotaInfo.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_get_quota_info(resp) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + try: + response_payload = resources.QuotaInfo.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.api.cloudquotas_v1beta.CloudQuotasClient.get_quota_info", + extra={ + "serviceName": "google.api.cloudquotas.v1beta.CloudQuotas", + "rpcName": "GetQuotaInfo", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _GetQuotaPreference( + _BaseCloudQuotasRestTransport._BaseGetQuotaPreference, CloudQuotasRestStub + ): + def __hash__(self): + return hash("CloudQuotasRestTransport.GetQuotaPreference") + + @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: cloudquotas.GetQuotaPreferenceRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> resources.QuotaPreference: + r"""Call the get quota preference method over HTTP. + + Args: + request (~.cloudquotas.GetQuotaPreferenceRequest): + The request object. Message for getting a QuotaPreference + 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: + ~.resources.QuotaPreference: + QuotaPreference represents the + preferred quota configuration specified + for a project, folder or organization. + There is only one QuotaPreference + resource for a quota value targeting a + unique set of dimensions. + + """ + + http_options = ( + _BaseCloudQuotasRestTransport._BaseGetQuotaPreference._get_http_options() + ) + + request, metadata = self._interceptor.pre_get_quota_preference( + request, metadata + ) + transcoded_request = _BaseCloudQuotasRestTransport._BaseGetQuotaPreference._get_transcoded_request( + http_options, request + ) + + # Jsonify the query params + query_params = _BaseCloudQuotasRestTransport._BaseGetQuotaPreference._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.api.cloudquotas_v1beta.CloudQuotasClient.GetQuotaPreference", + extra={ + "serviceName": "google.api.cloudquotas.v1beta.CloudQuotas", + "rpcName": "GetQuotaPreference", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = CloudQuotasRestTransport._GetQuotaPreference._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 = resources.QuotaPreference() + pb_resp = resources.QuotaPreference.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_get_quota_preference(resp) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + try: + response_payload = resources.QuotaPreference.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.api.cloudquotas_v1beta.CloudQuotasClient.get_quota_preference", + extra={ + "serviceName": "google.api.cloudquotas.v1beta.CloudQuotas", + "rpcName": "GetQuotaPreference", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _ListQuotaInfos( + _BaseCloudQuotasRestTransport._BaseListQuotaInfos, CloudQuotasRestStub + ): + def __hash__(self): + return hash("CloudQuotasRestTransport.ListQuotaInfos") + + @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: cloudquotas.ListQuotaInfosRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> cloudquotas.ListQuotaInfosResponse: + r"""Call the list quota infos method over HTTP. + + Args: + request (~.cloudquotas.ListQuotaInfosRequest): + The request object. Message for requesting list of + QuotaInfos + 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: + ~.cloudquotas.ListQuotaInfosResponse: + Message for response to listing + QuotaInfos + + """ + + http_options = ( + _BaseCloudQuotasRestTransport._BaseListQuotaInfos._get_http_options() + ) + + request, metadata = self._interceptor.pre_list_quota_infos( + request, metadata + ) + transcoded_request = _BaseCloudQuotasRestTransport._BaseListQuotaInfos._get_transcoded_request( + http_options, request + ) + + # Jsonify the query params + query_params = _BaseCloudQuotasRestTransport._BaseListQuotaInfos._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.api.cloudquotas_v1beta.CloudQuotasClient.ListQuotaInfos", + extra={ + "serviceName": "google.api.cloudquotas.v1beta.CloudQuotas", + "rpcName": "ListQuotaInfos", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = CloudQuotasRestTransport._ListQuotaInfos._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 = cloudquotas.ListQuotaInfosResponse() + pb_resp = cloudquotas.ListQuotaInfosResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_list_quota_infos(resp) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + try: + response_payload = cloudquotas.ListQuotaInfosResponse.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.api.cloudquotas_v1beta.CloudQuotasClient.list_quota_infos", + extra={ + "serviceName": "google.api.cloudquotas.v1beta.CloudQuotas", + "rpcName": "ListQuotaInfos", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _ListQuotaPreferences( + _BaseCloudQuotasRestTransport._BaseListQuotaPreferences, CloudQuotasRestStub + ): + def __hash__(self): + return hash("CloudQuotasRestTransport.ListQuotaPreferences") + + @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: cloudquotas.ListQuotaPreferencesRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> cloudquotas.ListQuotaPreferencesResponse: + r"""Call the list quota preferences method over HTTP. + + Args: + request (~.cloudquotas.ListQuotaPreferencesRequest): + The request object. Message for requesting list of + QuotaPreferences + 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: + ~.cloudquotas.ListQuotaPreferencesResponse: + Message for response to listing + QuotaPreferences + + """ + + http_options = ( + _BaseCloudQuotasRestTransport._BaseListQuotaPreferences._get_http_options() + ) + + request, metadata = self._interceptor.pre_list_quota_preferences( + request, metadata + ) + transcoded_request = _BaseCloudQuotasRestTransport._BaseListQuotaPreferences._get_transcoded_request( + http_options, request + ) + + # Jsonify the query params + query_params = _BaseCloudQuotasRestTransport._BaseListQuotaPreferences._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.api.cloudquotas_v1beta.CloudQuotasClient.ListQuotaPreferences", + extra={ + "serviceName": "google.api.cloudquotas.v1beta.CloudQuotas", + "rpcName": "ListQuotaPreferences", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = CloudQuotasRestTransport._ListQuotaPreferences._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 = cloudquotas.ListQuotaPreferencesResponse() + pb_resp = cloudquotas.ListQuotaPreferencesResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_list_quota_preferences(resp) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + try: + response_payload = cloudquotas.ListQuotaPreferencesResponse.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.api.cloudquotas_v1beta.CloudQuotasClient.list_quota_preferences", + extra={ + "serviceName": "google.api.cloudquotas.v1beta.CloudQuotas", + "rpcName": "ListQuotaPreferences", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _UpdateQuotaPreference( + _BaseCloudQuotasRestTransport._BaseUpdateQuotaPreference, CloudQuotasRestStub + ): + def __hash__(self): + return hash("CloudQuotasRestTransport.UpdateQuotaPreference") + + @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), + data=body, + ) + return response + + def __call__( + self, + request: cloudquotas.UpdateQuotaPreferenceRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> resources.QuotaPreference: + r"""Call the update quota preference method over HTTP. + + Args: + request (~.cloudquotas.UpdateQuotaPreferenceRequest): + The request object. Message for updating a + QuotaPreference + 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: + ~.resources.QuotaPreference: + QuotaPreference represents the + preferred quota configuration specified + for a project, folder or organization. + There is only one QuotaPreference + resource for a quota value targeting a + unique set of dimensions. + + """ + + http_options = ( + _BaseCloudQuotasRestTransport._BaseUpdateQuotaPreference._get_http_options() + ) + + request, metadata = self._interceptor.pre_update_quota_preference( + request, metadata + ) + transcoded_request = _BaseCloudQuotasRestTransport._BaseUpdateQuotaPreference._get_transcoded_request( + http_options, request + ) + + body = _BaseCloudQuotasRestTransport._BaseUpdateQuotaPreference._get_request_body_json( + transcoded_request + ) + + # Jsonify the query params + query_params = _BaseCloudQuotasRestTransport._BaseUpdateQuotaPreference._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.api.cloudquotas_v1beta.CloudQuotasClient.UpdateQuotaPreference", + extra={ + "serviceName": "google.api.cloudquotas.v1beta.CloudQuotas", + "rpcName": "UpdateQuotaPreference", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = CloudQuotasRestTransport._UpdateQuotaPreference._get_response( + self._host, + metadata, + query_params, + self._session, + timeout, + transcoded_request, + body, + ) + + # 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 = resources.QuotaPreference() + pb_resp = resources.QuotaPreference.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_update_quota_preference(resp) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + try: + response_payload = resources.QuotaPreference.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.api.cloudquotas_v1beta.CloudQuotasClient.update_quota_preference", + extra={ + "serviceName": "google.api.cloudquotas.v1beta.CloudQuotas", + "rpcName": "UpdateQuotaPreference", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + @property + def create_quota_preference( + self, + ) -> Callable[ + [cloudquotas.CreateQuotaPreferenceRequest], resources.QuotaPreference + ]: + # 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._CreateQuotaPreference(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_quota_info( + self, + ) -> Callable[[cloudquotas.GetQuotaInfoRequest], resources.QuotaInfo]: + # 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._GetQuotaInfo(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_quota_preference( + self, + ) -> Callable[[cloudquotas.GetQuotaPreferenceRequest], resources.QuotaPreference]: + # 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._GetQuotaPreference(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_quota_infos( + self, + ) -> Callable[ + [cloudquotas.ListQuotaInfosRequest], cloudquotas.ListQuotaInfosResponse + ]: + # 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._ListQuotaInfos(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_quota_preferences( + self, + ) -> Callable[ + [cloudquotas.ListQuotaPreferencesRequest], + cloudquotas.ListQuotaPreferencesResponse, + ]: + # 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._ListQuotaPreferences(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_quota_preference( + self, + ) -> Callable[ + [cloudquotas.UpdateQuotaPreferenceRequest], resources.QuotaPreference + ]: + # 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._UpdateQuotaPreference(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__ = ("CloudQuotasRestTransport",) diff --git a/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/cloud_quotas/transports/rest_base.py b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/cloud_quotas/transports/rest_base.py new file mode 100644 index 000000000000..00bede2b0d3c --- /dev/null +++ b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/cloud_quotas/transports/rest_base.py @@ -0,0 +1,445 @@ +# -*- coding: utf-8 -*- +# 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. +# 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 json # type: ignore +import re +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union + +from google.api_core import gapic_v1, path_template +from google.protobuf import json_format + +from google.cloud.cloudquotas_v1beta.types import cloudquotas, resources + +from .base import DEFAULT_CLIENT_INFO, CloudQuotasTransport + + +class _BaseCloudQuotasRestTransport(CloudQuotasTransport): + """Base REST backend transport for CloudQuotas. + + Note: This class is not meant to be used directly. Use its sync and + async sub-classes instead. + + 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 = "cloudquotas.googleapis.com", + credentials: Optional[Any] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + url_scheme: str = "https", + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + Args: + host (Optional[str]): + The hostname to connect to (default: 'cloudquotas.googleapis.com'). + credentials (Optional[Any]): 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. + 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 + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError( + f"Unexpected hostname structure: {host}" + ) # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + class _BaseCreateQuotaPreference: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1beta/{parent=projects/*/locations/*}/quotaPreferences", + "body": "quota_preference", + }, + { + "method": "post", + "uri": "/v1beta/{parent=folders/*/locations/*}/quotaPreferences", + "body": "quota_preference", + }, + { + "method": "post", + "uri": "/v1beta/{parent=organizations/*/locations/*}/quotaPreferences", + "body": "quota_preference", + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = cloudquotas.CreateQuotaPreferenceRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_request_body_json(transcoded_request): + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], use_integers_for_enums=True + ) + return body + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + use_integers_for_enums=True, + ) + ) + query_params.update( + _BaseCloudQuotasRestTransport._BaseCreateQuotaPreference._get_unset_required_fields( + query_params + ) + ) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseGetQuotaInfo: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1beta/{name=projects/*/locations/*/services/*/quotaInfos/*}", + }, + { + "method": "get", + "uri": "/v1beta/{name=organizations/*/locations/*/services/*/quotaInfos/*}", + }, + { + "method": "get", + "uri": "/v1beta/{name=folders/*/locations/*/services/*/quotaInfos/*}", + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = cloudquotas.GetQuotaInfoRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + use_integers_for_enums=True, + ) + ) + query_params.update( + _BaseCloudQuotasRestTransport._BaseGetQuotaInfo._get_unset_required_fields( + query_params + ) + ) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseGetQuotaPreference: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1beta/{name=projects/*/locations/*/quotaPreferences/*}", + }, + { + "method": "get", + "uri": "/v1beta/{name=organizations/*/locations/*/quotaPreferences/*}", + }, + { + "method": "get", + "uri": "/v1beta/{name=folders/*/locations/*/quotaPreferences/*}", + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = cloudquotas.GetQuotaPreferenceRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + use_integers_for_enums=True, + ) + ) + query_params.update( + _BaseCloudQuotasRestTransport._BaseGetQuotaPreference._get_unset_required_fields( + query_params + ) + ) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseListQuotaInfos: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1beta/{parent=projects/*/locations/*/services/*}/quotaInfos", + }, + { + "method": "get", + "uri": "/v1beta/{parent=organizations/*/locations/*/services/*}/quotaInfos", + }, + { + "method": "get", + "uri": "/v1beta/{parent=folders/*/locations/*/services/*}/quotaInfos", + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = cloudquotas.ListQuotaInfosRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + use_integers_for_enums=True, + ) + ) + query_params.update( + _BaseCloudQuotasRestTransport._BaseListQuotaInfos._get_unset_required_fields( + query_params + ) + ) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseListQuotaPreferences: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1beta/{parent=projects/*/locations/*}/quotaPreferences", + }, + { + "method": "get", + "uri": "/v1beta/{parent=folders/*/locations/*}/quotaPreferences", + }, + { + "method": "get", + "uri": "/v1beta/{parent=organizations/*/locations/*}/quotaPreferences", + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = cloudquotas.ListQuotaPreferencesRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + use_integers_for_enums=True, + ) + ) + query_params.update( + _BaseCloudQuotasRestTransport._BaseListQuotaPreferences._get_unset_required_fields( + query_params + ) + ) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseUpdateQuotaPreference: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [ + { + "method": "patch", + "uri": "/v1beta/{quota_preference.name=projects/*/locations/*/quotaPreferences/*}", + "body": "quota_preference", + }, + { + "method": "patch", + "uri": "/v1beta/{quota_preference.name=folders/*/locations/*/quotaPreferences/*}", + "body": "quota_preference", + }, + { + "method": "patch", + "uri": "/v1beta/{quota_preference.name=organizations/*/locations/*/quotaPreferences/*}", + "body": "quota_preference", + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = cloudquotas.UpdateQuotaPreferenceRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_request_body_json(transcoded_request): + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], use_integers_for_enums=True + ) + return body + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + use_integers_for_enums=True, + ) + ) + query_params.update( + _BaseCloudQuotasRestTransport._BaseUpdateQuotaPreference._get_unset_required_fields( + query_params + ) + ) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + +__all__ = ("_BaseCloudQuotasRestTransport",) diff --git a/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/quota_adjuster_settings_manager/__init__.py b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/quota_adjuster_settings_manager/__init__.py new file mode 100644 index 000000000000..b208953fa189 --- /dev/null +++ b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/quota_adjuster_settings_manager/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# 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. +# 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. +# +from .async_client import QuotaAdjusterSettingsManagerAsyncClient +from .client import QuotaAdjusterSettingsManagerClient + +__all__ = ( + "QuotaAdjusterSettingsManagerClient", + "QuotaAdjusterSettingsManagerAsyncClient", +) diff --git a/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/quota_adjuster_settings_manager/async_client.py b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/quota_adjuster_settings_manager/async_client.py new file mode 100644 index 000000000000..0f934c0f801d --- /dev/null +++ b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/quota_adjuster_settings_manager/async_client.py @@ -0,0 +1,582 @@ +# -*- coding: utf-8 -*- +# 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. +# 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. +# +from collections import OrderedDict +import logging as std_logging +import re +from typing import ( + Callable, + Dict, + Mapping, + MutableMapping, + MutableSequence, + Optional, + Sequence, + Tuple, + Type, + Union, +) + +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.api_core.client_options import ClientOptions +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.cloudquotas_v1beta import gapic_version as package_version + +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.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore + +from google.cloud.cloudquotas_v1beta.types import ( + quota_adjuster_settings as gac_quota_adjuster_settings, +) +from google.cloud.cloudquotas_v1beta.types import quota_adjuster_settings + +from .client import QuotaAdjusterSettingsManagerClient +from .transports.base import DEFAULT_CLIENT_INFO, QuotaAdjusterSettingsManagerTransport +from .transports.grpc_asyncio import QuotaAdjusterSettingsManagerGrpcAsyncIOTransport + +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 QuotaAdjusterSettingsManagerAsyncClient: + """The Quotas Adjuster Settings API is an infrastructure service + for Google Cloud that lets service consumers view and update + their quota adjuster settings. + + - Update quota adjuster settings. + - Get the name of the configurations. + """ + + _client: QuotaAdjusterSettingsManagerClient + + # Copy defaults from the synchronous client for use here. + # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead. + DEFAULT_ENDPOINT = QuotaAdjusterSettingsManagerClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = QuotaAdjusterSettingsManagerClient.DEFAULT_MTLS_ENDPOINT + _DEFAULT_ENDPOINT_TEMPLATE = ( + QuotaAdjusterSettingsManagerClient._DEFAULT_ENDPOINT_TEMPLATE + ) + _DEFAULT_UNIVERSE = QuotaAdjusterSettingsManagerClient._DEFAULT_UNIVERSE + + quota_adjuster_settings_path = staticmethod( + QuotaAdjusterSettingsManagerClient.quota_adjuster_settings_path + ) + parse_quota_adjuster_settings_path = staticmethod( + QuotaAdjusterSettingsManagerClient.parse_quota_adjuster_settings_path + ) + common_billing_account_path = staticmethod( + QuotaAdjusterSettingsManagerClient.common_billing_account_path + ) + parse_common_billing_account_path = staticmethod( + QuotaAdjusterSettingsManagerClient.parse_common_billing_account_path + ) + common_folder_path = staticmethod( + QuotaAdjusterSettingsManagerClient.common_folder_path + ) + parse_common_folder_path = staticmethod( + QuotaAdjusterSettingsManagerClient.parse_common_folder_path + ) + common_organization_path = staticmethod( + QuotaAdjusterSettingsManagerClient.common_organization_path + ) + parse_common_organization_path = staticmethod( + QuotaAdjusterSettingsManagerClient.parse_common_organization_path + ) + common_project_path = staticmethod( + QuotaAdjusterSettingsManagerClient.common_project_path + ) + parse_common_project_path = staticmethod( + QuotaAdjusterSettingsManagerClient.parse_common_project_path + ) + common_location_path = staticmethod( + QuotaAdjusterSettingsManagerClient.common_location_path + ) + parse_common_location_path = staticmethod( + QuotaAdjusterSettingsManagerClient.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: + QuotaAdjusterSettingsManagerAsyncClient: The constructed client. + """ + return QuotaAdjusterSettingsManagerClient.from_service_account_info.__func__(QuotaAdjusterSettingsManagerAsyncClient, 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: + QuotaAdjusterSettingsManagerAsyncClient: The constructed client. + """ + return QuotaAdjusterSettingsManagerClient.from_service_account_file.__func__(QuotaAdjusterSettingsManagerAsyncClient, 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 QuotaAdjusterSettingsManagerClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore + + @property + def transport(self) -> QuotaAdjusterSettingsManagerTransport: + """Returns the transport used by the client instance. + + Returns: + QuotaAdjusterSettingsManagerTransport: 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 = QuotaAdjusterSettingsManagerClient.get_transport_class + + def __init__( + self, + *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Optional[ + Union[ + str, + QuotaAdjusterSettingsManagerTransport, + Callable[..., QuotaAdjusterSettingsManagerTransport], + ] + ] = "grpc_asyncio", + client_options: Optional[ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the quota adjuster settings manager 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,QuotaAdjusterSettingsManagerTransport,Callable[..., QuotaAdjusterSettingsManagerTransport]]]): + 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 QuotaAdjusterSettingsManagerTransport constructor. + If set to None, a transport is chosen automatically. + 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 = QuotaAdjusterSettingsManagerClient( + 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.api.cloudquotas_v1beta.QuotaAdjusterSettingsManagerAsyncClient`.", + extra={ + "serviceName": "google.api.cloudquotas.v1beta.QuotaAdjusterSettingsManager", + "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.api.cloudquotas.v1beta.QuotaAdjusterSettingsManager", + "credentialsType": None, + }, + ) + + async def update_quota_adjuster_settings( + self, + request: Optional[ + Union[gac_quota_adjuster_settings.UpdateQuotaAdjusterSettingsRequest, dict] + ] = None, + *, + quota_adjuster_settings: Optional[ + gac_quota_adjuster_settings.QuotaAdjusterSettings + ] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> gac_quota_adjuster_settings.QuotaAdjusterSettings: + r"""RPC Method for updating QuotaAdjusterSettings based + on the request + + .. 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 google.cloud import cloudquotas_v1beta + + async def sample_update_quota_adjuster_settings(): + # Create a client + client = cloudquotas_v1beta.QuotaAdjusterSettingsManagerAsyncClient() + + # Initialize request argument(s) + quota_adjuster_settings = cloudquotas_v1beta.QuotaAdjusterSettings() + quota_adjuster_settings.enablement = "DISABLED" + + request = cloudquotas_v1beta.UpdateQuotaAdjusterSettingsRequest( + quota_adjuster_settings=quota_adjuster_settings, + ) + + # Make the request + response = await client.update_quota_adjuster_settings(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.cloudquotas_v1beta.types.UpdateQuotaAdjusterSettingsRequest, dict]]): + The request object. Request for updating + QuotaAdjusterSettings + quota_adjuster_settings (:class:`google.cloud.cloudquotas_v1beta.types.QuotaAdjusterSettings`): + Required. The QuotaAdjusterSettings + to update. + + This corresponds to the ``quota_adjuster_settings`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): + Optional. The list of fields to + update. + + This corresponds to the ``update_mask`` 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.cloud.cloudquotas_v1beta.types.QuotaAdjusterSettings: + The QuotaAdjusterSettings resource + defines the settings for the Quota + Adjuster. + + """ + # 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. + has_flattened_params = any([quota_adjuster_settings, update_mask]) + 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, gac_quota_adjuster_settings.UpdateQuotaAdjusterSettingsRequest + ): + request = gac_quota_adjuster_settings.UpdateQuotaAdjusterSettingsRequest( + request + ) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if quota_adjuster_settings is not None: + request.quota_adjuster_settings = quota_adjuster_settings + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._client._transport._wrapped_methods[ + self._client._transport.update_quota_adjuster_settings + ] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + ( + ( + "quota_adjuster_settings.name", + request.quota_adjuster_settings.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 get_quota_adjuster_settings( + self, + request: Optional[ + Union[quota_adjuster_settings.GetQuotaAdjusterSettingsRequest, 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]]] = (), + ) -> quota_adjuster_settings.QuotaAdjusterSettings: + r"""RPC Method for getting QuotaAdjusterSettings based on + the request + + .. 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 google.cloud import cloudquotas_v1beta + + async def sample_get_quota_adjuster_settings(): + # Create a client + client = cloudquotas_v1beta.QuotaAdjusterSettingsManagerAsyncClient() + + # Initialize request argument(s) + request = cloudquotas_v1beta.GetQuotaAdjusterSettingsRequest( + name="name_value", + ) + + # Make the request + response = await client.get_quota_adjuster_settings(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.cloudquotas_v1beta.types.GetQuotaAdjusterSettingsRequest, dict]]): + The request object. Request for getting + QuotaAdjusterSettings + name (:class:`str`): + Required. Name of the config. + Required to be “settings”, as only a + single setting per container will be + supported initially. + + 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.cloud.cloudquotas_v1beta.types.QuotaAdjusterSettings: + The QuotaAdjusterSettings resource + defines the settings for the Quota + Adjuster. + + """ + # 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. + has_flattened_params = any([name]) + 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, quota_adjuster_settings.GetQuotaAdjusterSettingsRequest + ): + request = quota_adjuster_settings.GetQuotaAdjusterSettingsRequest(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_quota_adjuster_settings + ] + + # 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 __aenter__(self) -> "QuotaAdjusterSettingsManagerAsyncClient": + 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__ +) + + +__all__ = ("QuotaAdjusterSettingsManagerAsyncClient",) diff --git a/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/quota_adjuster_settings_manager/client.py b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/quota_adjuster_settings_manager/client.py new file mode 100644 index 000000000000..2618374b1be9 --- /dev/null +++ b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/quota_adjuster_settings_manager/client.py @@ -0,0 +1,980 @@ +# -*- coding: utf-8 -*- +# 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. +# 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. +# +from collections import OrderedDict +import logging as std_logging +import os +import re +from typing import ( + Callable, + Dict, + Mapping, + MutableMapping, + MutableSequence, + Optional, + Sequence, + Tuple, + Type, + Union, + cast, +) +import warnings + +from google.api_core import client_options as client_options_lib +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.exceptions import MutualTLSChannelError # type: ignore +from google.auth.transport import mtls # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.cloudquotas_v1beta import gapic_version as package_version + +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 = std_logging.getLogger(__name__) + +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore + +from google.cloud.cloudquotas_v1beta.types import ( + quota_adjuster_settings as gac_quota_adjuster_settings, +) +from google.cloud.cloudquotas_v1beta.types import quota_adjuster_settings + +from .transports.base import DEFAULT_CLIENT_INFO, QuotaAdjusterSettingsManagerTransport +from .transports.grpc import QuotaAdjusterSettingsManagerGrpcTransport +from .transports.grpc_asyncio import QuotaAdjusterSettingsManagerGrpcAsyncIOTransport +from .transports.rest import QuotaAdjusterSettingsManagerRestTransport + + +class QuotaAdjusterSettingsManagerClientMeta(type): + """Metaclass for the QuotaAdjusterSettingsManager client. + + This provides class-level methods for building and retrieving + support objects (e.g. transport) without polluting the client instance + objects. + """ + + _transport_registry = ( + OrderedDict() + ) # type: Dict[str, Type[QuotaAdjusterSettingsManagerTransport]] + _transport_registry["grpc"] = QuotaAdjusterSettingsManagerGrpcTransport + _transport_registry[ + "grpc_asyncio" + ] = QuotaAdjusterSettingsManagerGrpcAsyncIOTransport + _transport_registry["rest"] = QuotaAdjusterSettingsManagerRestTransport + + def get_transport_class( + cls, + label: Optional[str] = None, + ) -> Type[QuotaAdjusterSettingsManagerTransport]: + """Returns an appropriate transport class. + + Args: + label: The name of the desired transport. If none is + provided, then the first transport in the registry is used. + + Returns: + The transport class to use. + """ + # If a specific transport is requested, return that one. + if label: + return cls._transport_registry[label] + + # No transport is requested; return the default (that is, the first one + # in the dictionary). + return next(iter(cls._transport_registry.values())) + + +class QuotaAdjusterSettingsManagerClient( + metaclass=QuotaAdjusterSettingsManagerClientMeta +): + """The Quotas Adjuster Settings API is an infrastructure service + for Google Cloud that lets service consumers view and update + their quota adjuster settings. + + - Update quota adjuster settings. + - Get the name of the configurations. + """ + + @staticmethod + def _get_default_mtls_endpoint(api_endpoint): + """Converts api endpoint to mTLS endpoint. + + Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to + "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. + Args: + api_endpoint (Optional[str]): the api endpoint to convert. + Returns: + str: converted mTLS api endpoint. + """ + if not api_endpoint: + return api_endpoint + + mtls_endpoint_re = re.compile( + r"(?P[^.]+)(?P\.mtls)?(?P\.sandbox)?(?P\.googleapis\.com)?" + ) + + m = mtls_endpoint_re.match(api_endpoint) + name, mtls, sandbox, googledomain = m.groups() + if mtls or not googledomain: + return api_endpoint + + if sandbox: + return api_endpoint.replace( + "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" + ) + + return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") + + # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead. + DEFAULT_ENDPOINT = "cloudquotas.googleapis.com" + DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore + DEFAULT_ENDPOINT + ) + + _DEFAULT_ENDPOINT_TEMPLATE = "cloudquotas.{UNIVERSE_DOMAIN}" + _DEFAULT_UNIVERSE = "googleapis.com" + + @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: + QuotaAdjusterSettingsManagerClient: The constructed client. + """ + credentials = service_account.Credentials.from_service_account_info(info) + kwargs["credentials"] = credentials + return cls(*args, **kwargs) + + @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: + QuotaAdjusterSettingsManagerClient: The constructed client. + """ + credentials = service_account.Credentials.from_service_account_file(filename) + kwargs["credentials"] = credentials + return cls(*args, **kwargs) + + from_service_account_json = from_service_account_file + + @property + def transport(self) -> QuotaAdjusterSettingsManagerTransport: + """Returns the transport used by the client instance. + + Returns: + QuotaAdjusterSettingsManagerTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def quota_adjuster_settings_path( + project: str, + location: str, + ) -> str: + """Returns a fully-qualified quota_adjuster_settings string.""" + return "projects/{project}/locations/{location}/quotaAdjusterSettings".format( + project=project, + location=location, + ) + + @staticmethod + def parse_quota_adjuster_settings_path(path: str) -> Dict[str, str]: + """Parses a quota_adjuster_settings path into its component segments.""" + m = re.match( + r"^projects/(?P.+?)/locations/(?P.+?)/quotaAdjusterSettings$", + path, + ) + return m.groupdict() if m else {} + + @staticmethod + def common_billing_account_path( + billing_account: str, + ) -> str: + """Returns a fully-qualified billing_account string.""" + return "billingAccounts/{billing_account}".format( + billing_account=billing_account, + ) + + @staticmethod + def parse_common_billing_account_path(path: str) -> Dict[str, str]: + """Parse a billing_account path into its component segments.""" + m = re.match(r"^billingAccounts/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_folder_path( + folder: str, + ) -> str: + """Returns a fully-qualified folder string.""" + return "folders/{folder}".format( + folder=folder, + ) + + @staticmethod + def parse_common_folder_path(path: str) -> Dict[str, str]: + """Parse a folder path into its component segments.""" + m = re.match(r"^folders/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_organization_path( + organization: str, + ) -> str: + """Returns a fully-qualified organization string.""" + return "organizations/{organization}".format( + organization=organization, + ) + + @staticmethod + def parse_common_organization_path(path: str) -> Dict[str, str]: + """Parse a organization path into its component segments.""" + m = re.match(r"^organizations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_project_path( + project: str, + ) -> str: + """Returns a fully-qualified project string.""" + return "projects/{project}".format( + project=project, + ) + + @staticmethod + def parse_common_project_path(path: str) -> Dict[str, str]: + """Parse a project path into its component segments.""" + m = re.match(r"^projects/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_location_path( + project: str, + location: str, + ) -> str: + """Returns a fully-qualified location string.""" + return "projects/{project}/locations/{location}".format( + project=project, + location=location, + ) + + @staticmethod + def parse_common_location_path(path: str) -> Dict[str, str]: + """Parse a location path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @classmethod + def get_mtls_endpoint_and_cert_source( + cls, client_options: Optional[client_options_lib.ClientOptions] = None + ): + """Deprecated. 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. + """ + + warnings.warn( + "get_mtls_endpoint_and_cert_source is deprecated. Use the api_endpoint property instead.", + DeprecationWarning, + ) + 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 + + @staticmethod + def _read_environment_variables(): + """Returns the environment variables used by the client. + + Returns: + Tuple[bool, str, str]: returns the GOOGLE_API_USE_CLIENT_CERTIFICATE, + GOOGLE_API_USE_MTLS_ENDPOINT, and GOOGLE_CLOUD_UNIVERSE_DOMAIN environment variables. + + Raises: + ValueError: If GOOGLE_API_USE_CLIENT_CERTIFICATE is not + any of ["true", "false"]. + google.auth.exceptions.MutualTLSChannelError: If GOOGLE_API_USE_MTLS_ENDPOINT + is not any of ["auto", "never", "always"]. + """ + use_client_cert = os.getenv( + "GOOGLE_API_USE_CLIENT_CERTIFICATE", "false" + ).lower() + use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto").lower() + universe_domain_env = os.getenv("GOOGLE_CLOUD_UNIVERSE_DOMAIN") + 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`" + ) + return use_client_cert == "true", use_mtls_endpoint, universe_domain_env + + @staticmethod + def _get_client_cert_source(provided_cert_source, use_cert_flag): + """Return the client cert source to be used by the client. + + Args: + provided_cert_source (bytes): The client certificate source provided. + use_cert_flag (bool): A flag indicating whether to use the client certificate. + + Returns: + bytes or None: The client cert source to be used by the client. + """ + client_cert_source = None + if use_cert_flag: + if provided_cert_source: + client_cert_source = provided_cert_source + elif mtls.has_default_client_cert_source(): + client_cert_source = mtls.default_client_cert_source() + return client_cert_source + + @staticmethod + def _get_api_endpoint( + api_override, client_cert_source, universe_domain, use_mtls_endpoint + ): + """Return the API endpoint used by the client. + + Args: + api_override (str): The API endpoint override. If specified, this is always + the return value of this function and the other arguments are not used. + client_cert_source (bytes): The client certificate source used by the client. + universe_domain (str): The universe domain used by the client. + use_mtls_endpoint (str): How to use the mTLS endpoint, which depends also on the other parameters. + Possible values are "always", "auto", or "never". + + Returns: + str: The API endpoint to be used by the client. + """ + if api_override is not None: + api_endpoint = api_override + elif use_mtls_endpoint == "always" or ( + use_mtls_endpoint == "auto" and client_cert_source + ): + _default_universe = QuotaAdjusterSettingsManagerClient._DEFAULT_UNIVERSE + if universe_domain != _default_universe: + raise MutualTLSChannelError( + f"mTLS is not supported in any universe other than {_default_universe}." + ) + api_endpoint = QuotaAdjusterSettingsManagerClient.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = ( + QuotaAdjusterSettingsManagerClient._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=universe_domain + ) + ) + return api_endpoint + + @staticmethod + def _get_universe_domain( + client_universe_domain: Optional[str], universe_domain_env: Optional[str] + ) -> str: + """Return the universe domain used by the client. + + Args: + client_universe_domain (Optional[str]): The universe domain configured via the client options. + universe_domain_env (Optional[str]): The universe domain configured via the "GOOGLE_CLOUD_UNIVERSE_DOMAIN" environment variable. + + Returns: + str: The universe domain to be used by the client. + + Raises: + ValueError: If the universe domain is an empty string. + """ + universe_domain = QuotaAdjusterSettingsManagerClient._DEFAULT_UNIVERSE + if client_universe_domain is not None: + universe_domain = client_universe_domain + elif universe_domain_env is not None: + universe_domain = universe_domain_env + if len(universe_domain.strip()) == 0: + raise ValueError("Universe Domain cannot be an empty string.") + return universe_domain + + def _validate_universe_domain(self): + """Validates client's and credentials' universe domains are consistent. + + Returns: + bool: True iff the configured universe domain is valid. + + Raises: + ValueError: If the configured universe domain is not valid. + """ + + # NOTE (b/349488459): universe validation is disabled until further notice. + return True + + @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._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._universe_domain + + def __init__( + self, + *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Optional[ + Union[ + str, + QuotaAdjusterSettingsManagerTransport, + Callable[..., QuotaAdjusterSettingsManagerTransport], + ] + ] = None, + client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the quota adjuster settings manager 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,QuotaAdjusterSettingsManagerTransport,Callable[..., QuotaAdjusterSettingsManagerTransport]]]): + The transport to use, or a Callable that constructs and returns a new transport. + If a Callable is given, it will be called with the same set of initialization + arguments as used in the QuotaAdjusterSettingsManagerTransport constructor. + If set to None, a transport is chosen automatically. + 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 the ``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_options = client_options + if isinstance(self._client_options, dict): + self._client_options = client_options_lib.from_dict(self._client_options) + if self._client_options is None: + self._client_options = client_options_lib.ClientOptions() + self._client_options = cast( + client_options_lib.ClientOptions, self._client_options + ) + + universe_domain_opt = getattr(self._client_options, "universe_domain", None) + + ( + self._use_client_cert, + self._use_mtls_endpoint, + self._universe_domain_env, + ) = QuotaAdjusterSettingsManagerClient._read_environment_variables() + self._client_cert_source = ( + QuotaAdjusterSettingsManagerClient._get_client_cert_source( + self._client_options.client_cert_source, self._use_client_cert + ) + ) + self._universe_domain = QuotaAdjusterSettingsManagerClient._get_universe_domain( + universe_domain_opt, self._universe_domain_env + ) + self._api_endpoint = None # updated below, depending on `transport` + + # Initialize the universe domain validation. + self._is_universe_domain_valid = False + + if CLIENT_LOGGING_SUPPORTED: # pragma: NO COVER + # Setup logging. + client_logging.initialize_logging() + + api_key_value = getattr(self._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. + transport_provided = isinstance( + transport, QuotaAdjusterSettingsManagerTransport + ) + if transport_provided: + # transport is a QuotaAdjusterSettingsManagerTransport instance. + if credentials or self._client_options.credentials_file or api_key_value: + raise ValueError( + "When providing a transport instance, " + "provide its credentials directly." + ) + if self._client_options.scopes: + raise ValueError( + "When providing a transport instance, provide its scopes " + "directly." + ) + self._transport = cast(QuotaAdjusterSettingsManagerTransport, transport) + self._api_endpoint = self._transport.host + + self._api_endpoint = ( + self._api_endpoint + or QuotaAdjusterSettingsManagerClient._get_api_endpoint( + self._client_options.api_endpoint, + self._client_cert_source, + self._universe_domain, + self._use_mtls_endpoint, + ) + ) + + if not transport_provided: + 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_init: Union[ + Type[QuotaAdjusterSettingsManagerTransport], + Callable[..., QuotaAdjusterSettingsManagerTransport], + ] = ( + QuotaAdjusterSettingsManagerClient.get_transport_class(transport) + if isinstance(transport, str) or transport is None + else cast( + Callable[..., QuotaAdjusterSettingsManagerTransport], transport + ) + ) + # initialize with the provided callable or the passed in class + self._transport = transport_init( + credentials=credentials, + credentials_file=self._client_options.credentials_file, + host=self._api_endpoint, + scopes=self._client_options.scopes, + client_cert_source_for_mtls=self._client_cert_source, + quota_project_id=self._client_options.quota_project_id, + client_info=client_info, + always_use_jwt_access=True, + api_audience=self._client_options.api_audience, + ) + + if "async" not in str(self._transport): + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + std_logging.DEBUG + ): # pragma: NO COVER + _LOGGER.debug( + "Created client `google.api.cloudquotas_v1beta.QuotaAdjusterSettingsManagerClient`.", + extra={ + "serviceName": "google.api.cloudquotas.v1beta.QuotaAdjusterSettingsManager", + "universeDomain": getattr( + self._transport._credentials, "universe_domain", "" + ), + "credentialsType": f"{type(self._transport._credentials).__module__}.{type(self._transport._credentials).__qualname__}", + "credentialsInfo": getattr( + self.transport._credentials, "get_cred_info", lambda: None + )(), + } + if hasattr(self._transport, "_credentials") + else { + "serviceName": "google.api.cloudquotas.v1beta.QuotaAdjusterSettingsManager", + "credentialsType": None, + }, + ) + + def update_quota_adjuster_settings( + self, + request: Optional[ + Union[gac_quota_adjuster_settings.UpdateQuotaAdjusterSettingsRequest, dict] + ] = None, + *, + quota_adjuster_settings: Optional[ + gac_quota_adjuster_settings.QuotaAdjusterSettings + ] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> gac_quota_adjuster_settings.QuotaAdjusterSettings: + r"""RPC Method for updating QuotaAdjusterSettings based + on the request + + .. 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 google.cloud import cloudquotas_v1beta + + def sample_update_quota_adjuster_settings(): + # Create a client + client = cloudquotas_v1beta.QuotaAdjusterSettingsManagerClient() + + # Initialize request argument(s) + quota_adjuster_settings = cloudquotas_v1beta.QuotaAdjusterSettings() + quota_adjuster_settings.enablement = "DISABLED" + + request = cloudquotas_v1beta.UpdateQuotaAdjusterSettingsRequest( + quota_adjuster_settings=quota_adjuster_settings, + ) + + # Make the request + response = client.update_quota_adjuster_settings(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.cloudquotas_v1beta.types.UpdateQuotaAdjusterSettingsRequest, dict]): + The request object. Request for updating + QuotaAdjusterSettings + quota_adjuster_settings (google.cloud.cloudquotas_v1beta.types.QuotaAdjusterSettings): + Required. The QuotaAdjusterSettings + to update. + + This corresponds to the ``quota_adjuster_settings`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Optional. The list of fields to + update. + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + 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: + google.cloud.cloudquotas_v1beta.types.QuotaAdjusterSettings: + The QuotaAdjusterSettings resource + defines the settings for the Quota + Adjuster. + + """ + # 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. + has_flattened_params = any([quota_adjuster_settings, update_mask]) + 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, gac_quota_adjuster_settings.UpdateQuotaAdjusterSettingsRequest + ): + request = gac_quota_adjuster_settings.UpdateQuotaAdjusterSettingsRequest( + request + ) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if quota_adjuster_settings is not None: + request.quota_adjuster_settings = quota_adjuster_settings + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[ + self._transport.update_quota_adjuster_settings + ] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + ( + ( + "quota_adjuster_settings.name", + request.quota_adjuster_settings.name, + ), + ) + ), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_quota_adjuster_settings( + self, + request: Optional[ + Union[quota_adjuster_settings.GetQuotaAdjusterSettingsRequest, 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]]] = (), + ) -> quota_adjuster_settings.QuotaAdjusterSettings: + r"""RPC Method for getting QuotaAdjusterSettings based on + the request + + .. 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 google.cloud import cloudquotas_v1beta + + def sample_get_quota_adjuster_settings(): + # Create a client + client = cloudquotas_v1beta.QuotaAdjusterSettingsManagerClient() + + # Initialize request argument(s) + request = cloudquotas_v1beta.GetQuotaAdjusterSettingsRequest( + name="name_value", + ) + + # Make the request + response = client.get_quota_adjuster_settings(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.cloudquotas_v1beta.types.GetQuotaAdjusterSettingsRequest, dict]): + The request object. Request for getting + QuotaAdjusterSettings + name (str): + Required. Name of the config. + Required to be “settings”, as only a + single setting per container will be + supported initially. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + 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: + google.cloud.cloudquotas_v1beta.types.QuotaAdjusterSettings: + The QuotaAdjusterSettings resource + defines the settings for the Quota + Adjuster. + + """ + # 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. + has_flattened_params = any([name]) + 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, quota_adjuster_settings.GetQuotaAdjusterSettingsRequest + ): + request = quota_adjuster_settings.GetQuotaAdjusterSettingsRequest(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._transport._wrapped_methods[ + self._transport.get_quota_adjuster_settings + ] + + # 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._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def __enter__(self) -> "QuotaAdjusterSettingsManagerClient": + return self + + def __exit__(self, type, value, traceback): + """Releases underlying transport's resources. + + .. warning:: + ONLY use as a context manager if the transport is NOT shared + with other clients! Exiting the with block will CLOSE the transport + and may cause errors in other clients! + """ + self.transport.close() + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=package_version.__version__ +) + + +__all__ = ("QuotaAdjusterSettingsManagerClient",) diff --git a/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/quota_adjuster_settings_manager/transports/README.rst b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/quota_adjuster_settings_manager/transports/README.rst new file mode 100644 index 000000000000..243e5ebc1390 --- /dev/null +++ b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/quota_adjuster_settings_manager/transports/README.rst @@ -0,0 +1,9 @@ + +transport inheritance structure +_______________________________ + +`QuotaAdjusterSettingsManagerTransport` is the ABC for all transports. +- public child `QuotaAdjusterSettingsManagerGrpcTransport` for sync gRPC transport (defined in `grpc.py`). +- public child `QuotaAdjusterSettingsManagerGrpcAsyncIOTransport` for async gRPC transport (defined in `grpc_asyncio.py`). +- private child `_BaseQuotaAdjusterSettingsManagerRestTransport` for base REST transport with inner classes `_BaseMETHOD` (defined in `rest_base.py`). +- public child `QuotaAdjusterSettingsManagerRestTransport` for sync REST transport with inner classes `METHOD` derived from the parent's corresponding `_BaseMETHOD` classes (defined in `rest.py`). diff --git a/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/quota_adjuster_settings_manager/transports/__init__.py b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/quota_adjuster_settings_manager/transports/__init__.py new file mode 100644 index 000000000000..0db32cdea7d0 --- /dev/null +++ b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/quota_adjuster_settings_manager/transports/__init__.py @@ -0,0 +1,41 @@ +# -*- coding: utf-8 -*- +# 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. +# 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. +# +from collections import OrderedDict +from typing import Dict, Type + +from .base import QuotaAdjusterSettingsManagerTransport +from .grpc import QuotaAdjusterSettingsManagerGrpcTransport +from .grpc_asyncio import QuotaAdjusterSettingsManagerGrpcAsyncIOTransport +from .rest import ( + QuotaAdjusterSettingsManagerRestInterceptor, + QuotaAdjusterSettingsManagerRestTransport, +) + +# Compile a registry of transports. +_transport_registry = ( + OrderedDict() +) # type: Dict[str, Type[QuotaAdjusterSettingsManagerTransport]] +_transport_registry["grpc"] = QuotaAdjusterSettingsManagerGrpcTransport +_transport_registry["grpc_asyncio"] = QuotaAdjusterSettingsManagerGrpcAsyncIOTransport +_transport_registry["rest"] = QuotaAdjusterSettingsManagerRestTransport + +__all__ = ( + "QuotaAdjusterSettingsManagerTransport", + "QuotaAdjusterSettingsManagerGrpcTransport", + "QuotaAdjusterSettingsManagerGrpcAsyncIOTransport", + "QuotaAdjusterSettingsManagerRestTransport", + "QuotaAdjusterSettingsManagerRestInterceptor", +) diff --git a/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/quota_adjuster_settings_manager/transports/base.py b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/quota_adjuster_settings_manager/transports/base.py new file mode 100644 index 000000000000..9d635a043616 --- /dev/null +++ b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/quota_adjuster_settings_manager/transports/base.py @@ -0,0 +1,202 @@ +# -*- coding: utf-8 -*- +# 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. +# 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 abc +from typing import Awaitable, Callable, Dict, Optional, Sequence, Union + +import google.api_core +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +import google.auth # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.cloudquotas_v1beta import gapic_version as package_version +from google.cloud.cloudquotas_v1beta.types import ( + quota_adjuster_settings as gac_quota_adjuster_settings, +) +from google.cloud.cloudquotas_v1beta.types import quota_adjuster_settings + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=package_version.__version__ +) + + +class QuotaAdjusterSettingsManagerTransport(abc.ABC): + """Abstract transport class for QuotaAdjusterSettingsManager.""" + + AUTH_SCOPES = ("https://www.googleapis.com/auth/cloud-platform",) + + DEFAULT_HOST: str = "cloudquotas.googleapis.com" + + def __init__( + self, + *, + host: str = DEFAULT_HOST, + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + **kwargs, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to (default: 'cloudquotas.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]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A list of scopes. + 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're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + """ + + scopes_kwargs = {"scopes": scopes, "default_scopes": self.AUTH_SCOPES} + + # Save the scopes. + self._scopes = scopes + if not hasattr(self, "_ignore_credentials"): + self._ignore_credentials: bool = False + + # If no credentials are provided, then determine the appropriate + # defaults. + if credentials and credentials_file: + raise core_exceptions.DuplicateCredentialArgs( + "'credentials_file' and 'credentials' are mutually exclusive" + ) + + if credentials_file is not None: + credentials, _ = google.auth.load_credentials_from_file( + credentials_file, **scopes_kwargs, quota_project_id=quota_project_id + ) + elif credentials is None and not self._ignore_credentials: + credentials, _ = google.auth.default( + **scopes_kwargs, quota_project_id=quota_project_id + ) + # Don't apply audience if the credentials file passed from user. + if hasattr(credentials, "with_gdch_audience"): + credentials = credentials.with_gdch_audience( + api_audience if api_audience else host + ) + + # If the credentials are service account credentials, then always try to use self signed JWT. + if ( + always_use_jwt_access + and isinstance(credentials, service_account.Credentials) + and hasattr(service_account.Credentials, "with_always_use_jwt_access") + ): + credentials = credentials.with_always_use_jwt_access(True) + + # Save the credentials. + self._credentials = credentials + + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ":" not in host: + host += ":443" + self._host = host + + @property + def host(self): + return self._host + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.update_quota_adjuster_settings: gapic_v1.method.wrap_method( + self.update_quota_adjuster_settings, + default_retry=retries.Retry( + initial=1.0, + maximum=10.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.get_quota_adjuster_settings: gapic_v1.method.wrap_method( + self.get_quota_adjuster_settings, + default_retry=retries.Retry( + initial=1.0, + maximum=10.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + } + + def close(self): + """Closes resources associated with the transport. + + .. warning:: + Only call this method if the transport is NOT shared + with other clients - this may cause errors in other clients! + """ + raise NotImplementedError() + + @property + def update_quota_adjuster_settings( + self, + ) -> Callable[ + [gac_quota_adjuster_settings.UpdateQuotaAdjusterSettingsRequest], + Union[ + gac_quota_adjuster_settings.QuotaAdjusterSettings, + Awaitable[gac_quota_adjuster_settings.QuotaAdjusterSettings], + ], + ]: + raise NotImplementedError() + + @property + def get_quota_adjuster_settings( + self, + ) -> Callable[ + [quota_adjuster_settings.GetQuotaAdjusterSettingsRequest], + Union[ + quota_adjuster_settings.QuotaAdjusterSettings, + Awaitable[quota_adjuster_settings.QuotaAdjusterSettings], + ], + ]: + raise NotImplementedError() + + @property + def kind(self) -> str: + raise NotImplementedError() + + +__all__ = ("QuotaAdjusterSettingsManagerTransport",) diff --git a/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/quota_adjuster_settings_manager/transports/grpc.py b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/quota_adjuster_settings_manager/transports/grpc.py new file mode 100644 index 000000000000..1b5546eb560a --- /dev/null +++ b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/quota_adjuster_settings_manager/transports/grpc.py @@ -0,0 +1,403 @@ +# -*- coding: utf-8 -*- +# 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. +# 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 json +import logging as std_logging +import pickle +from typing import Callable, Dict, Optional, Sequence, Tuple, Union +import warnings + +from google.api_core import gapic_v1, grpc_helpers +import google.auth # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.protobuf.json_format import MessageToJson +import google.protobuf.message +import grpc # type: ignore +import proto # type: ignore + +from google.cloud.cloudquotas_v1beta.types import ( + quota_adjuster_settings as gac_quota_adjuster_settings, +) +from google.cloud.cloudquotas_v1beta.types import quota_adjuster_settings + +from .base import DEFAULT_CLIENT_INFO, QuotaAdjusterSettingsManagerTransport + +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 _LoggingClientInterceptor(grpc.UnaryUnaryClientInterceptor): # pragma: NO COVER + def intercept_unary_unary(self, continuation, client_call_details, request): + logging_enabled = CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + std_logging.DEBUG + ) + if logging_enabled: # pragma: NO COVER + request_metadata = client_call_details.metadata + if isinstance(request, proto.Message): + request_payload = type(request).to_json(request) + elif isinstance(request, google.protobuf.message.Message): + request_payload = MessageToJson(request) + else: + request_payload = f"{type(request).__name__}: {pickle.dumps(request)}" + + request_metadata = { + key: value.decode("utf-8") if isinstance(value, bytes) else value + for key, value in request_metadata + } + grpc_request = { + "payload": request_payload, + "requestMethod": "grpc", + "metadata": dict(request_metadata), + } + _LOGGER.debug( + f"Sending request for {client_call_details.method}", + extra={ + "serviceName": "google.api.cloudquotas.v1beta.QuotaAdjusterSettingsManager", + "rpcName": client_call_details.method, + "request": grpc_request, + "metadata": grpc_request["metadata"], + }, + ) + + response = continuation(client_call_details, request) + if logging_enabled: # pragma: NO COVER + response_metadata = response.trailing_metadata() + # Convert gRPC metadata `` to list of tuples + metadata = ( + dict([(k, str(v)) for k, v in response_metadata]) + if response_metadata + else None + ) + result = response.result() + if isinstance(result, proto.Message): + response_payload = type(result).to_json(result) + elif isinstance(result, google.protobuf.message.Message): + response_payload = MessageToJson(result) + else: + response_payload = f"{type(result).__name__}: {pickle.dumps(result)}" + grpc_response = { + "payload": response_payload, + "metadata": metadata, + "status": "OK", + } + _LOGGER.debug( + f"Received response for {client_call_details.method}.", + extra={ + "serviceName": "google.api.cloudquotas.v1beta.QuotaAdjusterSettingsManager", + "rpcName": client_call_details.method, + "response": grpc_response, + "metadata": grpc_response["metadata"], + }, + ) + return response + + +class QuotaAdjusterSettingsManagerGrpcTransport(QuotaAdjusterSettingsManagerTransport): + """gRPC backend transport for QuotaAdjusterSettingsManager. + + The Quotas Adjuster Settings API is an infrastructure service + for Google Cloud that lets service consumers view and update + their quota adjuster settings. + + - Update quota adjuster settings. + - Get the name of the configurations. + + 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 protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + + _stubs: Dict[str, Callable] + + def __init__( + self, + *, + host: str = "cloudquotas.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[Union[grpc.Channel, Callable[..., grpc.Channel]]] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = 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, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to (default: 'cloudquotas.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. + This argument is ignored if a ``channel`` instance is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if a ``channel`` instance is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if a ``channel`` instance is provided. + channel (Optional[Union[grpc.Channel, Callable[..., grpc.Channel]]]): + A ``Channel`` instance through which to make calls, or a Callable + that constructs and returns one. If set to None, ``self.create_channel`` + is used to create the channel. If a Callable is given, it will be called + with the same arguments as used in ``self.create_channel``. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if a ``channel`` instance is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if a ``channel`` instance or ``ssl_channel_credentials`` 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're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if isinstance(channel, grpc.Channel): + # Ignore credentials if a channel was passed. + credentials = None + self._ignore_credentials = True + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + # initialize with the provided callable or the default channel + channel_init = channel or type(self).create_channel + self._grpc_channel = channel_init( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + self._interceptor = _LoggingClientInterceptor() + self._logged_channel = grpc.intercept_channel( + self._grpc_channel, self._interceptor + ) + + # Wrap messages. This must be done after self._logged_channel exists + self._prep_wrapped_messages(client_info) + + @classmethod + def create_channel( + cls, + host: str = "cloudquotas.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs, + ) -> grpc.Channel: + """Create and return a gRPC channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + grpc.Channel: A gRPC channel object. + + Raises: + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + + return grpc_helpers.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs, + ) + + @property + def grpc_channel(self) -> grpc.Channel: + """Return the channel designed to connect to this service.""" + return self._grpc_channel + + @property + def update_quota_adjuster_settings( + self, + ) -> Callable[ + [gac_quota_adjuster_settings.UpdateQuotaAdjusterSettingsRequest], + gac_quota_adjuster_settings.QuotaAdjusterSettings, + ]: + r"""Return a callable for the update quota adjuster settings method over gRPC. + + RPC Method for updating QuotaAdjusterSettings based + on the request + + Returns: + Callable[[~.UpdateQuotaAdjusterSettingsRequest], + ~.QuotaAdjusterSettings]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "update_quota_adjuster_settings" not in self._stubs: + self._stubs[ + "update_quota_adjuster_settings" + ] = self._logged_channel.unary_unary( + "/google.api.cloudquotas.v1beta.QuotaAdjusterSettingsManager/UpdateQuotaAdjusterSettings", + request_serializer=gac_quota_adjuster_settings.UpdateQuotaAdjusterSettingsRequest.serialize, + response_deserializer=gac_quota_adjuster_settings.QuotaAdjusterSettings.deserialize, + ) + return self._stubs["update_quota_adjuster_settings"] + + @property + def get_quota_adjuster_settings( + self, + ) -> Callable[ + [quota_adjuster_settings.GetQuotaAdjusterSettingsRequest], + quota_adjuster_settings.QuotaAdjusterSettings, + ]: + r"""Return a callable for the get quota adjuster settings method over gRPC. + + RPC Method for getting QuotaAdjusterSettings based on + the request + + Returns: + Callable[[~.GetQuotaAdjusterSettingsRequest], + ~.QuotaAdjusterSettings]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_quota_adjuster_settings" not in self._stubs: + self._stubs[ + "get_quota_adjuster_settings" + ] = self._logged_channel.unary_unary( + "/google.api.cloudquotas.v1beta.QuotaAdjusterSettingsManager/GetQuotaAdjusterSettings", + request_serializer=quota_adjuster_settings.GetQuotaAdjusterSettingsRequest.serialize, + response_deserializer=quota_adjuster_settings.QuotaAdjusterSettings.deserialize, + ) + return self._stubs["get_quota_adjuster_settings"] + + def close(self): + self._logged_channel.close() + + @property + def kind(self) -> str: + return "grpc" + + +__all__ = ("QuotaAdjusterSettingsManagerGrpcTransport",) diff --git a/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/quota_adjuster_settings_manager/transports/grpc_asyncio.py b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/quota_adjuster_settings_manager/transports/grpc_asyncio.py new file mode 100644 index 000000000000..ad2220a63be0 --- /dev/null +++ b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/quota_adjuster_settings_manager/transports/grpc_asyncio.py @@ -0,0 +1,450 @@ +# -*- coding: utf-8 -*- +# 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. +# 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 inspect +import json +import logging as std_logging +import pickle +from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union +import warnings + +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1, grpc_helpers_async +from google.api_core import retry_async as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.protobuf.json_format import MessageToJson +import google.protobuf.message +import grpc # type: ignore +from grpc.experimental import aio # type: ignore +import proto # type: ignore + +from google.cloud.cloudquotas_v1beta.types import ( + quota_adjuster_settings as gac_quota_adjuster_settings, +) +from google.cloud.cloudquotas_v1beta.types import quota_adjuster_settings + +from .base import DEFAULT_CLIENT_INFO, QuotaAdjusterSettingsManagerTransport +from .grpc import QuotaAdjusterSettingsManagerGrpcTransport + +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 _LoggingClientAIOInterceptor( + grpc.aio.UnaryUnaryClientInterceptor +): # pragma: NO COVER + async def intercept_unary_unary(self, continuation, client_call_details, request): + logging_enabled = CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + std_logging.DEBUG + ) + if logging_enabled: # pragma: NO COVER + request_metadata = client_call_details.metadata + if isinstance(request, proto.Message): + request_payload = type(request).to_json(request) + elif isinstance(request, google.protobuf.message.Message): + request_payload = MessageToJson(request) + else: + request_payload = f"{type(request).__name__}: {pickle.dumps(request)}" + + request_metadata = { + key: value.decode("utf-8") if isinstance(value, bytes) else value + for key, value in request_metadata + } + grpc_request = { + "payload": request_payload, + "requestMethod": "grpc", + "metadata": dict(request_metadata), + } + _LOGGER.debug( + f"Sending request for {client_call_details.method}", + extra={ + "serviceName": "google.api.cloudquotas.v1beta.QuotaAdjusterSettingsManager", + "rpcName": str(client_call_details.method), + "request": grpc_request, + "metadata": grpc_request["metadata"], + }, + ) + response = await continuation(client_call_details, request) + if logging_enabled: # pragma: NO COVER + response_metadata = await response.trailing_metadata() + # Convert gRPC metadata `` to list of tuples + metadata = ( + dict([(k, str(v)) for k, v in response_metadata]) + if response_metadata + else None + ) + result = await response + if isinstance(result, proto.Message): + response_payload = type(result).to_json(result) + elif isinstance(result, google.protobuf.message.Message): + response_payload = MessageToJson(result) + else: + response_payload = f"{type(result).__name__}: {pickle.dumps(result)}" + grpc_response = { + "payload": response_payload, + "metadata": metadata, + "status": "OK", + } + _LOGGER.debug( + f"Received response to rpc {client_call_details.method}.", + extra={ + "serviceName": "google.api.cloudquotas.v1beta.QuotaAdjusterSettingsManager", + "rpcName": str(client_call_details.method), + "response": grpc_response, + "metadata": grpc_response["metadata"], + }, + ) + return response + + +class QuotaAdjusterSettingsManagerGrpcAsyncIOTransport( + QuotaAdjusterSettingsManagerTransport +): + """gRPC AsyncIO backend transport for QuotaAdjusterSettingsManager. + + The Quotas Adjuster Settings API is an infrastructure service + for Google Cloud that lets service consumers view and update + their quota adjuster settings. + + - Update quota adjuster settings. + - Get the name of the configurations. + + 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 protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + + _grpc_channel: aio.Channel + _stubs: Dict[str, Callable] = {} + + @classmethod + def create_channel( + cls, + host: str = "cloudquotas.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs, + ) -> aio.Channel: + """Create and return a gRPC AsyncIO channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + aio.Channel: A gRPC AsyncIO channel object. + """ + + return grpc_helpers_async.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs, + ) + + def __init__( + self, + *, + host: str = "cloudquotas.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[Union[aio.Channel, Callable[..., aio.Channel]]] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = 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, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to (default: 'cloudquotas.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. + This argument is ignored if a ``channel`` instance is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if a ``channel`` instance is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + channel (Optional[Union[aio.Channel, Callable[..., aio.Channel]]]): + A ``Channel`` instance through which to make calls, or a Callable + that constructs and returns one. If set to None, ``self.create_channel`` + is used to create the channel. If a Callable is given, it will be called + with the same arguments as used in ``self.create_channel``. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if a ``channel`` instance is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if a ``channel`` instance or ``ssl_channel_credentials`` 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're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if isinstance(channel, aio.Channel): + # Ignore credentials if a channel was passed. + credentials = None + self._ignore_credentials = True + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + # initialize with the provided callable or the default channel + channel_init = channel or type(self).create_channel + self._grpc_channel = channel_init( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + self._interceptor = _LoggingClientAIOInterceptor() + self._grpc_channel._unary_unary_interceptors.append(self._interceptor) + self._logged_channel = self._grpc_channel + self._wrap_with_kind = ( + "kind" in inspect.signature(gapic_v1.method_async.wrap_method).parameters + ) + # Wrap messages. This must be done after self._logged_channel exists + self._prep_wrapped_messages(client_info) + + @property + def grpc_channel(self) -> aio.Channel: + """Create the channel designed to connect to this service. + + This property caches on the instance; repeated calls return + the same channel. + """ + # Return the channel from cache. + return self._grpc_channel + + @property + def update_quota_adjuster_settings( + self, + ) -> Callable[ + [gac_quota_adjuster_settings.UpdateQuotaAdjusterSettingsRequest], + Awaitable[gac_quota_adjuster_settings.QuotaAdjusterSettings], + ]: + r"""Return a callable for the update quota adjuster settings method over gRPC. + + RPC Method for updating QuotaAdjusterSettings based + on the request + + Returns: + Callable[[~.UpdateQuotaAdjusterSettingsRequest], + Awaitable[~.QuotaAdjusterSettings]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "update_quota_adjuster_settings" not in self._stubs: + self._stubs[ + "update_quota_adjuster_settings" + ] = self._logged_channel.unary_unary( + "/google.api.cloudquotas.v1beta.QuotaAdjusterSettingsManager/UpdateQuotaAdjusterSettings", + request_serializer=gac_quota_adjuster_settings.UpdateQuotaAdjusterSettingsRequest.serialize, + response_deserializer=gac_quota_adjuster_settings.QuotaAdjusterSettings.deserialize, + ) + return self._stubs["update_quota_adjuster_settings"] + + @property + def get_quota_adjuster_settings( + self, + ) -> Callable[ + [quota_adjuster_settings.GetQuotaAdjusterSettingsRequest], + Awaitable[quota_adjuster_settings.QuotaAdjusterSettings], + ]: + r"""Return a callable for the get quota adjuster settings method over gRPC. + + RPC Method for getting QuotaAdjusterSettings based on + the request + + Returns: + Callable[[~.GetQuotaAdjusterSettingsRequest], + Awaitable[~.QuotaAdjusterSettings]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_quota_adjuster_settings" not in self._stubs: + self._stubs[ + "get_quota_adjuster_settings" + ] = self._logged_channel.unary_unary( + "/google.api.cloudquotas.v1beta.QuotaAdjusterSettingsManager/GetQuotaAdjusterSettings", + request_serializer=quota_adjuster_settings.GetQuotaAdjusterSettingsRequest.serialize, + response_deserializer=quota_adjuster_settings.QuotaAdjusterSettings.deserialize, + ) + return self._stubs["get_quota_adjuster_settings"] + + def _prep_wrapped_messages(self, client_info): + """Precompute the wrapped methods, overriding the base class method to use async wrappers.""" + self._wrapped_methods = { + self.update_quota_adjuster_settings: self._wrap_method( + self.update_quota_adjuster_settings, + default_retry=retries.AsyncRetry( + initial=1.0, + maximum=10.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.get_quota_adjuster_settings: self._wrap_method( + self.get_quota_adjuster_settings, + default_retry=retries.AsyncRetry( + initial=1.0, + maximum=10.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + } + + def _wrap_method(self, func, *args, **kwargs): + if self._wrap_with_kind: # pragma: NO COVER + kwargs["kind"] = self.kind + return gapic_v1.method_async.wrap_method(func, *args, **kwargs) + + def close(self): + return self._logged_channel.close() + + @property + def kind(self) -> str: + return "grpc_asyncio" + + +__all__ = ("QuotaAdjusterSettingsManagerGrpcAsyncIOTransport",) diff --git a/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/quota_adjuster_settings_manager/transports/rest.py b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/quota_adjuster_settings_manager/transports/rest.py new file mode 100644 index 000000000000..4fc463427378 --- /dev/null +++ b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/quota_adjuster_settings_manager/transports/rest.py @@ -0,0 +1,584 @@ +# -*- coding: utf-8 -*- +# 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. +# 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 dataclasses +import json # type: ignore +import logging +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1, rest_helpers, rest_streaming +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.requests import AuthorizedSession # type: ignore +from google.protobuf import json_format +from requests import __version__ as requests_version + +from google.cloud.cloudquotas_v1beta.types import ( + quota_adjuster_settings as gac_quota_adjuster_settings, +) +from google.cloud.cloudquotas_v1beta.types import quota_adjuster_settings + +from .base import DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO +from .rest_base import _BaseQuotaAdjusterSettingsManagerRestTransport + +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}", +) + + +class QuotaAdjusterSettingsManagerRestInterceptor: + """Interceptor for QuotaAdjusterSettingsManager. + + 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 QuotaAdjusterSettingsManagerRestTransport. + + .. code-block:: python + class MyCustomQuotaAdjusterSettingsManagerInterceptor(QuotaAdjusterSettingsManagerRestInterceptor): + def pre_get_quota_adjuster_settings(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_quota_adjuster_settings(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_update_quota_adjuster_settings(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_quota_adjuster_settings(self, response): + logging.log(f"Received response: {response}") + return response + + transport = QuotaAdjusterSettingsManagerRestTransport(interceptor=MyCustomQuotaAdjusterSettingsManagerInterceptor()) + client = QuotaAdjusterSettingsManagerClient(transport=transport) + + + """ + + def pre_get_quota_adjuster_settings( + self, + request: quota_adjuster_settings.GetQuotaAdjusterSettingsRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + quota_adjuster_settings.GetQuotaAdjusterSettingsRequest, + Sequence[Tuple[str, Union[str, bytes]]], + ]: + """Pre-rpc interceptor for get_quota_adjuster_settings + + Override in a subclass to manipulate the request or metadata + before they are sent to the QuotaAdjusterSettingsManager server. + """ + return request, metadata + + def post_get_quota_adjuster_settings( + self, response: quota_adjuster_settings.QuotaAdjusterSettings + ) -> quota_adjuster_settings.QuotaAdjusterSettings: + """Post-rpc interceptor for get_quota_adjuster_settings + + Override in a subclass to manipulate the response + after it is returned by the QuotaAdjusterSettingsManager server but before + it is returned to user code. + """ + return response + + def pre_update_quota_adjuster_settings( + self, + request: gac_quota_adjuster_settings.UpdateQuotaAdjusterSettingsRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + gac_quota_adjuster_settings.UpdateQuotaAdjusterSettingsRequest, + Sequence[Tuple[str, Union[str, bytes]]], + ]: + """Pre-rpc interceptor for update_quota_adjuster_settings + + Override in a subclass to manipulate the request or metadata + before they are sent to the QuotaAdjusterSettingsManager server. + """ + return request, metadata + + def post_update_quota_adjuster_settings( + self, response: gac_quota_adjuster_settings.QuotaAdjusterSettings + ) -> gac_quota_adjuster_settings.QuotaAdjusterSettings: + """Post-rpc interceptor for update_quota_adjuster_settings + + Override in a subclass to manipulate the response + after it is returned by the QuotaAdjusterSettingsManager server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class QuotaAdjusterSettingsManagerRestStub: + _session: AuthorizedSession + _host: str + _interceptor: QuotaAdjusterSettingsManagerRestInterceptor + + +class QuotaAdjusterSettingsManagerRestTransport( + _BaseQuotaAdjusterSettingsManagerRestTransport +): + """REST backend synchronous transport for QuotaAdjusterSettingsManager. + + The Quotas Adjuster Settings API is an infrastructure service + for Google Cloud that lets service consumers view and update + their quota adjuster settings. + + - Update quota adjuster settings. + - Get the name of the configurations. + + 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 = "cloudquotas.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[QuotaAdjusterSettingsManagerRestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to (default: 'cloudquotas.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]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + 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 QuotaAdjusterSettingsManagerRestInterceptor() + self._prep_wrapped_messages(client_info) + + class _GetQuotaAdjusterSettings( + _BaseQuotaAdjusterSettingsManagerRestTransport._BaseGetQuotaAdjusterSettings, + QuotaAdjusterSettingsManagerRestStub, + ): + def __hash__(self): + return hash( + "QuotaAdjusterSettingsManagerRestTransport.GetQuotaAdjusterSettings" + ) + + @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: quota_adjuster_settings.GetQuotaAdjusterSettingsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> quota_adjuster_settings.QuotaAdjusterSettings: + r"""Call the get quota adjuster + settings method over HTTP. + + Args: + request (~.quota_adjuster_settings.GetQuotaAdjusterSettingsRequest): + The request object. Request for getting + QuotaAdjusterSettings + 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: + ~.quota_adjuster_settings.QuotaAdjusterSettings: + The QuotaAdjusterSettings resource + defines the settings for the Quota + Adjuster. + + """ + + http_options = ( + _BaseQuotaAdjusterSettingsManagerRestTransport._BaseGetQuotaAdjusterSettings._get_http_options() + ) + + request, metadata = self._interceptor.pre_get_quota_adjuster_settings( + request, metadata + ) + transcoded_request = _BaseQuotaAdjusterSettingsManagerRestTransport._BaseGetQuotaAdjusterSettings._get_transcoded_request( + http_options, request + ) + + # Jsonify the query params + query_params = _BaseQuotaAdjusterSettingsManagerRestTransport._BaseGetQuotaAdjusterSettings._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.api.cloudquotas_v1beta.QuotaAdjusterSettingsManagerClient.GetQuotaAdjusterSettings", + extra={ + "serviceName": "google.api.cloudquotas.v1beta.QuotaAdjusterSettingsManager", + "rpcName": "GetQuotaAdjusterSettings", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = QuotaAdjusterSettingsManagerRestTransport._GetQuotaAdjusterSettings._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 = quota_adjuster_settings.QuotaAdjusterSettings() + pb_resp = quota_adjuster_settings.QuotaAdjusterSettings.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_get_quota_adjuster_settings(resp) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + try: + response_payload = ( + quota_adjuster_settings.QuotaAdjusterSettings.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.api.cloudquotas_v1beta.QuotaAdjusterSettingsManagerClient.get_quota_adjuster_settings", + extra={ + "serviceName": "google.api.cloudquotas.v1beta.QuotaAdjusterSettingsManager", + "rpcName": "GetQuotaAdjusterSettings", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _UpdateQuotaAdjusterSettings( + _BaseQuotaAdjusterSettingsManagerRestTransport._BaseUpdateQuotaAdjusterSettings, + QuotaAdjusterSettingsManagerRestStub, + ): + def __hash__(self): + return hash( + "QuotaAdjusterSettingsManagerRestTransport.UpdateQuotaAdjusterSettings" + ) + + @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), + data=body, + ) + return response + + def __call__( + self, + request: gac_quota_adjuster_settings.UpdateQuotaAdjusterSettingsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> gac_quota_adjuster_settings.QuotaAdjusterSettings: + r"""Call the update quota adjuster + settings method over HTTP. + + Args: + request (~.gac_quota_adjuster_settings.UpdateQuotaAdjusterSettingsRequest): + The request object. Request for updating + QuotaAdjusterSettings + 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: + ~.gac_quota_adjuster_settings.QuotaAdjusterSettings: + The QuotaAdjusterSettings resource + defines the settings for the Quota + Adjuster. + + """ + + http_options = ( + _BaseQuotaAdjusterSettingsManagerRestTransport._BaseUpdateQuotaAdjusterSettings._get_http_options() + ) + + request, metadata = self._interceptor.pre_update_quota_adjuster_settings( + request, metadata + ) + transcoded_request = _BaseQuotaAdjusterSettingsManagerRestTransport._BaseUpdateQuotaAdjusterSettings._get_transcoded_request( + http_options, request + ) + + body = _BaseQuotaAdjusterSettingsManagerRestTransport._BaseUpdateQuotaAdjusterSettings._get_request_body_json( + transcoded_request + ) + + # Jsonify the query params + query_params = _BaseQuotaAdjusterSettingsManagerRestTransport._BaseUpdateQuotaAdjusterSettings._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.api.cloudquotas_v1beta.QuotaAdjusterSettingsManagerClient.UpdateQuotaAdjusterSettings", + extra={ + "serviceName": "google.api.cloudquotas.v1beta.QuotaAdjusterSettingsManager", + "rpcName": "UpdateQuotaAdjusterSettings", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = QuotaAdjusterSettingsManagerRestTransport._UpdateQuotaAdjusterSettings._get_response( + self._host, + metadata, + query_params, + self._session, + timeout, + transcoded_request, + body, + ) + + # 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 = gac_quota_adjuster_settings.QuotaAdjusterSettings() + pb_resp = gac_quota_adjuster_settings.QuotaAdjusterSettings.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_update_quota_adjuster_settings(resp) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + try: + response_payload = ( + gac_quota_adjuster_settings.QuotaAdjusterSettings.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.api.cloudquotas_v1beta.QuotaAdjusterSettingsManagerClient.update_quota_adjuster_settings", + extra={ + "serviceName": "google.api.cloudquotas.v1beta.QuotaAdjusterSettingsManager", + "rpcName": "UpdateQuotaAdjusterSettings", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + @property + def get_quota_adjuster_settings( + self, + ) -> Callable[ + [quota_adjuster_settings.GetQuotaAdjusterSettingsRequest], + quota_adjuster_settings.QuotaAdjusterSettings, + ]: + # 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._GetQuotaAdjusterSettings(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_quota_adjuster_settings( + self, + ) -> Callable[ + [gac_quota_adjuster_settings.UpdateQuotaAdjusterSettingsRequest], + gac_quota_adjuster_settings.QuotaAdjusterSettings, + ]: + # 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._UpdateQuotaAdjusterSettings(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__ = ("QuotaAdjusterSettingsManagerRestTransport",) diff --git a/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/quota_adjuster_settings_manager/transports/rest_base.py b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/quota_adjuster_settings_manager/transports/rest_base.py new file mode 100644 index 000000000000..7438cca4d010 --- /dev/null +++ b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/services/quota_adjuster_settings_manager/transports/rest_base.py @@ -0,0 +1,206 @@ +# -*- coding: utf-8 -*- +# 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. +# 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 json # type: ignore +import re +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union + +from google.api_core import gapic_v1, path_template +from google.protobuf import json_format + +from google.cloud.cloudquotas_v1beta.types import ( + quota_adjuster_settings as gac_quota_adjuster_settings, +) +from google.cloud.cloudquotas_v1beta.types import quota_adjuster_settings + +from .base import DEFAULT_CLIENT_INFO, QuotaAdjusterSettingsManagerTransport + + +class _BaseQuotaAdjusterSettingsManagerRestTransport( + QuotaAdjusterSettingsManagerTransport +): + """Base REST backend transport for QuotaAdjusterSettingsManager. + + Note: This class is not meant to be used directly. Use its sync and + async sub-classes instead. + + 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 = "cloudquotas.googleapis.com", + credentials: Optional[Any] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + url_scheme: str = "https", + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + Args: + host (Optional[str]): + The hostname to connect to (default: 'cloudquotas.googleapis.com'). + credentials (Optional[Any]): 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. + 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 + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError( + f"Unexpected hostname structure: {host}" + ) # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + class _BaseGetQuotaAdjusterSettings: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1beta/{name=projects/*/locations/*/quotaAdjusterSettings}", + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = quota_adjuster_settings.GetQuotaAdjusterSettingsRequest.pb( + request + ) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + use_integers_for_enums=True, + ) + ) + query_params.update( + _BaseQuotaAdjusterSettingsManagerRestTransport._BaseGetQuotaAdjusterSettings._get_unset_required_fields( + query_params + ) + ) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseUpdateQuotaAdjusterSettings: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [ + { + "method": "patch", + "uri": "/v1beta/{quota_adjuster_settings.name=projects/*/locations/*/quotaAdjusterSettings}", + "body": "quota_adjuster_settings", + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = ( + gac_quota_adjuster_settings.UpdateQuotaAdjusterSettingsRequest.pb( + request + ) + ) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_request_body_json(transcoded_request): + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], use_integers_for_enums=True + ) + return body + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + use_integers_for_enums=True, + ) + ) + query_params.update( + _BaseQuotaAdjusterSettingsManagerRestTransport._BaseUpdateQuotaAdjusterSettings._get_unset_required_fields( + query_params + ) + ) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + +__all__ = ("_BaseQuotaAdjusterSettingsManagerRestTransport",) diff --git a/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/types/__init__.py b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/types/__init__.py new file mode 100644 index 000000000000..04ef5137da86 --- /dev/null +++ b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/types/__init__.py @@ -0,0 +1,62 @@ +# -*- coding: utf-8 -*- +# 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. +# 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. +# +from .cloudquotas import ( + CreateQuotaPreferenceRequest, + GetQuotaInfoRequest, + GetQuotaPreferenceRequest, + ListQuotaInfosRequest, + ListQuotaInfosResponse, + ListQuotaPreferencesRequest, + ListQuotaPreferencesResponse, + UpdateQuotaPreferenceRequest, +) +from .quota_adjuster_settings import ( + GetQuotaAdjusterSettingsRequest, + QuotaAdjusterSettings, + UpdateQuotaAdjusterSettingsRequest, +) +from .resources import ( + DimensionsInfo, + QuotaConfig, + QuotaDetails, + QuotaIncreaseEligibility, + QuotaInfo, + QuotaPreference, + QuotaSafetyCheck, + RolloutInfo, +) + +__all__ = ( + "CreateQuotaPreferenceRequest", + "GetQuotaInfoRequest", + "GetQuotaPreferenceRequest", + "ListQuotaInfosRequest", + "ListQuotaInfosResponse", + "ListQuotaPreferencesRequest", + "ListQuotaPreferencesResponse", + "UpdateQuotaPreferenceRequest", + "GetQuotaAdjusterSettingsRequest", + "QuotaAdjusterSettings", + "UpdateQuotaAdjusterSettingsRequest", + "DimensionsInfo", + "QuotaConfig", + "QuotaDetails", + "QuotaIncreaseEligibility", + "QuotaInfo", + "QuotaPreference", + "RolloutInfo", + "QuotaSafetyCheck", +) diff --git a/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/types/cloudquotas.py b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/types/cloudquotas.py new file mode 100644 index 000000000000..a3a4960ec2c0 --- /dev/null +++ b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/types/cloudquotas.py @@ -0,0 +1,325 @@ +# -*- coding: utf-8 -*- +# 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. +# 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. +# +from __future__ import annotations + +from typing import MutableMapping, MutableSequence + +from google.protobuf import field_mask_pb2 # type: ignore +import proto # type: ignore + +from google.cloud.cloudquotas_v1beta.types import resources + +__protobuf__ = proto.module( + package="google.api.cloudquotas.v1beta", + manifest={ + "ListQuotaInfosRequest", + "ListQuotaInfosResponse", + "GetQuotaInfoRequest", + "ListQuotaPreferencesRequest", + "ListQuotaPreferencesResponse", + "GetQuotaPreferenceRequest", + "CreateQuotaPreferenceRequest", + "UpdateQuotaPreferenceRequest", + }, +) + + +class ListQuotaInfosRequest(proto.Message): + r"""Message for requesting list of QuotaInfos + + Attributes: + parent (str): + Required. Parent value of QuotaInfo resources. Listing + across different resource containers (such as 'projects/-') + is not allowed. + + Example names: + ``projects/123/locations/global/services/compute.googleapis.com`` + ``folders/234/locations/global/services/compute.googleapis.com`` + ``organizations/345/locations/global/services/compute.googleapis.com`` + page_size (int): + Optional. Requested page size. Server may + return fewer items than requested. If + unspecified, server will pick an appropriate + default. + page_token (str): + Optional. A token identifying a page of + results the server should return. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + page_size: int = proto.Field( + proto.INT32, + number=2, + ) + page_token: str = proto.Field( + proto.STRING, + number=3, + ) + + +class ListQuotaInfosResponse(proto.Message): + r"""Message for response to listing QuotaInfos + + Attributes: + quota_infos (MutableSequence[google.cloud.cloudquotas_v1beta.types.QuotaInfo]): + The list of QuotaInfo + next_page_token (str): + A token, which can be sent as ``page_token`` to retrieve the + next page. If this field is omitted, there are no subsequent + pages. + """ + + @property + def raw_page(self): + return self + + quota_infos: MutableSequence[resources.QuotaInfo] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message=resources.QuotaInfo, + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + + +class GetQuotaInfoRequest(proto.Message): + r"""Message for getting a QuotaInfo + + Attributes: + name (str): + Required. The resource name of the quota info. + + An example name: + ``projects/123/locations/global/services/compute.googleapis.com/quotaInfos/CpusPerProjectPerRegion`` + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class ListQuotaPreferencesRequest(proto.Message): + r"""Message for requesting list of QuotaPreferences + + Attributes: + parent (str): + Required. Parent value of QuotaPreference resources. Listing + across different resource containers (such as 'projects/-') + is not allowed. + + When the value starts with 'folders' or 'organizations', it + lists the QuotaPreferences for org quotas in the container. + It does not list the QuotaPreferences in the descendant + projects of the container. + + Example parents: ``projects/123/locations/global`` + page_size (int): + Optional. Requested page size. Server may + return fewer items than requested. If + unspecified, server will pick an appropriate + default. + page_token (str): + Optional. A token identifying a page of + results the server should return. + filter (str): + Optional. Filter result QuotaPreferences by their state, + type, create/update time range. + + Example filters: + ``reconciling=true AND request_type=CLOUD_CONSOLE``, + ``reconciling=true OR creation_time>2022-12-03T10:30:00`` + order_by (str): + Optional. How to order of the results. By default, the + results are ordered by create time. + + Example orders: ``quota_id``, ``service, create_time`` + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + page_size: int = proto.Field( + proto.INT32, + number=2, + ) + page_token: str = proto.Field( + proto.STRING, + number=3, + ) + filter: str = proto.Field( + proto.STRING, + number=4, + ) + order_by: str = proto.Field( + proto.STRING, + number=5, + ) + + +class ListQuotaPreferencesResponse(proto.Message): + r"""Message for response to listing QuotaPreferences + + Attributes: + quota_preferences (MutableSequence[google.cloud.cloudquotas_v1beta.types.QuotaPreference]): + The list of QuotaPreference + next_page_token (str): + A token, which can be sent as ``page_token`` to retrieve the + next page. If this field is omitted, there are no subsequent + pages. + unreachable (MutableSequence[str]): + Locations that could not be reached. + """ + + @property + def raw_page(self): + return self + + quota_preferences: MutableSequence[resources.QuotaPreference] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message=resources.QuotaPreference, + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + unreachable: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=3, + ) + + +class GetQuotaPreferenceRequest(proto.Message): + r"""Message for getting a QuotaPreference + + Attributes: + name (str): + Required. Name of the resource + + Example name: + ``projects/123/locations/global/quota_preferences/my-config-for-us-east1`` + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class CreateQuotaPreferenceRequest(proto.Message): + r"""Message for creating a QuotaPreference + + Attributes: + parent (str): + Required. Value for parent. + + Example: ``projects/123/locations/global`` + quota_preference_id (str): + Optional. Id of the requesting object, must + be unique under its parent. If client does not + set this field, the service will generate one. + quota_preference (google.cloud.cloudquotas_v1beta.types.QuotaPreference): + Required. The resource being created + ignore_safety_checks (MutableSequence[google.cloud.cloudquotas_v1beta.types.QuotaSafetyCheck]): + The list of quota safety checks to be + ignored. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + quota_preference_id: str = proto.Field( + proto.STRING, + number=2, + ) + quota_preference: resources.QuotaPreference = proto.Field( + proto.MESSAGE, + number=3, + message=resources.QuotaPreference, + ) + ignore_safety_checks: MutableSequence[ + resources.QuotaSafetyCheck + ] = proto.RepeatedField( + proto.ENUM, + number=4, + enum=resources.QuotaSafetyCheck, + ) + + +class UpdateQuotaPreferenceRequest(proto.Message): + r"""Message for updating a QuotaPreference + + Attributes: + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Optional. Field mask is used to specify the fields to be + overwritten in the QuotaPreference resource by the update. + The fields specified in the update_mask are relative to the + resource, not the full request. A field will be overwritten + if it is in the mask. If the user does not provide a mask + then all fields will be overwritten. + quota_preference (google.cloud.cloudquotas_v1beta.types.QuotaPreference): + Required. The resource being updated + allow_missing (bool): + Optional. If set to true, and the quota preference is not + found, a new one will be created. In this situation, + ``update_mask`` is ignored. + validate_only (bool): + Optional. If set to true, validate the + request, but do not actually update. Note that a + request being valid does not mean that the + request is guaranteed to be fulfilled. + ignore_safety_checks (MutableSequence[google.cloud.cloudquotas_v1beta.types.QuotaSafetyCheck]): + The list of quota safety checks to be + ignored. + """ + + update_mask: field_mask_pb2.FieldMask = proto.Field( + proto.MESSAGE, + number=1, + message=field_mask_pb2.FieldMask, + ) + quota_preference: resources.QuotaPreference = proto.Field( + proto.MESSAGE, + number=2, + message=resources.QuotaPreference, + ) + allow_missing: bool = proto.Field( + proto.BOOL, + number=3, + ) + validate_only: bool = proto.Field( + proto.BOOL, + number=4, + ) + ignore_safety_checks: MutableSequence[ + resources.QuotaSafetyCheck + ] = proto.RepeatedField( + proto.ENUM, + number=5, + enum=resources.QuotaSafetyCheck, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/types/quota_adjuster_settings.py b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/types/quota_adjuster_settings.py new file mode 100644 index 000000000000..fbf1faea81eb --- /dev/null +++ b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/types/quota_adjuster_settings.py @@ -0,0 +1,142 @@ +# -*- coding: utf-8 -*- +# 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. +# 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. +# +from __future__ import annotations + +from typing import MutableMapping, MutableSequence + +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +import proto # type: ignore + +__protobuf__ = proto.module( + package="google.api.cloudquotas.v1beta", + manifest={ + "GetQuotaAdjusterSettingsRequest", + "UpdateQuotaAdjusterSettingsRequest", + "QuotaAdjusterSettings", + }, +) + + +class GetQuotaAdjusterSettingsRequest(proto.Message): + r"""Request for getting QuotaAdjusterSettings + + Attributes: + name (str): + Required. Name of the config. Required to be + “settings”, as only a single setting per + container will be supported initially. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class UpdateQuotaAdjusterSettingsRequest(proto.Message): + r"""Request for updating QuotaAdjusterSettings + + Attributes: + quota_adjuster_settings (google.cloud.cloudquotas_v1beta.types.QuotaAdjusterSettings): + Required. The QuotaAdjusterSettings to + update. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Optional. The list of fields to update. + validate_only (bool): + Optional. If set to true, validate the + request, but do not actually update. Note that a + request being valid does not mean that the + request is guaranteed to be fulfilled. + """ + + quota_adjuster_settings: "QuotaAdjusterSettings" = proto.Field( + proto.MESSAGE, + number=1, + message="QuotaAdjusterSettings", + ) + update_mask: field_mask_pb2.FieldMask = proto.Field( + proto.MESSAGE, + number=2, + message=field_mask_pb2.FieldMask, + ) + validate_only: bool = proto.Field( + proto.BOOL, + number=3, + ) + + +class QuotaAdjusterSettings(proto.Message): + r"""The QuotaAdjusterSettings resource defines the settings for + the Quota Adjuster. + + Attributes: + name (str): + Identifier. Name of the config would be of + the format: + projects/12345/locations/global/quotaAdjusterSettings + enablement (google.cloud.cloudquotas_v1beta.types.QuotaAdjusterSettings.Enablement): + Required. The configured value of the + enablement at the given resource. + update_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The timestamp when the + QuotaAdjusterSettings was last updated. + etag (str): + Optional. The current etag of the + QuotaAdjusterSettings. If an etag is provided on + update and does not match the current server's + etag of the QuotaAdjusterSettings, the request + will be blocked and an ABORTED error will be + returned. See https://google.aip.dev/134#etags + for more details on etags. + """ + + class Enablement(proto.Enum): + r"""The enablement status of the quota adjuster. + + Values: + ENABLEMENT_UNSPECIFIED (0): + The quota adjuster is in an unknown state. + ENABLED (2): + The quota adjuster is enabled. + DISABLED (3): + The quota adjuster is disabled. + """ + ENABLEMENT_UNSPECIFIED = 0 + ENABLED = 2 + DISABLED = 3 + + name: str = proto.Field( + proto.STRING, + number=1, + ) + enablement: Enablement = proto.Field( + proto.ENUM, + number=2, + enum=Enablement, + ) + update_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=5, + message=timestamp_pb2.Timestamp, + ) + etag: str = proto.Field( + proto.STRING, + number=6, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/types/resources.py b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/types/resources.py new file mode 100644 index 000000000000..d771863482dd --- /dev/null +++ b/packages/google-cloud-quotas/google/cloud/cloudquotas_v1beta/types/resources.py @@ -0,0 +1,534 @@ +# -*- coding: utf-8 -*- +# 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. +# 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. +# +from __future__ import annotations + +from typing import MutableMapping, MutableSequence + +from google.protobuf import timestamp_pb2 # type: ignore +from google.protobuf import wrappers_pb2 # type: ignore +import proto # type: ignore + +__protobuf__ = proto.module( + package="google.api.cloudquotas.v1beta", + manifest={ + "QuotaSafetyCheck", + "QuotaInfo", + "QuotaIncreaseEligibility", + "QuotaPreference", + "QuotaConfig", + "DimensionsInfo", + "QuotaDetails", + "RolloutInfo", + }, +) + + +class QuotaSafetyCheck(proto.Enum): + r"""Enumerations of quota safety checks. + + Values: + QUOTA_SAFETY_CHECK_UNSPECIFIED (0): + Unspecified quota safety check. + QUOTA_DECREASE_BELOW_USAGE (1): + Validates that a quota mutation would not + cause the consumer's effective limit to be lower + than the consumer's quota usage. + QUOTA_DECREASE_PERCENTAGE_TOO_HIGH (2): + Validates that a quota mutation would not + cause the consumer's effective limit to decrease + by more than 10 percent. + """ + QUOTA_SAFETY_CHECK_UNSPECIFIED = 0 + QUOTA_DECREASE_BELOW_USAGE = 1 + QUOTA_DECREASE_PERCENTAGE_TOO_HIGH = 2 + + +class QuotaInfo(proto.Message): + r"""QuotaInfo represents information about a particular quota for + a given project, folder or organization. + + Attributes: + name (str): + Resource name of this QuotaInfo. The ID component following + "locations/" must be "global". Example: + ``projects/123/locations/global/services/compute.googleapis.com/quotaInfos/CpusPerProjectPerRegion`` + quota_id (str): + The id of the quota, which is unquie within the service. + Example: ``CpusPerProjectPerRegion`` + metric (str): + The metric of the quota. It specifies the resources + consumption the quota is defined for. Example: + ``compute.googleapis.com/cpus`` + service (str): + The name of the service in which the quota is defined. + Example: ``compute.googleapis.com`` + is_precise (bool): + Whether this is a precise quota. A precise + quota is tracked with absolute precision. In + contrast, an imprecise quota is not tracked with + precision. + refresh_interval (str): + The reset time interval for the quota. + Refresh interval applies to rate quota only. + Example: "minute" for per minute, "day" for per + day, or "10 seconds" for every 10 seconds. + container_type (google.cloud.cloudquotas_v1beta.types.QuotaInfo.ContainerType): + The container type of the QuotaInfo. + dimensions (MutableSequence[str]): + The dimensions the quota is defined on. + metric_display_name (str): + The display name of the quota metric + quota_display_name (str): + The display name of the quota. + metric_unit (str): + The unit in which the metric value is + reported, e.g., "MByte". + quota_increase_eligibility (google.cloud.cloudquotas_v1beta.types.QuotaIncreaseEligibility): + Whether it is eligible to request a higher + quota value for this quota. + is_fixed (bool): + Whether the quota value is fixed or + adjustable + dimensions_infos (MutableSequence[google.cloud.cloudquotas_v1beta.types.DimensionsInfo]): + The collection of dimensions info ordered by + their dimensions from more specific ones to less + specific ones. + is_concurrent (bool): + Whether the quota is a concurrent quota. + Concurrent quotas are enforced on the total + number of concurrent operations in flight at any + given time. + service_request_quota_uri (str): + URI to the page where users can request more + quota for the cloud service—for example, + https://console.cloud.google.com/iam-admin/quotas. + """ + + class ContainerType(proto.Enum): + r"""The enumeration of the types of a cloud resource container. + + Values: + CONTAINER_TYPE_UNSPECIFIED (0): + Unspecified container type. + PROJECT (1): + consumer project + FOLDER (2): + folder + ORGANIZATION (3): + organization + """ + CONTAINER_TYPE_UNSPECIFIED = 0 + PROJECT = 1 + FOLDER = 2 + ORGANIZATION = 3 + + name: str = proto.Field( + proto.STRING, + number=1, + ) + quota_id: str = proto.Field( + proto.STRING, + number=2, + ) + metric: str = proto.Field( + proto.STRING, + number=3, + ) + service: str = proto.Field( + proto.STRING, + number=4, + ) + is_precise: bool = proto.Field( + proto.BOOL, + number=5, + ) + refresh_interval: str = proto.Field( + proto.STRING, + number=6, + ) + container_type: ContainerType = proto.Field( + proto.ENUM, + number=7, + enum=ContainerType, + ) + dimensions: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=8, + ) + metric_display_name: str = proto.Field( + proto.STRING, + number=9, + ) + quota_display_name: str = proto.Field( + proto.STRING, + number=10, + ) + metric_unit: str = proto.Field( + proto.STRING, + number=11, + ) + quota_increase_eligibility: "QuotaIncreaseEligibility" = proto.Field( + proto.MESSAGE, + number=12, + message="QuotaIncreaseEligibility", + ) + is_fixed: bool = proto.Field( + proto.BOOL, + number=13, + ) + dimensions_infos: MutableSequence["DimensionsInfo"] = proto.RepeatedField( + proto.MESSAGE, + number=14, + message="DimensionsInfo", + ) + is_concurrent: bool = proto.Field( + proto.BOOL, + number=15, + ) + service_request_quota_uri: str = proto.Field( + proto.STRING, + number=17, + ) + + +class QuotaIncreaseEligibility(proto.Message): + r"""Eligibility information regarding requesting increase + adjustment of a quota. + + Attributes: + is_eligible (bool): + Whether a higher quota value can be requested + for the quota. + ineligibility_reason (google.cloud.cloudquotas_v1beta.types.QuotaIncreaseEligibility.IneligibilityReason): + The reason of why it is ineligible to request increased + value of the quota. If the is_eligible field is true, it + defaults to INELIGIBILITY_REASON_UNSPECIFIED. + """ + + class IneligibilityReason(proto.Enum): + r"""The enumeration of reasons when it is ineligible to request + increase adjustment. + + Values: + INELIGIBILITY_REASON_UNSPECIFIED (0): + Default value when is_eligible is true. + NO_VALID_BILLING_ACCOUNT (1): + The container is not linked with a valid + billing account. + NOT_SUPPORTED (3): + Quota increase is not supported for the + quota. + NOT_ENOUGH_USAGE_HISTORY (4): + There is not enough usage history to + determine the eligibility. + OTHER (2): + Other reasons. + """ + INELIGIBILITY_REASON_UNSPECIFIED = 0 + NO_VALID_BILLING_ACCOUNT = 1 + NOT_SUPPORTED = 3 + NOT_ENOUGH_USAGE_HISTORY = 4 + OTHER = 2 + + is_eligible: bool = proto.Field( + proto.BOOL, + number=1, + ) + ineligibility_reason: IneligibilityReason = proto.Field( + proto.ENUM, + number=2, + enum=IneligibilityReason, + ) + + +class QuotaPreference(proto.Message): + r"""QuotaPreference represents the preferred quota configuration + specified for a project, folder or organization. There is only + one QuotaPreference resource for a quota value targeting a + unique set of dimensions. + + Attributes: + name (str): + Required except in the CREATE requests. The resource name of + the quota preference. The ID component following + "locations/" must be "global". Example: + ``projects/123/locations/global/quotaPreferences/my-config-for-us-east1`` + dimensions (MutableMapping[str, str]): + Immutable. The dimensions that this quota preference applies + to. The key of the map entry is the name of a dimension, + such as "region", "zone", "network_id", and the value of the + map entry is the dimension value. + + If a dimension is missing from the map of dimensions, the + quota preference applies to all the dimension values except + for those that have other quota preferences configured for + the specific value. + + NOTE: QuotaPreferences can only be applied across all values + of "user" and "resource" dimension. Do not set values for + "user" or "resource" in the dimension map. + + Example: {"provider", "Foo Inc"} where "provider" is a + service specific dimension. + quota_config (google.cloud.cloudquotas_v1beta.types.QuotaConfig): + Required. Preferred quota configuration. + etag (str): + Optional. The current etag of the quota + preference. If an etag is provided on update and + does not match the current server's etag of the + quota preference, the request will be blocked + and an ABORTED error will be returned. See + https://google.aip.dev/134#etags for more + details on etags. + create_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. Create time stamp + update_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. Update time stamp + service (str): + Required. The name of the service to which + the quota preference is applied. + quota_id (str): + Required. The id of the quota to which the quota preference + is applied. A quota name is unique in the service. Example: + ``CpusPerProjectPerRegion`` + reconciling (bool): + Output only. Is the quota preference pending + Google Cloud approval and fulfillment. + justification (str): + The reason / justification for this quota + preference. + contact_email (str): + Input only. An email address that can be used to contact the + the user, in case Google Cloud needs more information to + make a decision before additional quota can be granted. + + When requesting a quota increase, the email address is + required. When requesting a quota decrease, the email + address is optional. For example, the email address is + optional when the ``QuotaConfig.preferred_value`` is smaller + than the ``QuotaDetails.reset_value``. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + dimensions: MutableMapping[str, str] = proto.MapField( + proto.STRING, + proto.STRING, + number=2, + ) + quota_config: "QuotaConfig" = proto.Field( + proto.MESSAGE, + number=3, + message="QuotaConfig", + ) + etag: str = proto.Field( + proto.STRING, + number=4, + ) + create_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=5, + message=timestamp_pb2.Timestamp, + ) + update_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=6, + message=timestamp_pb2.Timestamp, + ) + service: str = proto.Field( + proto.STRING, + number=7, + ) + quota_id: str = proto.Field( + proto.STRING, + number=8, + ) + reconciling: bool = proto.Field( + proto.BOOL, + number=10, + ) + justification: str = proto.Field( + proto.STRING, + number=11, + ) + contact_email: str = proto.Field( + proto.STRING, + number=12, + ) + + +class QuotaConfig(proto.Message): + r"""The preferred quota configuration. + + Attributes: + preferred_value (int): + Required. The preferred value. Must be + greater than or equal to -1. If set to -1, it + means the value is "unlimited". + state_detail (str): + Output only. Optional details about the state + of this quota preference. + granted_value (google.protobuf.wrappers_pb2.Int64Value): + Output only. Granted quota value. + trace_id (str): + Output only. The trace id that the Google + Cloud uses to provision the requested quota. + This trace id may be used by the client to + contact Cloud support to track the state of a + quota preference request. The trace id is only + produced for increase requests and is unique for + each request. The quota decrease requests do not + have a trace id. + annotations (MutableMapping[str, str]): + Optional. The annotations map for clients to + store small amounts of arbitrary data. Do not + put PII or other sensitive information here. See + https://google.aip.dev/128#annotations + request_origin (google.cloud.cloudquotas_v1beta.types.QuotaConfig.Origin): + Output only. The origin of the quota + preference request. + """ + + class Origin(proto.Enum): + r"""The enumeration of the origins of quota preference requests. + + Values: + ORIGIN_UNSPECIFIED (0): + The unspecified value. + CLOUD_CONSOLE (1): + Created through Cloud Console. + AUTO_ADJUSTER (2): + Generated by automatic quota adjustment. + """ + ORIGIN_UNSPECIFIED = 0 + CLOUD_CONSOLE = 1 + AUTO_ADJUSTER = 2 + + preferred_value: int = proto.Field( + proto.INT64, + number=1, + ) + state_detail: str = proto.Field( + proto.STRING, + number=2, + ) + granted_value: wrappers_pb2.Int64Value = proto.Field( + proto.MESSAGE, + number=3, + message=wrappers_pb2.Int64Value, + ) + trace_id: str = proto.Field( + proto.STRING, + number=4, + ) + annotations: MutableMapping[str, str] = proto.MapField( + proto.STRING, + proto.STRING, + number=5, + ) + request_origin: Origin = proto.Field( + proto.ENUM, + number=6, + enum=Origin, + ) + + +class DimensionsInfo(proto.Message): + r"""The detailed quota information such as effective quota value + for a combination of dimensions. + + Attributes: + dimensions (MutableMapping[str, str]): + The map of dimensions for this dimensions + info. The key of a map entry is "region", "zone" + or the name of a service specific dimension, and + the value of a map entry is the value of the + dimension. If a dimension does not appear in + the map of dimensions, the dimensions info + applies to all the dimension values except for + those that have another DimenisonInfo instance + configured for the specific value. + Example: {"provider" : "Foo Inc"} where + "provider" is a service specific dimension of a + quota. + details (google.cloud.cloudquotas_v1beta.types.QuotaDetails): + Quota details for the specified dimensions. + applicable_locations (MutableSequence[str]): + The applicable regions or zones of this dimensions info. The + field will be set to ['global'] for quotas that are not per + region or per zone. Otherwise, it will be set to the list of + locations this dimension info is applicable to. + """ + + dimensions: MutableMapping[str, str] = proto.MapField( + proto.STRING, + proto.STRING, + number=1, + ) + details: "QuotaDetails" = proto.Field( + proto.MESSAGE, + number=2, + message="QuotaDetails", + ) + applicable_locations: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=3, + ) + + +class QuotaDetails(proto.Message): + r"""The quota details for a map of dimensions. + + Attributes: + value (int): + The value currently in effect and being + enforced. + rollout_info (google.cloud.cloudquotas_v1beta.types.RolloutInfo): + Rollout information of this quota. + This field is present only if the effective + limit will change due to the ongoing rollout of + the service config. + """ + + value: int = proto.Field( + proto.INT64, + number=1, + ) + rollout_info: "RolloutInfo" = proto.Field( + proto.MESSAGE, + number=3, + message="RolloutInfo", + ) + + +class RolloutInfo(proto.Message): + r"""[Output only] Rollout information of a quota. + + Attributes: + ongoing_rollout (bool): + Whether there is an ongoing rollout for a + quota or not. + """ + + ongoing_rollout: bool = proto.Field( + proto.BOOL, + number=1, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_cloud_quotas_create_quota_preference_async.py b/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_cloud_quotas_create_quota_preference_async.py new file mode 100644 index 000000000000..949559f7e279 --- /dev/null +++ b/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_cloud_quotas_create_quota_preference_async.py @@ -0,0 +1,58 @@ +# -*- coding: utf-8 -*- +# 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. +# 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreateQuotaPreference +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-quotas + + +# [START cloudquotas_v1beta_generated_CloudQuotas_CreateQuotaPreference_async] +# 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 google.cloud import cloudquotas_v1beta + + +async def sample_create_quota_preference(): + # Create a client + client = cloudquotas_v1beta.CloudQuotasAsyncClient() + + # Initialize request argument(s) + quota_preference = cloudquotas_v1beta.QuotaPreference() + quota_preference.quota_config.preferred_value = 1595 + quota_preference.service = "service_value" + quota_preference.quota_id = "quota_id_value" + + request = cloudquotas_v1beta.CreateQuotaPreferenceRequest( + parent="parent_value", + quota_preference=quota_preference, + ) + + # Make the request + response = await client.create_quota_preference(request=request) + + # Handle the response + print(response) + +# [END cloudquotas_v1beta_generated_CloudQuotas_CreateQuotaPreference_async] diff --git a/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_cloud_quotas_create_quota_preference_sync.py b/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_cloud_quotas_create_quota_preference_sync.py new file mode 100644 index 000000000000..5dccbfd1d5c3 --- /dev/null +++ b/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_cloud_quotas_create_quota_preference_sync.py @@ -0,0 +1,58 @@ +# -*- coding: utf-8 -*- +# 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. +# 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreateQuotaPreference +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-quotas + + +# [START cloudquotas_v1beta_generated_CloudQuotas_CreateQuotaPreference_sync] +# 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 google.cloud import cloudquotas_v1beta + + +def sample_create_quota_preference(): + # Create a client + client = cloudquotas_v1beta.CloudQuotasClient() + + # Initialize request argument(s) + quota_preference = cloudquotas_v1beta.QuotaPreference() + quota_preference.quota_config.preferred_value = 1595 + quota_preference.service = "service_value" + quota_preference.quota_id = "quota_id_value" + + request = cloudquotas_v1beta.CreateQuotaPreferenceRequest( + parent="parent_value", + quota_preference=quota_preference, + ) + + # Make the request + response = client.create_quota_preference(request=request) + + # Handle the response + print(response) + +# [END cloudquotas_v1beta_generated_CloudQuotas_CreateQuotaPreference_sync] diff --git a/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_cloud_quotas_get_quota_info_async.py b/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_cloud_quotas_get_quota_info_async.py new file mode 100644 index 000000000000..b4449707f744 --- /dev/null +++ b/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_cloud_quotas_get_quota_info_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# 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. +# 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetQuotaInfo +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-quotas + + +# [START cloudquotas_v1beta_generated_CloudQuotas_GetQuotaInfo_async] +# 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 google.cloud import cloudquotas_v1beta + + +async def sample_get_quota_info(): + # Create a client + client = cloudquotas_v1beta.CloudQuotasAsyncClient() + + # Initialize request argument(s) + request = cloudquotas_v1beta.GetQuotaInfoRequest( + name="name_value", + ) + + # Make the request + response = await client.get_quota_info(request=request) + + # Handle the response + print(response) + +# [END cloudquotas_v1beta_generated_CloudQuotas_GetQuotaInfo_async] diff --git a/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_cloud_quotas_get_quota_info_sync.py b/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_cloud_quotas_get_quota_info_sync.py new file mode 100644 index 000000000000..0f77ad926aaa --- /dev/null +++ b/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_cloud_quotas_get_quota_info_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# 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. +# 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetQuotaInfo +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-quotas + + +# [START cloudquotas_v1beta_generated_CloudQuotas_GetQuotaInfo_sync] +# 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 google.cloud import cloudquotas_v1beta + + +def sample_get_quota_info(): + # Create a client + client = cloudquotas_v1beta.CloudQuotasClient() + + # Initialize request argument(s) + request = cloudquotas_v1beta.GetQuotaInfoRequest( + name="name_value", + ) + + # Make the request + response = client.get_quota_info(request=request) + + # Handle the response + print(response) + +# [END cloudquotas_v1beta_generated_CloudQuotas_GetQuotaInfo_sync] diff --git a/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_cloud_quotas_get_quota_preference_async.py b/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_cloud_quotas_get_quota_preference_async.py new file mode 100644 index 000000000000..b89fa1f33b87 --- /dev/null +++ b/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_cloud_quotas_get_quota_preference_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# 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. +# 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetQuotaPreference +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-quotas + + +# [START cloudquotas_v1beta_generated_CloudQuotas_GetQuotaPreference_async] +# 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 google.cloud import cloudquotas_v1beta + + +async def sample_get_quota_preference(): + # Create a client + client = cloudquotas_v1beta.CloudQuotasAsyncClient() + + # Initialize request argument(s) + request = cloudquotas_v1beta.GetQuotaPreferenceRequest( + name="name_value", + ) + + # Make the request + response = await client.get_quota_preference(request=request) + + # Handle the response + print(response) + +# [END cloudquotas_v1beta_generated_CloudQuotas_GetQuotaPreference_async] diff --git a/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_cloud_quotas_get_quota_preference_sync.py b/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_cloud_quotas_get_quota_preference_sync.py new file mode 100644 index 000000000000..e2d14b807c95 --- /dev/null +++ b/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_cloud_quotas_get_quota_preference_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# 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. +# 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetQuotaPreference +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-quotas + + +# [START cloudquotas_v1beta_generated_CloudQuotas_GetQuotaPreference_sync] +# 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 google.cloud import cloudquotas_v1beta + + +def sample_get_quota_preference(): + # Create a client + client = cloudquotas_v1beta.CloudQuotasClient() + + # Initialize request argument(s) + request = cloudquotas_v1beta.GetQuotaPreferenceRequest( + name="name_value", + ) + + # Make the request + response = client.get_quota_preference(request=request) + + # Handle the response + print(response) + +# [END cloudquotas_v1beta_generated_CloudQuotas_GetQuotaPreference_sync] diff --git a/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_cloud_quotas_list_quota_infos_async.py b/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_cloud_quotas_list_quota_infos_async.py new file mode 100644 index 000000000000..18d4d012f256 --- /dev/null +++ b/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_cloud_quotas_list_quota_infos_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# 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. +# 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListQuotaInfos +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-quotas + + +# [START cloudquotas_v1beta_generated_CloudQuotas_ListQuotaInfos_async] +# 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 google.cloud import cloudquotas_v1beta + + +async def sample_list_quota_infos(): + # Create a client + client = cloudquotas_v1beta.CloudQuotasAsyncClient() + + # Initialize request argument(s) + request = cloudquotas_v1beta.ListQuotaInfosRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_quota_infos(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END cloudquotas_v1beta_generated_CloudQuotas_ListQuotaInfos_async] diff --git a/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_cloud_quotas_list_quota_infos_sync.py b/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_cloud_quotas_list_quota_infos_sync.py new file mode 100644 index 000000000000..67f5e1620ec7 --- /dev/null +++ b/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_cloud_quotas_list_quota_infos_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# 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. +# 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListQuotaInfos +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-quotas + + +# [START cloudquotas_v1beta_generated_CloudQuotas_ListQuotaInfos_sync] +# 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 google.cloud import cloudquotas_v1beta + + +def sample_list_quota_infos(): + # Create a client + client = cloudquotas_v1beta.CloudQuotasClient() + + # Initialize request argument(s) + request = cloudquotas_v1beta.ListQuotaInfosRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_quota_infos(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END cloudquotas_v1beta_generated_CloudQuotas_ListQuotaInfos_sync] diff --git a/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_cloud_quotas_list_quota_preferences_async.py b/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_cloud_quotas_list_quota_preferences_async.py new file mode 100644 index 000000000000..ed78abb389e1 --- /dev/null +++ b/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_cloud_quotas_list_quota_preferences_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# 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. +# 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListQuotaPreferences +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-quotas + + +# [START cloudquotas_v1beta_generated_CloudQuotas_ListQuotaPreferences_async] +# 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 google.cloud import cloudquotas_v1beta + + +async def sample_list_quota_preferences(): + # Create a client + client = cloudquotas_v1beta.CloudQuotasAsyncClient() + + # Initialize request argument(s) + request = cloudquotas_v1beta.ListQuotaPreferencesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_quota_preferences(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END cloudquotas_v1beta_generated_CloudQuotas_ListQuotaPreferences_async] diff --git a/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_cloud_quotas_list_quota_preferences_sync.py b/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_cloud_quotas_list_quota_preferences_sync.py new file mode 100644 index 000000000000..06198d242056 --- /dev/null +++ b/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_cloud_quotas_list_quota_preferences_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# 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. +# 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListQuotaPreferences +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-quotas + + +# [START cloudquotas_v1beta_generated_CloudQuotas_ListQuotaPreferences_sync] +# 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 google.cloud import cloudquotas_v1beta + + +def sample_list_quota_preferences(): + # Create a client + client = cloudquotas_v1beta.CloudQuotasClient() + + # Initialize request argument(s) + request = cloudquotas_v1beta.ListQuotaPreferencesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_quota_preferences(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END cloudquotas_v1beta_generated_CloudQuotas_ListQuotaPreferences_sync] diff --git a/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_cloud_quotas_update_quota_preference_async.py b/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_cloud_quotas_update_quota_preference_async.py new file mode 100644 index 000000000000..b6f2488f8b42 --- /dev/null +++ b/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_cloud_quotas_update_quota_preference_async.py @@ -0,0 +1,57 @@ +# -*- coding: utf-8 -*- +# 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. +# 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateQuotaPreference +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-quotas + + +# [START cloudquotas_v1beta_generated_CloudQuotas_UpdateQuotaPreference_async] +# 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 google.cloud import cloudquotas_v1beta + + +async def sample_update_quota_preference(): + # Create a client + client = cloudquotas_v1beta.CloudQuotasAsyncClient() + + # Initialize request argument(s) + quota_preference = cloudquotas_v1beta.QuotaPreference() + quota_preference.quota_config.preferred_value = 1595 + quota_preference.service = "service_value" + quota_preference.quota_id = "quota_id_value" + + request = cloudquotas_v1beta.UpdateQuotaPreferenceRequest( + quota_preference=quota_preference, + ) + + # Make the request + response = await client.update_quota_preference(request=request) + + # Handle the response + print(response) + +# [END cloudquotas_v1beta_generated_CloudQuotas_UpdateQuotaPreference_async] diff --git a/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_cloud_quotas_update_quota_preference_sync.py b/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_cloud_quotas_update_quota_preference_sync.py new file mode 100644 index 000000000000..6fec459bab50 --- /dev/null +++ b/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_cloud_quotas_update_quota_preference_sync.py @@ -0,0 +1,57 @@ +# -*- coding: utf-8 -*- +# 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. +# 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateQuotaPreference +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-quotas + + +# [START cloudquotas_v1beta_generated_CloudQuotas_UpdateQuotaPreference_sync] +# 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 google.cloud import cloudquotas_v1beta + + +def sample_update_quota_preference(): + # Create a client + client = cloudquotas_v1beta.CloudQuotasClient() + + # Initialize request argument(s) + quota_preference = cloudquotas_v1beta.QuotaPreference() + quota_preference.quota_config.preferred_value = 1595 + quota_preference.service = "service_value" + quota_preference.quota_id = "quota_id_value" + + request = cloudquotas_v1beta.UpdateQuotaPreferenceRequest( + quota_preference=quota_preference, + ) + + # Make the request + response = client.update_quota_preference(request=request) + + # Handle the response + print(response) + +# [END cloudquotas_v1beta_generated_CloudQuotas_UpdateQuotaPreference_sync] diff --git a/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_quota_adjuster_settings_manager_get_quota_adjuster_settings_async.py b/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_quota_adjuster_settings_manager_get_quota_adjuster_settings_async.py new file mode 100644 index 000000000000..470d45943c1e --- /dev/null +++ b/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_quota_adjuster_settings_manager_get_quota_adjuster_settings_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# 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. +# 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetQuotaAdjusterSettings +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-quotas + + +# [START cloudquotas_v1beta_generated_QuotaAdjusterSettingsManager_GetQuotaAdjusterSettings_async] +# 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 google.cloud import cloudquotas_v1beta + + +async def sample_get_quota_adjuster_settings(): + # Create a client + client = cloudquotas_v1beta.QuotaAdjusterSettingsManagerAsyncClient() + + # Initialize request argument(s) + request = cloudquotas_v1beta.GetQuotaAdjusterSettingsRequest( + name="name_value", + ) + + # Make the request + response = await client.get_quota_adjuster_settings(request=request) + + # Handle the response + print(response) + +# [END cloudquotas_v1beta_generated_QuotaAdjusterSettingsManager_GetQuotaAdjusterSettings_async] diff --git a/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_quota_adjuster_settings_manager_get_quota_adjuster_settings_sync.py b/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_quota_adjuster_settings_manager_get_quota_adjuster_settings_sync.py new file mode 100644 index 000000000000..1b47584dc87c --- /dev/null +++ b/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_quota_adjuster_settings_manager_get_quota_adjuster_settings_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# 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. +# 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetQuotaAdjusterSettings +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-quotas + + +# [START cloudquotas_v1beta_generated_QuotaAdjusterSettingsManager_GetQuotaAdjusterSettings_sync] +# 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 google.cloud import cloudquotas_v1beta + + +def sample_get_quota_adjuster_settings(): + # Create a client + client = cloudquotas_v1beta.QuotaAdjusterSettingsManagerClient() + + # Initialize request argument(s) + request = cloudquotas_v1beta.GetQuotaAdjusterSettingsRequest( + name="name_value", + ) + + # Make the request + response = client.get_quota_adjuster_settings(request=request) + + # Handle the response + print(response) + +# [END cloudquotas_v1beta_generated_QuotaAdjusterSettingsManager_GetQuotaAdjusterSettings_sync] diff --git a/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_quota_adjuster_settings_manager_update_quota_adjuster_settings_async.py b/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_quota_adjuster_settings_manager_update_quota_adjuster_settings_async.py new file mode 100644 index 000000000000..97eff93476ac --- /dev/null +++ b/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_quota_adjuster_settings_manager_update_quota_adjuster_settings_async.py @@ -0,0 +1,55 @@ +# -*- coding: utf-8 -*- +# 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. +# 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateQuotaAdjusterSettings +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-quotas + + +# [START cloudquotas_v1beta_generated_QuotaAdjusterSettingsManager_UpdateQuotaAdjusterSettings_async] +# 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 google.cloud import cloudquotas_v1beta + + +async def sample_update_quota_adjuster_settings(): + # Create a client + client = cloudquotas_v1beta.QuotaAdjusterSettingsManagerAsyncClient() + + # Initialize request argument(s) + quota_adjuster_settings = cloudquotas_v1beta.QuotaAdjusterSettings() + quota_adjuster_settings.enablement = "DISABLED" + + request = cloudquotas_v1beta.UpdateQuotaAdjusterSettingsRequest( + quota_adjuster_settings=quota_adjuster_settings, + ) + + # Make the request + response = await client.update_quota_adjuster_settings(request=request) + + # Handle the response + print(response) + +# [END cloudquotas_v1beta_generated_QuotaAdjusterSettingsManager_UpdateQuotaAdjusterSettings_async] diff --git a/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_quota_adjuster_settings_manager_update_quota_adjuster_settings_sync.py b/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_quota_adjuster_settings_manager_update_quota_adjuster_settings_sync.py new file mode 100644 index 000000000000..4ba5b38854aa --- /dev/null +++ b/packages/google-cloud-quotas/samples/generated_samples/cloudquotas_v1beta_generated_quota_adjuster_settings_manager_update_quota_adjuster_settings_sync.py @@ -0,0 +1,55 @@ +# -*- coding: utf-8 -*- +# 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. +# 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateQuotaAdjusterSettings +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-quotas + + +# [START cloudquotas_v1beta_generated_QuotaAdjusterSettingsManager_UpdateQuotaAdjusterSettings_sync] +# 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 google.cloud import cloudquotas_v1beta + + +def sample_update_quota_adjuster_settings(): + # Create a client + client = cloudquotas_v1beta.QuotaAdjusterSettingsManagerClient() + + # Initialize request argument(s) + quota_adjuster_settings = cloudquotas_v1beta.QuotaAdjusterSettings() + quota_adjuster_settings.enablement = "DISABLED" + + request = cloudquotas_v1beta.UpdateQuotaAdjusterSettingsRequest( + quota_adjuster_settings=quota_adjuster_settings, + ) + + # Make the request + response = client.update_quota_adjuster_settings(request=request) + + # Handle the response + print(response) + +# [END cloudquotas_v1beta_generated_QuotaAdjusterSettingsManager_UpdateQuotaAdjusterSettings_sync] diff --git a/packages/google-cloud-quotas/samples/generated_samples/snippet_metadata_google.api.cloudquotas.v1.json b/packages/google-cloud-quotas/samples/generated_samples/snippet_metadata_google.api.cloudquotas.v1.json index ad4bbb7ec10a..5c9d0867f7f3 100644 --- a/packages/google-cloud-quotas/samples/generated_samples/snippet_metadata_google.api.cloudquotas.v1.json +++ b/packages/google-cloud-quotas/samples/generated_samples/snippet_metadata_google.api.cloudquotas.v1.json @@ -8,7 +8,7 @@ ], "language": "PYTHON", "name": "google-cloud-quotas", - "version": "0.1.14" + "version": "0.1.0" }, "snippets": [ { diff --git a/packages/google-cloud-quotas/samples/generated_samples/snippet_metadata_google.api.cloudquotas.v1beta.json b/packages/google-cloud-quotas/samples/generated_samples/snippet_metadata_google.api.cloudquotas.v1beta.json new file mode 100644 index 000000000000..785a0e000fa7 --- /dev/null +++ b/packages/google-cloud-quotas/samples/generated_samples/snippet_metadata_google.api.cloudquotas.v1beta.json @@ -0,0 +1,1335 @@ +{ + "clientLibrary": { + "apis": [ + { + "id": "google.api.cloudquotas.v1beta", + "version": "v1beta" + } + ], + "language": "PYTHON", + "name": "google-cloud-quotas", + "version": "0.1.0" + }, + "snippets": [ + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.cloudquotas_v1beta.CloudQuotasAsyncClient", + "shortName": "CloudQuotasAsyncClient" + }, + "fullName": "google.cloud.cloudquotas_v1beta.CloudQuotasAsyncClient.create_quota_preference", + "method": { + "fullName": "google.api.cloudquotas.v1beta.CloudQuotas.CreateQuotaPreference", + "service": { + "fullName": "google.api.cloudquotas.v1beta.CloudQuotas", + "shortName": "CloudQuotas" + }, + "shortName": "CreateQuotaPreference" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.cloudquotas_v1beta.types.CreateQuotaPreferenceRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "quota_preference", + "type": "google.cloud.cloudquotas_v1beta.types.QuotaPreference" + }, + { + "name": "quota_preference_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.cloudquotas_v1beta.types.QuotaPreference", + "shortName": "create_quota_preference" + }, + "description": "Sample for CreateQuotaPreference", + "file": "cloudquotas_v1beta_generated_cloud_quotas_create_quota_preference_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudquotas_v1beta_generated_CloudQuotas_CreateQuotaPreference_async", + "segments": [ + { + "end": 57, + "start": 27, + "type": "FULL" + }, + { + "end": 57, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 51, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 54, + "start": 52, + "type": "REQUEST_EXECUTION" + }, + { + "end": 58, + "start": 55, + "type": "RESPONSE_HANDLING" + } + ], + "title": "cloudquotas_v1beta_generated_cloud_quotas_create_quota_preference_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.cloudquotas_v1beta.CloudQuotasClient", + "shortName": "CloudQuotasClient" + }, + "fullName": "google.cloud.cloudquotas_v1beta.CloudQuotasClient.create_quota_preference", + "method": { + "fullName": "google.api.cloudquotas.v1beta.CloudQuotas.CreateQuotaPreference", + "service": { + "fullName": "google.api.cloudquotas.v1beta.CloudQuotas", + "shortName": "CloudQuotas" + }, + "shortName": "CreateQuotaPreference" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.cloudquotas_v1beta.types.CreateQuotaPreferenceRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "quota_preference", + "type": "google.cloud.cloudquotas_v1beta.types.QuotaPreference" + }, + { + "name": "quota_preference_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.cloudquotas_v1beta.types.QuotaPreference", + "shortName": "create_quota_preference" + }, + "description": "Sample for CreateQuotaPreference", + "file": "cloudquotas_v1beta_generated_cloud_quotas_create_quota_preference_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudquotas_v1beta_generated_CloudQuotas_CreateQuotaPreference_sync", + "segments": [ + { + "end": 57, + "start": 27, + "type": "FULL" + }, + { + "end": 57, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 51, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 54, + "start": 52, + "type": "REQUEST_EXECUTION" + }, + { + "end": 58, + "start": 55, + "type": "RESPONSE_HANDLING" + } + ], + "title": "cloudquotas_v1beta_generated_cloud_quotas_create_quota_preference_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.cloudquotas_v1beta.CloudQuotasAsyncClient", + "shortName": "CloudQuotasAsyncClient" + }, + "fullName": "google.cloud.cloudquotas_v1beta.CloudQuotasAsyncClient.get_quota_info", + "method": { + "fullName": "google.api.cloudquotas.v1beta.CloudQuotas.GetQuotaInfo", + "service": { + "fullName": "google.api.cloudquotas.v1beta.CloudQuotas", + "shortName": "CloudQuotas" + }, + "shortName": "GetQuotaInfo" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.cloudquotas_v1beta.types.GetQuotaInfoRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.cloudquotas_v1beta.types.QuotaInfo", + "shortName": "get_quota_info" + }, + "description": "Sample for GetQuotaInfo", + "file": "cloudquotas_v1beta_generated_cloud_quotas_get_quota_info_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudquotas_v1beta_generated_CloudQuotas_GetQuotaInfo_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "cloudquotas_v1beta_generated_cloud_quotas_get_quota_info_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.cloudquotas_v1beta.CloudQuotasClient", + "shortName": "CloudQuotasClient" + }, + "fullName": "google.cloud.cloudquotas_v1beta.CloudQuotasClient.get_quota_info", + "method": { + "fullName": "google.api.cloudquotas.v1beta.CloudQuotas.GetQuotaInfo", + "service": { + "fullName": "google.api.cloudquotas.v1beta.CloudQuotas", + "shortName": "CloudQuotas" + }, + "shortName": "GetQuotaInfo" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.cloudquotas_v1beta.types.GetQuotaInfoRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.cloudquotas_v1beta.types.QuotaInfo", + "shortName": "get_quota_info" + }, + "description": "Sample for GetQuotaInfo", + "file": "cloudquotas_v1beta_generated_cloud_quotas_get_quota_info_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudquotas_v1beta_generated_CloudQuotas_GetQuotaInfo_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "cloudquotas_v1beta_generated_cloud_quotas_get_quota_info_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.cloudquotas_v1beta.CloudQuotasAsyncClient", + "shortName": "CloudQuotasAsyncClient" + }, + "fullName": "google.cloud.cloudquotas_v1beta.CloudQuotasAsyncClient.get_quota_preference", + "method": { + "fullName": "google.api.cloudquotas.v1beta.CloudQuotas.GetQuotaPreference", + "service": { + "fullName": "google.api.cloudquotas.v1beta.CloudQuotas", + "shortName": "CloudQuotas" + }, + "shortName": "GetQuotaPreference" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.cloudquotas_v1beta.types.GetQuotaPreferenceRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.cloudquotas_v1beta.types.QuotaPreference", + "shortName": "get_quota_preference" + }, + "description": "Sample for GetQuotaPreference", + "file": "cloudquotas_v1beta_generated_cloud_quotas_get_quota_preference_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudquotas_v1beta_generated_CloudQuotas_GetQuotaPreference_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "cloudquotas_v1beta_generated_cloud_quotas_get_quota_preference_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.cloudquotas_v1beta.CloudQuotasClient", + "shortName": "CloudQuotasClient" + }, + "fullName": "google.cloud.cloudquotas_v1beta.CloudQuotasClient.get_quota_preference", + "method": { + "fullName": "google.api.cloudquotas.v1beta.CloudQuotas.GetQuotaPreference", + "service": { + "fullName": "google.api.cloudquotas.v1beta.CloudQuotas", + "shortName": "CloudQuotas" + }, + "shortName": "GetQuotaPreference" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.cloudquotas_v1beta.types.GetQuotaPreferenceRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.cloudquotas_v1beta.types.QuotaPreference", + "shortName": "get_quota_preference" + }, + "description": "Sample for GetQuotaPreference", + "file": "cloudquotas_v1beta_generated_cloud_quotas_get_quota_preference_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudquotas_v1beta_generated_CloudQuotas_GetQuotaPreference_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "cloudquotas_v1beta_generated_cloud_quotas_get_quota_preference_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.cloudquotas_v1beta.CloudQuotasAsyncClient", + "shortName": "CloudQuotasAsyncClient" + }, + "fullName": "google.cloud.cloudquotas_v1beta.CloudQuotasAsyncClient.list_quota_infos", + "method": { + "fullName": "google.api.cloudquotas.v1beta.CloudQuotas.ListQuotaInfos", + "service": { + "fullName": "google.api.cloudquotas.v1beta.CloudQuotas", + "shortName": "CloudQuotas" + }, + "shortName": "ListQuotaInfos" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.cloudquotas_v1beta.types.ListQuotaInfosRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.cloudquotas_v1beta.services.cloud_quotas.pagers.ListQuotaInfosAsyncPager", + "shortName": "list_quota_infos" + }, + "description": "Sample for ListQuotaInfos", + "file": "cloudquotas_v1beta_generated_cloud_quotas_list_quota_infos_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudquotas_v1beta_generated_CloudQuotas_ListQuotaInfos_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "cloudquotas_v1beta_generated_cloud_quotas_list_quota_infos_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.cloudquotas_v1beta.CloudQuotasClient", + "shortName": "CloudQuotasClient" + }, + "fullName": "google.cloud.cloudquotas_v1beta.CloudQuotasClient.list_quota_infos", + "method": { + "fullName": "google.api.cloudquotas.v1beta.CloudQuotas.ListQuotaInfos", + "service": { + "fullName": "google.api.cloudquotas.v1beta.CloudQuotas", + "shortName": "CloudQuotas" + }, + "shortName": "ListQuotaInfos" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.cloudquotas_v1beta.types.ListQuotaInfosRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.cloudquotas_v1beta.services.cloud_quotas.pagers.ListQuotaInfosPager", + "shortName": "list_quota_infos" + }, + "description": "Sample for ListQuotaInfos", + "file": "cloudquotas_v1beta_generated_cloud_quotas_list_quota_infos_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudquotas_v1beta_generated_CloudQuotas_ListQuotaInfos_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "cloudquotas_v1beta_generated_cloud_quotas_list_quota_infos_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.cloudquotas_v1beta.CloudQuotasAsyncClient", + "shortName": "CloudQuotasAsyncClient" + }, + "fullName": "google.cloud.cloudquotas_v1beta.CloudQuotasAsyncClient.list_quota_preferences", + "method": { + "fullName": "google.api.cloudquotas.v1beta.CloudQuotas.ListQuotaPreferences", + "service": { + "fullName": "google.api.cloudquotas.v1beta.CloudQuotas", + "shortName": "CloudQuotas" + }, + "shortName": "ListQuotaPreferences" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.cloudquotas_v1beta.types.ListQuotaPreferencesRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.cloudquotas_v1beta.services.cloud_quotas.pagers.ListQuotaPreferencesAsyncPager", + "shortName": "list_quota_preferences" + }, + "description": "Sample for ListQuotaPreferences", + "file": "cloudquotas_v1beta_generated_cloud_quotas_list_quota_preferences_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudquotas_v1beta_generated_CloudQuotas_ListQuotaPreferences_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "cloudquotas_v1beta_generated_cloud_quotas_list_quota_preferences_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.cloudquotas_v1beta.CloudQuotasClient", + "shortName": "CloudQuotasClient" + }, + "fullName": "google.cloud.cloudquotas_v1beta.CloudQuotasClient.list_quota_preferences", + "method": { + "fullName": "google.api.cloudquotas.v1beta.CloudQuotas.ListQuotaPreferences", + "service": { + "fullName": "google.api.cloudquotas.v1beta.CloudQuotas", + "shortName": "CloudQuotas" + }, + "shortName": "ListQuotaPreferences" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.cloudquotas_v1beta.types.ListQuotaPreferencesRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.cloudquotas_v1beta.services.cloud_quotas.pagers.ListQuotaPreferencesPager", + "shortName": "list_quota_preferences" + }, + "description": "Sample for ListQuotaPreferences", + "file": "cloudquotas_v1beta_generated_cloud_quotas_list_quota_preferences_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudquotas_v1beta_generated_CloudQuotas_ListQuotaPreferences_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "cloudquotas_v1beta_generated_cloud_quotas_list_quota_preferences_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.cloudquotas_v1beta.CloudQuotasAsyncClient", + "shortName": "CloudQuotasAsyncClient" + }, + "fullName": "google.cloud.cloudquotas_v1beta.CloudQuotasAsyncClient.update_quota_preference", + "method": { + "fullName": "google.api.cloudquotas.v1beta.CloudQuotas.UpdateQuotaPreference", + "service": { + "fullName": "google.api.cloudquotas.v1beta.CloudQuotas", + "shortName": "CloudQuotas" + }, + "shortName": "UpdateQuotaPreference" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.cloudquotas_v1beta.types.UpdateQuotaPreferenceRequest" + }, + { + "name": "quota_preference", + "type": "google.cloud.cloudquotas_v1beta.types.QuotaPreference" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.cloudquotas_v1beta.types.QuotaPreference", + "shortName": "update_quota_preference" + }, + "description": "Sample for UpdateQuotaPreference", + "file": "cloudquotas_v1beta_generated_cloud_quotas_update_quota_preference_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudquotas_v1beta_generated_CloudQuotas_UpdateQuotaPreference_async", + "segments": [ + { + "end": 56, + "start": 27, + "type": "FULL" + }, + { + "end": 56, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 50, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 53, + "start": 51, + "type": "REQUEST_EXECUTION" + }, + { + "end": 57, + "start": 54, + "type": "RESPONSE_HANDLING" + } + ], + "title": "cloudquotas_v1beta_generated_cloud_quotas_update_quota_preference_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.cloudquotas_v1beta.CloudQuotasClient", + "shortName": "CloudQuotasClient" + }, + "fullName": "google.cloud.cloudquotas_v1beta.CloudQuotasClient.update_quota_preference", + "method": { + "fullName": "google.api.cloudquotas.v1beta.CloudQuotas.UpdateQuotaPreference", + "service": { + "fullName": "google.api.cloudquotas.v1beta.CloudQuotas", + "shortName": "CloudQuotas" + }, + "shortName": "UpdateQuotaPreference" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.cloudquotas_v1beta.types.UpdateQuotaPreferenceRequest" + }, + { + "name": "quota_preference", + "type": "google.cloud.cloudquotas_v1beta.types.QuotaPreference" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.cloudquotas_v1beta.types.QuotaPreference", + "shortName": "update_quota_preference" + }, + "description": "Sample for UpdateQuotaPreference", + "file": "cloudquotas_v1beta_generated_cloud_quotas_update_quota_preference_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudquotas_v1beta_generated_CloudQuotas_UpdateQuotaPreference_sync", + "segments": [ + { + "end": 56, + "start": 27, + "type": "FULL" + }, + { + "end": 56, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 50, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 53, + "start": 51, + "type": "REQUEST_EXECUTION" + }, + { + "end": 57, + "start": 54, + "type": "RESPONSE_HANDLING" + } + ], + "title": "cloudquotas_v1beta_generated_cloud_quotas_update_quota_preference_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.cloudquotas_v1beta.QuotaAdjusterSettingsManagerAsyncClient", + "shortName": "QuotaAdjusterSettingsManagerAsyncClient" + }, + "fullName": "google.cloud.cloudquotas_v1beta.QuotaAdjusterSettingsManagerAsyncClient.get_quota_adjuster_settings", + "method": { + "fullName": "google.api.cloudquotas.v1beta.QuotaAdjusterSettingsManager.GetQuotaAdjusterSettings", + "service": { + "fullName": "google.api.cloudquotas.v1beta.QuotaAdjusterSettingsManager", + "shortName": "QuotaAdjusterSettingsManager" + }, + "shortName": "GetQuotaAdjusterSettings" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.cloudquotas_v1beta.types.GetQuotaAdjusterSettingsRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.cloudquotas_v1beta.types.QuotaAdjusterSettings", + "shortName": "get_quota_adjuster_settings" + }, + "description": "Sample for GetQuotaAdjusterSettings", + "file": "cloudquotas_v1beta_generated_quota_adjuster_settings_manager_get_quota_adjuster_settings_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudquotas_v1beta_generated_QuotaAdjusterSettingsManager_GetQuotaAdjusterSettings_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "cloudquotas_v1beta_generated_quota_adjuster_settings_manager_get_quota_adjuster_settings_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.cloudquotas_v1beta.QuotaAdjusterSettingsManagerClient", + "shortName": "QuotaAdjusterSettingsManagerClient" + }, + "fullName": "google.cloud.cloudquotas_v1beta.QuotaAdjusterSettingsManagerClient.get_quota_adjuster_settings", + "method": { + "fullName": "google.api.cloudquotas.v1beta.QuotaAdjusterSettingsManager.GetQuotaAdjusterSettings", + "service": { + "fullName": "google.api.cloudquotas.v1beta.QuotaAdjusterSettingsManager", + "shortName": "QuotaAdjusterSettingsManager" + }, + "shortName": "GetQuotaAdjusterSettings" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.cloudquotas_v1beta.types.GetQuotaAdjusterSettingsRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.cloudquotas_v1beta.types.QuotaAdjusterSettings", + "shortName": "get_quota_adjuster_settings" + }, + "description": "Sample for GetQuotaAdjusterSettings", + "file": "cloudquotas_v1beta_generated_quota_adjuster_settings_manager_get_quota_adjuster_settings_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudquotas_v1beta_generated_QuotaAdjusterSettingsManager_GetQuotaAdjusterSettings_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "cloudquotas_v1beta_generated_quota_adjuster_settings_manager_get_quota_adjuster_settings_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.cloudquotas_v1beta.QuotaAdjusterSettingsManagerAsyncClient", + "shortName": "QuotaAdjusterSettingsManagerAsyncClient" + }, + "fullName": "google.cloud.cloudquotas_v1beta.QuotaAdjusterSettingsManagerAsyncClient.update_quota_adjuster_settings", + "method": { + "fullName": "google.api.cloudquotas.v1beta.QuotaAdjusterSettingsManager.UpdateQuotaAdjusterSettings", + "service": { + "fullName": "google.api.cloudquotas.v1beta.QuotaAdjusterSettingsManager", + "shortName": "QuotaAdjusterSettingsManager" + }, + "shortName": "UpdateQuotaAdjusterSettings" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.cloudquotas_v1beta.types.UpdateQuotaAdjusterSettingsRequest" + }, + { + "name": "quota_adjuster_settings", + "type": "google.cloud.cloudquotas_v1beta.types.QuotaAdjusterSettings" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.cloudquotas_v1beta.types.QuotaAdjusterSettings", + "shortName": "update_quota_adjuster_settings" + }, + "description": "Sample for UpdateQuotaAdjusterSettings", + "file": "cloudquotas_v1beta_generated_quota_adjuster_settings_manager_update_quota_adjuster_settings_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudquotas_v1beta_generated_QuotaAdjusterSettingsManager_UpdateQuotaAdjusterSettings_async", + "segments": [ + { + "end": 54, + "start": 27, + "type": "FULL" + }, + { + "end": 54, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 48, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 51, + "start": 49, + "type": "REQUEST_EXECUTION" + }, + { + "end": 55, + "start": 52, + "type": "RESPONSE_HANDLING" + } + ], + "title": "cloudquotas_v1beta_generated_quota_adjuster_settings_manager_update_quota_adjuster_settings_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.cloudquotas_v1beta.QuotaAdjusterSettingsManagerClient", + "shortName": "QuotaAdjusterSettingsManagerClient" + }, + "fullName": "google.cloud.cloudquotas_v1beta.QuotaAdjusterSettingsManagerClient.update_quota_adjuster_settings", + "method": { + "fullName": "google.api.cloudquotas.v1beta.QuotaAdjusterSettingsManager.UpdateQuotaAdjusterSettings", + "service": { + "fullName": "google.api.cloudquotas.v1beta.QuotaAdjusterSettingsManager", + "shortName": "QuotaAdjusterSettingsManager" + }, + "shortName": "UpdateQuotaAdjusterSettings" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.cloudquotas_v1beta.types.UpdateQuotaAdjusterSettingsRequest" + }, + { + "name": "quota_adjuster_settings", + "type": "google.cloud.cloudquotas_v1beta.types.QuotaAdjusterSettings" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.cloud.cloudquotas_v1beta.types.QuotaAdjusterSettings", + "shortName": "update_quota_adjuster_settings" + }, + "description": "Sample for UpdateQuotaAdjusterSettings", + "file": "cloudquotas_v1beta_generated_quota_adjuster_settings_manager_update_quota_adjuster_settings_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudquotas_v1beta_generated_QuotaAdjusterSettingsManager_UpdateQuotaAdjusterSettings_sync", + "segments": [ + { + "end": 54, + "start": 27, + "type": "FULL" + }, + { + "end": 54, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 48, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 51, + "start": 49, + "type": "REQUEST_EXECUTION" + }, + { + "end": 55, + "start": 52, + "type": "RESPONSE_HANDLING" + } + ], + "title": "cloudquotas_v1beta_generated_quota_adjuster_settings_manager_update_quota_adjuster_settings_sync.py" + } + ] +} diff --git a/packages/google-cloud-quotas/scripts/fixup_cloudquotas_v1beta_keywords.py b/packages/google-cloud-quotas/scripts/fixup_cloudquotas_v1beta_keywords.py new file mode 100644 index 000000000000..abb24bdc36be --- /dev/null +++ b/packages/google-cloud-quotas/scripts/fixup_cloudquotas_v1beta_keywords.py @@ -0,0 +1,183 @@ +#! /usr/bin/env python3 +# -*- coding: utf-8 -*- +# 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. +# 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 argparse +import os +import libcst as cst +import pathlib +import sys +from typing import (Any, Callable, Dict, List, Sequence, Tuple) + + +def partition( + predicate: Callable[[Any], bool], + iterator: Sequence[Any] +) -> Tuple[List[Any], List[Any]]: + """A stable, out-of-place partition.""" + results = ([], []) + + for i in iterator: + results[int(predicate(i))].append(i) + + # Returns trueList, falseList + return results[1], results[0] + + +class cloudquotasCallTransformer(cst.CSTTransformer): + CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') + METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { + 'create_quota_preference': ('parent', 'quota_preference', 'quota_preference_id', 'ignore_safety_checks', ), + 'get_quota_adjuster_settings': ('name', ), + 'get_quota_info': ('name', ), + 'get_quota_preference': ('name', ), + 'list_quota_infos': ('parent', 'page_size', 'page_token', ), + 'list_quota_preferences': ('parent', 'page_size', 'page_token', 'filter', 'order_by', ), + 'update_quota_adjuster_settings': ('quota_adjuster_settings', 'update_mask', 'validate_only', ), + 'update_quota_preference': ('quota_preference', 'update_mask', 'allow_missing', 'validate_only', 'ignore_safety_checks', ), + } + + def leave_Call(self, original: cst.Call, updated: cst.Call) -> cst.CSTNode: + try: + key = original.func.attr.value + kword_params = self.METHOD_TO_PARAMS[key] + except (AttributeError, KeyError): + # Either not a method from the API or too convoluted to be sure. + return updated + + # If the existing code is valid, keyword args come after positional args. + # Therefore, all positional args must map to the first parameters. + args, kwargs = partition(lambda a: not bool(a.keyword), updated.args) + if any(k.keyword.value == "request" for k in kwargs): + # We've already fixed this file, don't fix it again. + return updated + + kwargs, ctrl_kwargs = partition( + lambda a: a.keyword.value not in self.CTRL_PARAMS, + kwargs + ) + + args, ctrl_args = args[:len(kword_params)], args[len(kword_params):] + ctrl_kwargs.extend(cst.Arg(value=a.value, keyword=cst.Name(value=ctrl)) + for a, ctrl in zip(ctrl_args, self.CTRL_PARAMS)) + + request_arg = cst.Arg( + value=cst.Dict([ + cst.DictElement( + cst.SimpleString("'{}'".format(name)), +cst.Element(value=arg.value) + ) + # Note: the args + kwargs looks silly, but keep in mind that + # the control parameters had to be stripped out, and that + # those could have been passed positionally or by keyword. + for name, arg in zip(kword_params, args + kwargs)]), + keyword=cst.Name("request") + ) + + return updated.with_changes( + args=[request_arg] + ctrl_kwargs + ) + + +def fix_files( + in_dir: pathlib.Path, + out_dir: pathlib.Path, + *, + transformer=cloudquotasCallTransformer(), +): + """Duplicate the input dir to the output dir, fixing file method calls. + + Preconditions: + * in_dir is a real directory + * out_dir is a real, empty directory + """ + pyfile_gen = ( + pathlib.Path(os.path.join(root, f)) + for root, _, files in os.walk(in_dir) + for f in files if os.path.splitext(f)[1] == ".py" + ) + + for fpath in pyfile_gen: + with open(fpath, 'r') as f: + src = f.read() + + # Parse the code and insert method call fixes. + tree = cst.parse_module(src) + updated = tree.visit(transformer) + + # Create the path and directory structure for the new file. + updated_path = out_dir.joinpath(fpath.relative_to(in_dir)) + updated_path.parent.mkdir(parents=True, exist_ok=True) + + # Generate the updated source file at the corresponding path. + with open(updated_path, 'w') as f: + f.write(updated.code) + + +if __name__ == '__main__': + parser = argparse.ArgumentParser( + description="""Fix up source that uses the cloudquotas client library. + +The existing sources are NOT overwritten but are copied to output_dir with changes made. + +Note: This tool operates at a best-effort level at converting positional + parameters in client method calls to keyword based parameters. + Cases where it WILL FAIL include + A) * or ** expansion in a method call. + B) Calls via function or method alias (includes free function calls) + C) Indirect or dispatched calls (e.g. the method is looked up dynamically) + + These all constitute false negatives. The tool will also detect false + positives when an API method shares a name with another method. +""") + parser.add_argument( + '-d', + '--input-directory', + required=True, + dest='input_dir', + help='the input directory to walk for python files to fix up', + ) + parser.add_argument( + '-o', + '--output-directory', + required=True, + dest='output_dir', + help='the directory to output files fixed via un-flattening', + ) + args = parser.parse_args() + input_dir = pathlib.Path(args.input_dir) + output_dir = pathlib.Path(args.output_dir) + if not input_dir.is_dir(): + print( + f"input directory '{input_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if not output_dir.is_dir(): + print( + f"output directory '{output_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if os.listdir(output_dir): + print( + f"output directory '{output_dir}' is not empty", + file=sys.stderr, + ) + sys.exit(-1) + + fix_files(input_dir, output_dir) diff --git a/packages/google-cloud-quotas/tests/unit/gapic/cloudquotas_v1beta/__init__.py b/packages/google-cloud-quotas/tests/unit/gapic/cloudquotas_v1beta/__init__.py new file mode 100644 index 000000000000..8f6cf068242c --- /dev/null +++ b/packages/google-cloud-quotas/tests/unit/gapic/cloudquotas_v1beta/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# 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. +# 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. +# diff --git a/packages/google-cloud-quotas/tests/unit/gapic/cloudquotas_v1beta/test_cloud_quotas.py b/packages/google-cloud-quotas/tests/unit/gapic/cloudquotas_v1beta/test_cloud_quotas.py new file mode 100644 index 000000000000..a88f3ba5bbf6 --- /dev/null +++ b/packages/google-cloud-quotas/tests/unit/gapic/cloudquotas_v1beta/test_cloud_quotas.py @@ -0,0 +1,7195 @@ +# -*- coding: utf-8 -*- +# 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. +# 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 os + +# try/except added for compatibility with python < 3.8 +try: + from unittest import mock + from unittest.mock import AsyncMock # pragma: NO COVER +except ImportError: # pragma: NO COVER + import mock + +from collections.abc import AsyncIterable, Iterable +import json +import math + +from google.api_core import api_core_version +from google.protobuf import json_format +import grpc +from grpc.experimental import aio +from proto.marshal.rules import wrappers +from proto.marshal.rules.dates import DurationRule, TimestampRule +import pytest +from requests import PreparedRequest, Request, Response +from requests.sessions import Session + +try: + from google.auth.aio import credentials as ga_credentials_async + + HAS_GOOGLE_AUTH_AIO = True +except ImportError: # pragma: NO COVER + HAS_GOOGLE_AUTH_AIO = False + +from google.api_core import gapic_v1, grpc_helpers, grpc_helpers_async, path_template +from google.api_core import client_options +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +import google.auth +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.oauth2 import service_account +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from google.protobuf import wrappers_pb2 # type: ignore + +from google.cloud.cloudquotas_v1beta.services.cloud_quotas import ( + CloudQuotasAsyncClient, + CloudQuotasClient, + pagers, + transports, +) +from google.cloud.cloudquotas_v1beta.types import cloudquotas, resources + + +async def mock_async_gen(data, chunk_size=1): + for i in range(0, len(data)): # pragma: NO COVER + chunk = data[i : i + chunk_size] + yield chunk.encode("utf-8") + + +def client_cert_source_callback(): + return b"cert bytes", b"key bytes" + + +# TODO: use async auth anon credentials by default once the minimum version of google-auth is upgraded. +# See related issue: https://github.com/googleapis/gapic-generator-python/issues/2107. +def async_anonymous_credentials(): + if HAS_GOOGLE_AUTH_AIO: + return ga_credentials_async.AnonymousCredentials() + return ga_credentials.AnonymousCredentials() + + +# If default endpoint is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint(client): + return ( + "foo.googleapis.com" + if ("localhost" in client.DEFAULT_ENDPOINT) + else client.DEFAULT_ENDPOINT + ) + + +# If default endpoint template is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint template so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint_template(client): + return ( + "test.{UNIVERSE_DOMAIN}" + if ("localhost" in client._DEFAULT_ENDPOINT_TEMPLATE) + else client._DEFAULT_ENDPOINT_TEMPLATE + ) + + +def test__get_default_mtls_endpoint(): + api_endpoint = "example.googleapis.com" + api_mtls_endpoint = "example.mtls.googleapis.com" + sandbox_endpoint = "example.sandbox.googleapis.com" + sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" + non_googleapi = "api.example.com" + + assert CloudQuotasClient._get_default_mtls_endpoint(None) is None + assert ( + CloudQuotasClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint + ) + assert ( + CloudQuotasClient._get_default_mtls_endpoint(api_mtls_endpoint) + == api_mtls_endpoint + ) + assert ( + CloudQuotasClient._get_default_mtls_endpoint(sandbox_endpoint) + == sandbox_mtls_endpoint + ) + assert ( + CloudQuotasClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) + == sandbox_mtls_endpoint + ) + assert CloudQuotasClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi + + +def test__read_environment_variables(): + assert CloudQuotasClient._read_environment_variables() == (False, "auto", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + assert CloudQuotasClient._read_environment_variables() == (True, "auto", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): + assert CloudQuotasClient._read_environment_variables() == (False, "auto", None) + + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"} + ): + with pytest.raises(ValueError) as excinfo: + CloudQuotasClient._read_environment_variables() + assert ( + str(excinfo.value) + == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + ) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + assert CloudQuotasClient._read_environment_variables() == (False, "never", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + assert CloudQuotasClient._read_environment_variables() == ( + False, + "always", + None, + ) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}): + assert CloudQuotasClient._read_environment_variables() == (False, "auto", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError) as excinfo: + CloudQuotasClient._read_environment_variables() + assert ( + str(excinfo.value) + == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + ) + + with mock.patch.dict(os.environ, {"GOOGLE_CLOUD_UNIVERSE_DOMAIN": "foo.com"}): + assert CloudQuotasClient._read_environment_variables() == ( + False, + "auto", + "foo.com", + ) + + +def test__get_client_cert_source(): + mock_provided_cert_source = mock.Mock() + mock_default_cert_source = mock.Mock() + + assert CloudQuotasClient._get_client_cert_source(None, False) is None + assert ( + CloudQuotasClient._get_client_cert_source(mock_provided_cert_source, False) + is None + ) + assert ( + CloudQuotasClient._get_client_cert_source(mock_provided_cert_source, True) + == mock_provided_cert_source + ) + + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", return_value=True + ): + with mock.patch( + "google.auth.transport.mtls.default_client_cert_source", + return_value=mock_default_cert_source, + ): + assert ( + CloudQuotasClient._get_client_cert_source(None, True) + is mock_default_cert_source + ) + assert ( + CloudQuotasClient._get_client_cert_source( + mock_provided_cert_source, "true" + ) + is mock_provided_cert_source + ) + + +@mock.patch.object( + CloudQuotasClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(CloudQuotasClient), +) +@mock.patch.object( + CloudQuotasAsyncClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(CloudQuotasAsyncClient), +) +def test__get_api_endpoint(): + api_override = "foo.com" + mock_client_cert_source = mock.Mock() + default_universe = CloudQuotasClient._DEFAULT_UNIVERSE + default_endpoint = CloudQuotasClient._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=default_universe + ) + mock_universe = "bar.com" + mock_endpoint = CloudQuotasClient._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=mock_universe + ) + + assert ( + CloudQuotasClient._get_api_endpoint( + api_override, mock_client_cert_source, default_universe, "always" + ) + == api_override + ) + assert ( + CloudQuotasClient._get_api_endpoint( + None, mock_client_cert_source, default_universe, "auto" + ) + == CloudQuotasClient.DEFAULT_MTLS_ENDPOINT + ) + assert ( + CloudQuotasClient._get_api_endpoint(None, None, default_universe, "auto") + == default_endpoint + ) + assert ( + CloudQuotasClient._get_api_endpoint(None, None, default_universe, "always") + == CloudQuotasClient.DEFAULT_MTLS_ENDPOINT + ) + assert ( + CloudQuotasClient._get_api_endpoint( + None, mock_client_cert_source, default_universe, "always" + ) + == CloudQuotasClient.DEFAULT_MTLS_ENDPOINT + ) + assert ( + CloudQuotasClient._get_api_endpoint(None, None, mock_universe, "never") + == mock_endpoint + ) + assert ( + CloudQuotasClient._get_api_endpoint(None, None, default_universe, "never") + == default_endpoint + ) + + with pytest.raises(MutualTLSChannelError) as excinfo: + CloudQuotasClient._get_api_endpoint( + None, mock_client_cert_source, mock_universe, "auto" + ) + assert ( + str(excinfo.value) + == "mTLS is not supported in any universe other than googleapis.com." + ) + + +def test__get_universe_domain(): + client_universe_domain = "foo.com" + universe_domain_env = "bar.com" + + assert ( + CloudQuotasClient._get_universe_domain( + client_universe_domain, universe_domain_env + ) + == client_universe_domain + ) + assert ( + CloudQuotasClient._get_universe_domain(None, universe_domain_env) + == universe_domain_env + ) + assert ( + CloudQuotasClient._get_universe_domain(None, None) + == CloudQuotasClient._DEFAULT_UNIVERSE + ) + + with pytest.raises(ValueError) as excinfo: + CloudQuotasClient._get_universe_domain("", None) + assert str(excinfo.value) == "Universe Domain cannot be an empty string." + + +@pytest.mark.parametrize( + "client_class,transport_name", + [ + (CloudQuotasClient, "grpc"), + (CloudQuotasAsyncClient, "grpc_asyncio"), + (CloudQuotasClient, "rest"), + ], +) +def test_cloud_quotas_client_from_service_account_info(client_class, transport_name): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object( + service_account.Credentials, "from_service_account_info" + ) as factory: + factory.return_value = creds + info = {"valid": True} + client = client_class.from_service_account_info(info, transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + "cloudquotas.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://cloudquotas.googleapis.com" + ) + + +@pytest.mark.parametrize( + "transport_class,transport_name", + [ + (transports.CloudQuotasGrpcTransport, "grpc"), + (transports.CloudQuotasGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.CloudQuotasRestTransport, "rest"), + ], +) +def test_cloud_quotas_client_service_account_always_use_jwt( + transport_class, transport_name +): + with mock.patch.object( + service_account.Credentials, "with_always_use_jwt_access", create=True + ) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=True) + use_jwt.assert_called_once_with(True) + + with mock.patch.object( + service_account.Credentials, "with_always_use_jwt_access", create=True + ) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=False) + use_jwt.assert_not_called() + + +@pytest.mark.parametrize( + "client_class,transport_name", + [ + (CloudQuotasClient, "grpc"), + (CloudQuotasAsyncClient, "grpc_asyncio"), + (CloudQuotasClient, "rest"), + ], +) +def test_cloud_quotas_client_from_service_account_file(client_class, transport_name): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object( + service_account.Credentials, "from_service_account_file" + ) as factory: + factory.return_value = creds + client = client_class.from_service_account_file( + "dummy/file/path.json", transport=transport_name + ) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json( + "dummy/file/path.json", transport=transport_name + ) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + "cloudquotas.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://cloudquotas.googleapis.com" + ) + + +def test_cloud_quotas_client_get_transport_class(): + transport = CloudQuotasClient.get_transport_class() + available_transports = [ + transports.CloudQuotasGrpcTransport, + transports.CloudQuotasRestTransport, + ] + assert transport in available_transports + + transport = CloudQuotasClient.get_transport_class("grpc") + assert transport == transports.CloudQuotasGrpcTransport + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name", + [ + (CloudQuotasClient, transports.CloudQuotasGrpcTransport, "grpc"), + ( + CloudQuotasAsyncClient, + transports.CloudQuotasGrpcAsyncIOTransport, + "grpc_asyncio", + ), + (CloudQuotasClient, transports.CloudQuotasRestTransport, "rest"), + ], +) +@mock.patch.object( + CloudQuotasClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(CloudQuotasClient), +) +@mock.patch.object( + CloudQuotasAsyncClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(CloudQuotasAsyncClient), +) +def test_cloud_quotas_client_client_options( + client_class, transport_class, transport_name +): + # Check that if channel is provided we won't create a new one. + with mock.patch.object(CloudQuotasClient, "get_transport_class") as gtc: + transport = transport_class(credentials=ga_credentials.AnonymousCredentials()) + client = client_class(transport=transport) + gtc.assert_not_called() + + # Check that if channel is provided via str we will create a new one. + with mock.patch.object(CloudQuotasClient, "get_transport_class") as gtc: + client = client_class(transport=transport_name) + gtc.assert_called() + + # Check the case api_endpoint is provided. + options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(transport=transport_name, client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_MTLS_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError) as excinfo: + client = client_class(transport=transport_name) + assert ( + str(excinfo.value) + == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + ) + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"} + ): + with pytest.raises(ValueError) as excinfo: + client = client_class(transport=transport_name) + assert ( + str(excinfo.value) + == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + ) + + # Check the case quota_project_id is provided + options = client_options.ClientOptions(quota_project_id="octopus") + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id="octopus", + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + # Check the case api_endpoint is provided + options = client_options.ClientOptions( + api_audience="https://language.googleapis.com" + ) + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience="https://language.googleapis.com", + ) + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name,use_client_cert_env", + [ + (CloudQuotasClient, transports.CloudQuotasGrpcTransport, "grpc", "true"), + ( + CloudQuotasAsyncClient, + transports.CloudQuotasGrpcAsyncIOTransport, + "grpc_asyncio", + "true", + ), + (CloudQuotasClient, transports.CloudQuotasGrpcTransport, "grpc", "false"), + ( + CloudQuotasAsyncClient, + transports.CloudQuotasGrpcAsyncIOTransport, + "grpc_asyncio", + "false", + ), + (CloudQuotasClient, transports.CloudQuotasRestTransport, "rest", "true"), + (CloudQuotasClient, transports.CloudQuotasRestTransport, "rest", "false"), + ], +) +@mock.patch.object( + CloudQuotasClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(CloudQuotasClient), +) +@mock.patch.object( + CloudQuotasAsyncClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(CloudQuotasAsyncClient), +) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_cloud_quotas_client_mtls_env_auto( + client_class, transport_class, transport_name, use_client_cert_env +): + # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default + # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. + + # Check the case client_cert_source is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env} + ): + options = client_options.ClientOptions( + client_cert_source=client_cert_source_callback + ) + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + + if use_client_cert_env == "false": + expected_client_cert_source = None + expected_host = client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ) + else: + expected_client_cert_source = client_cert_source_callback + expected_host = client.DEFAULT_MTLS_ENDPOINT + + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case ADC client cert is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env} + ): + with mock.patch.object(transport_class, "__init__") as patched: + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", + return_value=True, + ): + with mock.patch( + "google.auth.transport.mtls.default_client_cert_source", + return_value=client_cert_source_callback, + ): + if use_client_cert_env == "false": + expected_host = client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ) + expected_client_cert_source = None + else: + expected_host = client.DEFAULT_MTLS_ENDPOINT + expected_client_cert_source = client_cert_source_callback + + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case client_cert_source and ADC client cert are not provided. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env} + ): + with mock.patch.object(transport_class, "__init__") as patched: + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", + return_value=False, + ): + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize("client_class", [CloudQuotasClient, CloudQuotasAsyncClient]) +@mock.patch.object( + CloudQuotasClient, "DEFAULT_ENDPOINT", modify_default_endpoint(CloudQuotasClient) +) +@mock.patch.object( + CloudQuotasAsyncClient, + "DEFAULT_ENDPOINT", + modify_default_endpoint(CloudQuotasAsyncClient), +) +def test_cloud_quotas_client_get_mtls_endpoint_and_cert_source(client_class): + mock_client_cert_source = mock.Mock() + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "true". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + mock_api_endpoint = "foo" + options = client_options.ClientOptions( + client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint + ) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source( + options + ) + assert api_endpoint == mock_api_endpoint + assert cert_source == mock_client_cert_source + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "false". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): + mock_client_cert_source = mock.Mock() + mock_api_endpoint = "foo" + options = client_options.ClientOptions( + client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint + ) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source( + options + ) + assert api_endpoint == mock_api_endpoint + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert doesn't exist. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", + return_value=False, + ): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert exists. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", + return_value=True, + ): + with mock.patch( + "google.auth.transport.mtls.default_client_cert_source", + return_value=mock_client_cert_source, + ): + ( + api_endpoint, + cert_source, + ) = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source == mock_client_cert_source + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError) as excinfo: + client_class.get_mtls_endpoint_and_cert_source() + + assert ( + str(excinfo.value) + == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + ) + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"} + ): + with pytest.raises(ValueError) as excinfo: + client_class.get_mtls_endpoint_and_cert_source() + + assert ( + str(excinfo.value) + == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + ) + + +@pytest.mark.parametrize("client_class", [CloudQuotasClient, CloudQuotasAsyncClient]) +@mock.patch.object( + CloudQuotasClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(CloudQuotasClient), +) +@mock.patch.object( + CloudQuotasAsyncClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(CloudQuotasAsyncClient), +) +def test_cloud_quotas_client_client_api_endpoint(client_class): + mock_client_cert_source = client_cert_source_callback + api_override = "foo.com" + default_universe = CloudQuotasClient._DEFAULT_UNIVERSE + default_endpoint = CloudQuotasClient._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=default_universe + ) + mock_universe = "bar.com" + mock_endpoint = CloudQuotasClient._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=mock_universe + ) + + # If ClientOptions.api_endpoint is set and GOOGLE_API_USE_CLIENT_CERTIFICATE="true", + # use ClientOptions.api_endpoint as the api endpoint regardless. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch( + "google.auth.transport.requests.AuthorizedSession.configure_mtls_channel" + ): + options = client_options.ClientOptions( + client_cert_source=mock_client_cert_source, api_endpoint=api_override + ) + client = client_class( + client_options=options, + credentials=ga_credentials.AnonymousCredentials(), + ) + assert client.api_endpoint == api_override + + # If ClientOptions.api_endpoint is not set and GOOGLE_API_USE_MTLS_ENDPOINT="never", + # use the _DEFAULT_ENDPOINT_TEMPLATE populated with GDU as the api endpoint. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + client = client_class(credentials=ga_credentials.AnonymousCredentials()) + assert client.api_endpoint == default_endpoint + + # If ClientOptions.api_endpoint is not set and GOOGLE_API_USE_MTLS_ENDPOINT="always", + # use the DEFAULT_MTLS_ENDPOINT as the api endpoint. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + client = client_class(credentials=ga_credentials.AnonymousCredentials()) + assert client.api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + + # If ClientOptions.api_endpoint is not set, GOOGLE_API_USE_MTLS_ENDPOINT="auto" (default), + # GOOGLE_API_USE_CLIENT_CERTIFICATE="false" (default), default cert source doesn't exist, + # and ClientOptions.universe_domain="bar.com", + # use the _DEFAULT_ENDPOINT_TEMPLATE populated with universe domain as the api endpoint. + options = client_options.ClientOptions() + universe_exists = hasattr(options, "universe_domain") + if universe_exists: + options = client_options.ClientOptions(universe_domain=mock_universe) + client = client_class( + client_options=options, credentials=ga_credentials.AnonymousCredentials() + ) + else: + client = client_class( + client_options=options, credentials=ga_credentials.AnonymousCredentials() + ) + assert client.api_endpoint == ( + mock_endpoint if universe_exists else default_endpoint + ) + assert client.universe_domain == ( + mock_universe if universe_exists else default_universe + ) + + # If ClientOptions does not have a universe domain attribute and GOOGLE_API_USE_MTLS_ENDPOINT="never", + # use the _DEFAULT_ENDPOINT_TEMPLATE populated with GDU as the api endpoint. + options = client_options.ClientOptions() + if hasattr(options, "universe_domain"): + delattr(options, "universe_domain") + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + client = client_class( + client_options=options, credentials=ga_credentials.AnonymousCredentials() + ) + assert client.api_endpoint == default_endpoint + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name", + [ + (CloudQuotasClient, transports.CloudQuotasGrpcTransport, "grpc"), + ( + CloudQuotasAsyncClient, + transports.CloudQuotasGrpcAsyncIOTransport, + "grpc_asyncio", + ), + (CloudQuotasClient, transports.CloudQuotasRestTransport, "rest"), + ], +) +def test_cloud_quotas_client_client_options_scopes( + client_class, transport_class, transport_name +): + # Check the case scopes are provided. + options = client_options.ClientOptions( + scopes=["1", "2"], + ) + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=["1", "2"], + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name,grpc_helpers", + [ + (CloudQuotasClient, transports.CloudQuotasGrpcTransport, "grpc", grpc_helpers), + ( + CloudQuotasAsyncClient, + transports.CloudQuotasGrpcAsyncIOTransport, + "grpc_asyncio", + grpc_helpers_async, + ), + (CloudQuotasClient, transports.CloudQuotasRestTransport, "rest", None), + ], +) +def test_cloud_quotas_client_client_options_credentials_file( + client_class, transport_class, transport_name, grpc_helpers +): + # Check the case credentials file is provided. + options = client_options.ClientOptions(credentials_file="credentials.json") + + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +def test_cloud_quotas_client_client_options_from_dict(): + with mock.patch( + "google.cloud.cloudquotas_v1beta.services.cloud_quotas.transports.CloudQuotasGrpcTransport.__init__" + ) as grpc_transport: + grpc_transport.return_value = None + client = CloudQuotasClient(client_options={"api_endpoint": "squid.clam.whelk"}) + grpc_transport.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name,grpc_helpers", + [ + (CloudQuotasClient, transports.CloudQuotasGrpcTransport, "grpc", grpc_helpers), + ( + CloudQuotasAsyncClient, + transports.CloudQuotasGrpcAsyncIOTransport, + "grpc_asyncio", + grpc_helpers_async, + ), + ], +) +def test_cloud_quotas_client_create_channel_credentials_file( + client_class, transport_class, transport_name, grpc_helpers +): + # Check the case credentials file is provided. + options = client_options.ClientOptions(credentials_file="credentials.json") + + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # test that the credentials from file are saved and used as the credentials. + with mock.patch.object( + google.auth, "load_credentials_from_file", autospec=True + ) as load_creds, mock.patch.object( + google.auth, "default", autospec=True + ) as adc, mock.patch.object( + grpc_helpers, "create_channel" + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + file_creds = ga_credentials.AnonymousCredentials() + load_creds.return_value = (file_creds, None) + adc.return_value = (creds, None) + client = client_class(client_options=options, transport=transport_name) + create_channel.assert_called_with( + "cloudquotas.googleapis.com:443", + credentials=file_creds, + credentials_file=None, + quota_project_id=None, + default_scopes=("https://www.googleapis.com/auth/cloud-platform",), + scopes=None, + default_host="cloudquotas.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize( + "request_type", + [ + cloudquotas.ListQuotaInfosRequest, + dict, + ], +) +def test_list_quota_infos(request_type, transport: str = "grpc"): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_quota_infos), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = cloudquotas.ListQuotaInfosResponse( + next_page_token="next_page_token_value", + ) + response = client.list_quota_infos(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = cloudquotas.ListQuotaInfosRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListQuotaInfosPager) + assert response.next_page_token == "next_page_token_value" + + +def test_list_quota_infos_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = cloudquotas.ListQuotaInfosRequest( + parent="parent_value", + page_token="page_token_value", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_quota_infos), "__call__") as call: + call.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client.list_quota_infos(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloudquotas.ListQuotaInfosRequest( + parent="parent_value", + page_token="page_token_value", + ) + + +def test_list_quota_infos_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.list_quota_infos in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[ + client._transport.list_quota_infos + ] = mock_rpc + request = {} + client.list_quota_infos(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.list_quota_infos(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +@pytest.mark.asyncio +async def test_list_quota_infos_async_use_cached_wrapped_rpc( + transport: str = "grpc_asyncio", +): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._client._transport.list_quota_infos + in client._client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[ + client._client._transport.list_quota_infos + ] = mock_rpc + + request = {} + await client.list_quota_infos(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.list_quota_infos(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +@pytest.mark.asyncio +async def test_list_quota_infos_async( + transport: str = "grpc_asyncio", request_type=cloudquotas.ListQuotaInfosRequest +): + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_quota_infos), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + cloudquotas.ListQuotaInfosResponse( + next_page_token="next_page_token_value", + ) + ) + response = await client.list_quota_infos(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = cloudquotas.ListQuotaInfosRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListQuotaInfosAsyncPager) + assert response.next_page_token == "next_page_token_value" + + +@pytest.mark.asyncio +async def test_list_quota_infos_async_from_dict(): + await test_list_quota_infos_async(request_type=dict) + + +def test_list_quota_infos_field_headers(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloudquotas.ListQuotaInfosRequest() + + request.parent = "parent_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_quota_infos), "__call__") as call: + call.return_value = cloudquotas.ListQuotaInfosResponse() + client.list_quota_infos(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "parent=parent_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_list_quota_infos_field_headers_async(): + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloudquotas.ListQuotaInfosRequest() + + request.parent = "parent_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_quota_infos), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + cloudquotas.ListQuotaInfosResponse() + ) + await client.list_quota_infos(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "parent=parent_value", + ) in kw["metadata"] + + +def test_list_quota_infos_flattened(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_quota_infos), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = cloudquotas.ListQuotaInfosResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_quota_infos( + parent="parent_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = "parent_value" + assert arg == mock_val + + +def test_list_quota_infos_flattened_error(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_quota_infos( + cloudquotas.ListQuotaInfosRequest(), + parent="parent_value", + ) + + +@pytest.mark.asyncio +async def test_list_quota_infos_flattened_async(): + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_quota_infos), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = cloudquotas.ListQuotaInfosResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + cloudquotas.ListQuotaInfosResponse() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_quota_infos( + parent="parent_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = "parent_value" + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_list_quota_infos_flattened_error_async(): + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_quota_infos( + cloudquotas.ListQuotaInfosRequest(), + parent="parent_value", + ) + + +def test_list_quota_infos_pager(transport_name: str = "grpc"): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_quota_infos), "__call__") as call: + # Set the response to a series of pages. + call.side_effect = ( + cloudquotas.ListQuotaInfosResponse( + quota_infos=[ + resources.QuotaInfo(), + resources.QuotaInfo(), + resources.QuotaInfo(), + ], + next_page_token="abc", + ), + cloudquotas.ListQuotaInfosResponse( + quota_infos=[], + next_page_token="def", + ), + cloudquotas.ListQuotaInfosResponse( + quota_infos=[ + resources.QuotaInfo(), + ], + next_page_token="ghi", + ), + cloudquotas.ListQuotaInfosResponse( + quota_infos=[ + resources.QuotaInfo(), + resources.QuotaInfo(), + ], + ), + RuntimeError, + ) + + expected_metadata = () + retry = retries.Retry() + timeout = 5 + expected_metadata = tuple(expected_metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", ""),)), + ) + pager = client.list_quota_infos(request={}, retry=retry, timeout=timeout) + + assert pager._metadata == expected_metadata + assert pager._retry == retry + assert pager._timeout == timeout + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, resources.QuotaInfo) for i in results) + + +def test_list_quota_infos_pages(transport_name: str = "grpc"): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_quota_infos), "__call__") as call: + # Set the response to a series of pages. + call.side_effect = ( + cloudquotas.ListQuotaInfosResponse( + quota_infos=[ + resources.QuotaInfo(), + resources.QuotaInfo(), + resources.QuotaInfo(), + ], + next_page_token="abc", + ), + cloudquotas.ListQuotaInfosResponse( + quota_infos=[], + next_page_token="def", + ), + cloudquotas.ListQuotaInfosResponse( + quota_infos=[ + resources.QuotaInfo(), + ], + next_page_token="ghi", + ), + cloudquotas.ListQuotaInfosResponse( + quota_infos=[ + resources.QuotaInfo(), + resources.QuotaInfo(), + ], + ), + RuntimeError, + ) + pages = list(client.list_quota_infos(request={}).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.asyncio +async def test_list_quota_infos_async_pager(): + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_quota_infos), "__call__", new_callable=mock.AsyncMock + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloudquotas.ListQuotaInfosResponse( + quota_infos=[ + resources.QuotaInfo(), + resources.QuotaInfo(), + resources.QuotaInfo(), + ], + next_page_token="abc", + ), + cloudquotas.ListQuotaInfosResponse( + quota_infos=[], + next_page_token="def", + ), + cloudquotas.ListQuotaInfosResponse( + quota_infos=[ + resources.QuotaInfo(), + ], + next_page_token="ghi", + ), + cloudquotas.ListQuotaInfosResponse( + quota_infos=[ + resources.QuotaInfo(), + resources.QuotaInfo(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_quota_infos( + request={}, + ) + assert async_pager.next_page_token == "abc" + responses = [] + async for response in async_pager: # pragma: no branch + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, resources.QuotaInfo) for i in responses) + + +@pytest.mark.asyncio +async def test_list_quota_infos_async_pages(): + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_quota_infos), "__call__", new_callable=mock.AsyncMock + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloudquotas.ListQuotaInfosResponse( + quota_infos=[ + resources.QuotaInfo(), + resources.QuotaInfo(), + resources.QuotaInfo(), + ], + next_page_token="abc", + ), + cloudquotas.ListQuotaInfosResponse( + quota_infos=[], + next_page_token="def", + ), + cloudquotas.ListQuotaInfosResponse( + quota_infos=[ + resources.QuotaInfo(), + ], + next_page_token="ghi", + ), + cloudquotas.ListQuotaInfosResponse( + quota_infos=[ + resources.QuotaInfo(), + resources.QuotaInfo(), + ], + ), + RuntimeError, + ) + pages = [] + # Workaround issue in python 3.9 related to code coverage by adding `# pragma: no branch` + # See https://github.com/googleapis/gapic-generator-python/pull/1174#issuecomment-1025132372 + async for page_ in ( # pragma: no branch + await client.list_quota_infos(request={}) + ).pages: + pages.append(page_) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize( + "request_type", + [ + cloudquotas.GetQuotaInfoRequest, + dict, + ], +) +def test_get_quota_info(request_type, transport: str = "grpc"): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_quota_info), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = resources.QuotaInfo( + name="name_value", + quota_id="quota_id_value", + metric="metric_value", + service="service_value", + is_precise=True, + refresh_interval="refresh_interval_value", + container_type=resources.QuotaInfo.ContainerType.PROJECT, + dimensions=["dimensions_value"], + metric_display_name="metric_display_name_value", + quota_display_name="quota_display_name_value", + metric_unit="metric_unit_value", + is_fixed=True, + is_concurrent=True, + service_request_quota_uri="service_request_quota_uri_value", + ) + response = client.get_quota_info(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = cloudquotas.GetQuotaInfoRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, resources.QuotaInfo) + assert response.name == "name_value" + assert response.quota_id == "quota_id_value" + assert response.metric == "metric_value" + assert response.service == "service_value" + assert response.is_precise is True + assert response.refresh_interval == "refresh_interval_value" + assert response.container_type == resources.QuotaInfo.ContainerType.PROJECT + assert response.dimensions == ["dimensions_value"] + assert response.metric_display_name == "metric_display_name_value" + assert response.quota_display_name == "quota_display_name_value" + assert response.metric_unit == "metric_unit_value" + assert response.is_fixed is True + assert response.is_concurrent is True + assert response.service_request_quota_uri == "service_request_quota_uri_value" + + +def test_get_quota_info_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = cloudquotas.GetQuotaInfoRequest( + name="name_value", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_quota_info), "__call__") as call: + call.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client.get_quota_info(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloudquotas.GetQuotaInfoRequest( + name="name_value", + ) + + +def test_get_quota_info_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.get_quota_info in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[client._transport.get_quota_info] = mock_rpc + request = {} + client.get_quota_info(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.get_quota_info(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +@pytest.mark.asyncio +async def test_get_quota_info_async_use_cached_wrapped_rpc( + transport: str = "grpc_asyncio", +): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._client._transport.get_quota_info + in client._client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[ + client._client._transport.get_quota_info + ] = mock_rpc + + request = {} + await client.get_quota_info(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.get_quota_info(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +@pytest.mark.asyncio +async def test_get_quota_info_async( + transport: str = "grpc_asyncio", request_type=cloudquotas.GetQuotaInfoRequest +): + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_quota_info), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + resources.QuotaInfo( + name="name_value", + quota_id="quota_id_value", + metric="metric_value", + service="service_value", + is_precise=True, + refresh_interval="refresh_interval_value", + container_type=resources.QuotaInfo.ContainerType.PROJECT, + dimensions=["dimensions_value"], + metric_display_name="metric_display_name_value", + quota_display_name="quota_display_name_value", + metric_unit="metric_unit_value", + is_fixed=True, + is_concurrent=True, + service_request_quota_uri="service_request_quota_uri_value", + ) + ) + response = await client.get_quota_info(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = cloudquotas.GetQuotaInfoRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, resources.QuotaInfo) + assert response.name == "name_value" + assert response.quota_id == "quota_id_value" + assert response.metric == "metric_value" + assert response.service == "service_value" + assert response.is_precise is True + assert response.refresh_interval == "refresh_interval_value" + assert response.container_type == resources.QuotaInfo.ContainerType.PROJECT + assert response.dimensions == ["dimensions_value"] + assert response.metric_display_name == "metric_display_name_value" + assert response.quota_display_name == "quota_display_name_value" + assert response.metric_unit == "metric_unit_value" + assert response.is_fixed is True + assert response.is_concurrent is True + assert response.service_request_quota_uri == "service_request_quota_uri_value" + + +@pytest.mark.asyncio +async def test_get_quota_info_async_from_dict(): + await test_get_quota_info_async(request_type=dict) + + +def test_get_quota_info_field_headers(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloudquotas.GetQuotaInfoRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_quota_info), "__call__") as call: + call.return_value = resources.QuotaInfo() + client.get_quota_info(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_get_quota_info_field_headers_async(): + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloudquotas.GetQuotaInfoRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_quota_info), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resources.QuotaInfo()) + await client.get_quota_info(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name_value", + ) in kw["metadata"] + + +def test_get_quota_info_flattened(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_quota_info), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = resources.QuotaInfo() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_quota_info( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +def test_get_quota_info_flattened_error(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_quota_info( + cloudquotas.GetQuotaInfoRequest(), + name="name_value", + ) + + +@pytest.mark.asyncio +async def test_get_quota_info_flattened_async(): + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_quota_info), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = resources.QuotaInfo() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resources.QuotaInfo()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_quota_info( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_get_quota_info_flattened_error_async(): + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_quota_info( + cloudquotas.GetQuotaInfoRequest(), + name="name_value", + ) + + +@pytest.mark.parametrize( + "request_type", + [ + cloudquotas.ListQuotaPreferencesRequest, + dict, + ], +) +def test_list_quota_preferences(request_type, transport: str = "grpc"): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_quota_preferences), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = cloudquotas.ListQuotaPreferencesResponse( + next_page_token="next_page_token_value", + unreachable=["unreachable_value"], + ) + response = client.list_quota_preferences(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = cloudquotas.ListQuotaPreferencesRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListQuotaPreferencesPager) + assert response.next_page_token == "next_page_token_value" + assert response.unreachable == ["unreachable_value"] + + +def test_list_quota_preferences_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = cloudquotas.ListQuotaPreferencesRequest( + parent="parent_value", + page_token="page_token_value", + filter="filter_value", + order_by="order_by_value", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_quota_preferences), "__call__" + ) as call: + call.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client.list_quota_preferences(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloudquotas.ListQuotaPreferencesRequest( + parent="parent_value", + page_token="page_token_value", + filter="filter_value", + order_by="order_by_value", + ) + + +def test_list_quota_preferences_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._transport.list_quota_preferences + in client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[ + client._transport.list_quota_preferences + ] = mock_rpc + request = {} + client.list_quota_preferences(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.list_quota_preferences(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +@pytest.mark.asyncio +async def test_list_quota_preferences_async_use_cached_wrapped_rpc( + transport: str = "grpc_asyncio", +): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._client._transport.list_quota_preferences + in client._client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[ + client._client._transport.list_quota_preferences + ] = mock_rpc + + request = {} + await client.list_quota_preferences(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.list_quota_preferences(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +@pytest.mark.asyncio +async def test_list_quota_preferences_async( + transport: str = "grpc_asyncio", + request_type=cloudquotas.ListQuotaPreferencesRequest, +): + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_quota_preferences), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + cloudquotas.ListQuotaPreferencesResponse( + next_page_token="next_page_token_value", + unreachable=["unreachable_value"], + ) + ) + response = await client.list_quota_preferences(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = cloudquotas.ListQuotaPreferencesRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListQuotaPreferencesAsyncPager) + assert response.next_page_token == "next_page_token_value" + assert response.unreachable == ["unreachable_value"] + + +@pytest.mark.asyncio +async def test_list_quota_preferences_async_from_dict(): + await test_list_quota_preferences_async(request_type=dict) + + +def test_list_quota_preferences_field_headers(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloudquotas.ListQuotaPreferencesRequest() + + request.parent = "parent_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_quota_preferences), "__call__" + ) as call: + call.return_value = cloudquotas.ListQuotaPreferencesResponse() + client.list_quota_preferences(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "parent=parent_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_list_quota_preferences_field_headers_async(): + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloudquotas.ListQuotaPreferencesRequest() + + request.parent = "parent_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_quota_preferences), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + cloudquotas.ListQuotaPreferencesResponse() + ) + await client.list_quota_preferences(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "parent=parent_value", + ) in kw["metadata"] + + +def test_list_quota_preferences_flattened(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_quota_preferences), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = cloudquotas.ListQuotaPreferencesResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_quota_preferences( + parent="parent_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = "parent_value" + assert arg == mock_val + + +def test_list_quota_preferences_flattened_error(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_quota_preferences( + cloudquotas.ListQuotaPreferencesRequest(), + parent="parent_value", + ) + + +@pytest.mark.asyncio +async def test_list_quota_preferences_flattened_async(): + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_quota_preferences), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = cloudquotas.ListQuotaPreferencesResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + cloudquotas.ListQuotaPreferencesResponse() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_quota_preferences( + parent="parent_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = "parent_value" + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_list_quota_preferences_flattened_error_async(): + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_quota_preferences( + cloudquotas.ListQuotaPreferencesRequest(), + parent="parent_value", + ) + + +def test_list_quota_preferences_pager(transport_name: str = "grpc"): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_quota_preferences), "__call__" + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloudquotas.ListQuotaPreferencesResponse( + quota_preferences=[ + resources.QuotaPreference(), + resources.QuotaPreference(), + resources.QuotaPreference(), + ], + next_page_token="abc", + ), + cloudquotas.ListQuotaPreferencesResponse( + quota_preferences=[], + next_page_token="def", + ), + cloudquotas.ListQuotaPreferencesResponse( + quota_preferences=[ + resources.QuotaPreference(), + ], + next_page_token="ghi", + ), + cloudquotas.ListQuotaPreferencesResponse( + quota_preferences=[ + resources.QuotaPreference(), + resources.QuotaPreference(), + ], + ), + RuntimeError, + ) + + expected_metadata = () + retry = retries.Retry() + timeout = 5 + expected_metadata = tuple(expected_metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", ""),)), + ) + pager = client.list_quota_preferences(request={}, retry=retry, timeout=timeout) + + assert pager._metadata == expected_metadata + assert pager._retry == retry + assert pager._timeout == timeout + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, resources.QuotaPreference) for i in results) + + +def test_list_quota_preferences_pages(transport_name: str = "grpc"): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_quota_preferences), "__call__" + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloudquotas.ListQuotaPreferencesResponse( + quota_preferences=[ + resources.QuotaPreference(), + resources.QuotaPreference(), + resources.QuotaPreference(), + ], + next_page_token="abc", + ), + cloudquotas.ListQuotaPreferencesResponse( + quota_preferences=[], + next_page_token="def", + ), + cloudquotas.ListQuotaPreferencesResponse( + quota_preferences=[ + resources.QuotaPreference(), + ], + next_page_token="ghi", + ), + cloudquotas.ListQuotaPreferencesResponse( + quota_preferences=[ + resources.QuotaPreference(), + resources.QuotaPreference(), + ], + ), + RuntimeError, + ) + pages = list(client.list_quota_preferences(request={}).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.asyncio +async def test_list_quota_preferences_async_pager(): + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_quota_preferences), + "__call__", + new_callable=mock.AsyncMock, + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloudquotas.ListQuotaPreferencesResponse( + quota_preferences=[ + resources.QuotaPreference(), + resources.QuotaPreference(), + resources.QuotaPreference(), + ], + next_page_token="abc", + ), + cloudquotas.ListQuotaPreferencesResponse( + quota_preferences=[], + next_page_token="def", + ), + cloudquotas.ListQuotaPreferencesResponse( + quota_preferences=[ + resources.QuotaPreference(), + ], + next_page_token="ghi", + ), + cloudquotas.ListQuotaPreferencesResponse( + quota_preferences=[ + resources.QuotaPreference(), + resources.QuotaPreference(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_quota_preferences( + request={}, + ) + assert async_pager.next_page_token == "abc" + responses = [] + async for response in async_pager: # pragma: no branch + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, resources.QuotaPreference) for i in responses) + + +@pytest.mark.asyncio +async def test_list_quota_preferences_async_pages(): + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_quota_preferences), + "__call__", + new_callable=mock.AsyncMock, + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloudquotas.ListQuotaPreferencesResponse( + quota_preferences=[ + resources.QuotaPreference(), + resources.QuotaPreference(), + resources.QuotaPreference(), + ], + next_page_token="abc", + ), + cloudquotas.ListQuotaPreferencesResponse( + quota_preferences=[], + next_page_token="def", + ), + cloudquotas.ListQuotaPreferencesResponse( + quota_preferences=[ + resources.QuotaPreference(), + ], + next_page_token="ghi", + ), + cloudquotas.ListQuotaPreferencesResponse( + quota_preferences=[ + resources.QuotaPreference(), + resources.QuotaPreference(), + ], + ), + RuntimeError, + ) + pages = [] + # Workaround issue in python 3.9 related to code coverage by adding `# pragma: no branch` + # See https://github.com/googleapis/gapic-generator-python/pull/1174#issuecomment-1025132372 + async for page_ in ( # pragma: no branch + await client.list_quota_preferences(request={}) + ).pages: + pages.append(page_) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize( + "request_type", + [ + cloudquotas.GetQuotaPreferenceRequest, + dict, + ], +) +def test_get_quota_preference(request_type, transport: str = "grpc"): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_quota_preference), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = resources.QuotaPreference( + name="name_value", + etag="etag_value", + service="service_value", + quota_id="quota_id_value", + reconciling=True, + justification="justification_value", + contact_email="contact_email_value", + ) + response = client.get_quota_preference(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = cloudquotas.GetQuotaPreferenceRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, resources.QuotaPreference) + assert response.name == "name_value" + assert response.etag == "etag_value" + assert response.service == "service_value" + assert response.quota_id == "quota_id_value" + assert response.reconciling is True + assert response.justification == "justification_value" + assert response.contact_email == "contact_email_value" + + +def test_get_quota_preference_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = cloudquotas.GetQuotaPreferenceRequest( + name="name_value", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_quota_preference), "__call__" + ) as call: + call.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client.get_quota_preference(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloudquotas.GetQuotaPreferenceRequest( + name="name_value", + ) + + +def test_get_quota_preference_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._transport.get_quota_preference in client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[ + client._transport.get_quota_preference + ] = mock_rpc + request = {} + client.get_quota_preference(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.get_quota_preference(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +@pytest.mark.asyncio +async def test_get_quota_preference_async_use_cached_wrapped_rpc( + transport: str = "grpc_asyncio", +): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._client._transport.get_quota_preference + in client._client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[ + client._client._transport.get_quota_preference + ] = mock_rpc + + request = {} + await client.get_quota_preference(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.get_quota_preference(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +@pytest.mark.asyncio +async def test_get_quota_preference_async( + transport: str = "grpc_asyncio", request_type=cloudquotas.GetQuotaPreferenceRequest +): + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_quota_preference), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + resources.QuotaPreference( + name="name_value", + etag="etag_value", + service="service_value", + quota_id="quota_id_value", + reconciling=True, + justification="justification_value", + contact_email="contact_email_value", + ) + ) + response = await client.get_quota_preference(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = cloudquotas.GetQuotaPreferenceRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, resources.QuotaPreference) + assert response.name == "name_value" + assert response.etag == "etag_value" + assert response.service == "service_value" + assert response.quota_id == "quota_id_value" + assert response.reconciling is True + assert response.justification == "justification_value" + assert response.contact_email == "contact_email_value" + + +@pytest.mark.asyncio +async def test_get_quota_preference_async_from_dict(): + await test_get_quota_preference_async(request_type=dict) + + +def test_get_quota_preference_field_headers(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloudquotas.GetQuotaPreferenceRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_quota_preference), "__call__" + ) as call: + call.return_value = resources.QuotaPreference() + client.get_quota_preference(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_get_quota_preference_field_headers_async(): + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloudquotas.GetQuotaPreferenceRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_quota_preference), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + resources.QuotaPreference() + ) + await client.get_quota_preference(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name_value", + ) in kw["metadata"] + + +def test_get_quota_preference_flattened(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_quota_preference), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = resources.QuotaPreference() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_quota_preference( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +def test_get_quota_preference_flattened_error(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_quota_preference( + cloudquotas.GetQuotaPreferenceRequest(), + name="name_value", + ) + + +@pytest.mark.asyncio +async def test_get_quota_preference_flattened_async(): + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_quota_preference), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = resources.QuotaPreference() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + resources.QuotaPreference() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_quota_preference( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_get_quota_preference_flattened_error_async(): + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_quota_preference( + cloudquotas.GetQuotaPreferenceRequest(), + name="name_value", + ) + + +@pytest.mark.parametrize( + "request_type", + [ + cloudquotas.CreateQuotaPreferenceRequest, + dict, + ], +) +def test_create_quota_preference(request_type, transport: str = "grpc"): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_quota_preference), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = resources.QuotaPreference( + name="name_value", + etag="etag_value", + service="service_value", + quota_id="quota_id_value", + reconciling=True, + justification="justification_value", + contact_email="contact_email_value", + ) + response = client.create_quota_preference(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = cloudquotas.CreateQuotaPreferenceRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, resources.QuotaPreference) + assert response.name == "name_value" + assert response.etag == "etag_value" + assert response.service == "service_value" + assert response.quota_id == "quota_id_value" + assert response.reconciling is True + assert response.justification == "justification_value" + assert response.contact_email == "contact_email_value" + + +def test_create_quota_preference_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = cloudquotas.CreateQuotaPreferenceRequest( + parent="parent_value", + quota_preference_id="quota_preference_id_value", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_quota_preference), "__call__" + ) as call: + call.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client.create_quota_preference(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloudquotas.CreateQuotaPreferenceRequest( + parent="parent_value", + quota_preference_id="quota_preference_id_value", + ) + + +def test_create_quota_preference_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._transport.create_quota_preference + in client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[ + client._transport.create_quota_preference + ] = mock_rpc + request = {} + client.create_quota_preference(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.create_quota_preference(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +@pytest.mark.asyncio +async def test_create_quota_preference_async_use_cached_wrapped_rpc( + transport: str = "grpc_asyncio", +): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._client._transport.create_quota_preference + in client._client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[ + client._client._transport.create_quota_preference + ] = mock_rpc + + request = {} + await client.create_quota_preference(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.create_quota_preference(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +@pytest.mark.asyncio +async def test_create_quota_preference_async( + transport: str = "grpc_asyncio", + request_type=cloudquotas.CreateQuotaPreferenceRequest, +): + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_quota_preference), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + resources.QuotaPreference( + name="name_value", + etag="etag_value", + service="service_value", + quota_id="quota_id_value", + reconciling=True, + justification="justification_value", + contact_email="contact_email_value", + ) + ) + response = await client.create_quota_preference(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = cloudquotas.CreateQuotaPreferenceRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, resources.QuotaPreference) + assert response.name == "name_value" + assert response.etag == "etag_value" + assert response.service == "service_value" + assert response.quota_id == "quota_id_value" + assert response.reconciling is True + assert response.justification == "justification_value" + assert response.contact_email == "contact_email_value" + + +@pytest.mark.asyncio +async def test_create_quota_preference_async_from_dict(): + await test_create_quota_preference_async(request_type=dict) + + +def test_create_quota_preference_field_headers(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloudquotas.CreateQuotaPreferenceRequest() + + request.parent = "parent_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_quota_preference), "__call__" + ) as call: + call.return_value = resources.QuotaPreference() + client.create_quota_preference(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "parent=parent_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_create_quota_preference_field_headers_async(): + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloudquotas.CreateQuotaPreferenceRequest() + + request.parent = "parent_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_quota_preference), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + resources.QuotaPreference() + ) + await client.create_quota_preference(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "parent=parent_value", + ) in kw["metadata"] + + +def test_create_quota_preference_flattened(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_quota_preference), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = resources.QuotaPreference() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_quota_preference( + parent="parent_value", + quota_preference=resources.QuotaPreference(name="name_value"), + quota_preference_id="quota_preference_id_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = "parent_value" + assert arg == mock_val + arg = args[0].quota_preference + mock_val = resources.QuotaPreference(name="name_value") + assert arg == mock_val + arg = args[0].quota_preference_id + mock_val = "quota_preference_id_value" + assert arg == mock_val + + +def test_create_quota_preference_flattened_error(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_quota_preference( + cloudquotas.CreateQuotaPreferenceRequest(), + parent="parent_value", + quota_preference=resources.QuotaPreference(name="name_value"), + quota_preference_id="quota_preference_id_value", + ) + + +@pytest.mark.asyncio +async def test_create_quota_preference_flattened_async(): + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_quota_preference), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = resources.QuotaPreference() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + resources.QuotaPreference() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_quota_preference( + parent="parent_value", + quota_preference=resources.QuotaPreference(name="name_value"), + quota_preference_id="quota_preference_id_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = "parent_value" + assert arg == mock_val + arg = args[0].quota_preference + mock_val = resources.QuotaPreference(name="name_value") + assert arg == mock_val + arg = args[0].quota_preference_id + mock_val = "quota_preference_id_value" + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_create_quota_preference_flattened_error_async(): + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.create_quota_preference( + cloudquotas.CreateQuotaPreferenceRequest(), + parent="parent_value", + quota_preference=resources.QuotaPreference(name="name_value"), + quota_preference_id="quota_preference_id_value", + ) + + +@pytest.mark.parametrize( + "request_type", + [ + cloudquotas.UpdateQuotaPreferenceRequest, + dict, + ], +) +def test_update_quota_preference(request_type, transport: str = "grpc"): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_quota_preference), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = resources.QuotaPreference( + name="name_value", + etag="etag_value", + service="service_value", + quota_id="quota_id_value", + reconciling=True, + justification="justification_value", + contact_email="contact_email_value", + ) + response = client.update_quota_preference(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = cloudquotas.UpdateQuotaPreferenceRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, resources.QuotaPreference) + assert response.name == "name_value" + assert response.etag == "etag_value" + assert response.service == "service_value" + assert response.quota_id == "quota_id_value" + assert response.reconciling is True + assert response.justification == "justification_value" + assert response.contact_email == "contact_email_value" + + +def test_update_quota_preference_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = cloudquotas.UpdateQuotaPreferenceRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_quota_preference), "__call__" + ) as call: + call.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client.update_quota_preference(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloudquotas.UpdateQuotaPreferenceRequest() + + +def test_update_quota_preference_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._transport.update_quota_preference + in client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[ + client._transport.update_quota_preference + ] = mock_rpc + request = {} + client.update_quota_preference(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.update_quota_preference(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +@pytest.mark.asyncio +async def test_update_quota_preference_async_use_cached_wrapped_rpc( + transport: str = "grpc_asyncio", +): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._client._transport.update_quota_preference + in client._client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[ + client._client._transport.update_quota_preference + ] = mock_rpc + + request = {} + await client.update_quota_preference(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.update_quota_preference(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +@pytest.mark.asyncio +async def test_update_quota_preference_async( + transport: str = "grpc_asyncio", + request_type=cloudquotas.UpdateQuotaPreferenceRequest, +): + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_quota_preference), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + resources.QuotaPreference( + name="name_value", + etag="etag_value", + service="service_value", + quota_id="quota_id_value", + reconciling=True, + justification="justification_value", + contact_email="contact_email_value", + ) + ) + response = await client.update_quota_preference(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = cloudquotas.UpdateQuotaPreferenceRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, resources.QuotaPreference) + assert response.name == "name_value" + assert response.etag == "etag_value" + assert response.service == "service_value" + assert response.quota_id == "quota_id_value" + assert response.reconciling is True + assert response.justification == "justification_value" + assert response.contact_email == "contact_email_value" + + +@pytest.mark.asyncio +async def test_update_quota_preference_async_from_dict(): + await test_update_quota_preference_async(request_type=dict) + + +def test_update_quota_preference_field_headers(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloudquotas.UpdateQuotaPreferenceRequest() + + request.quota_preference.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_quota_preference), "__call__" + ) as call: + call.return_value = resources.QuotaPreference() + client.update_quota_preference(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "quota_preference.name=name_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_update_quota_preference_field_headers_async(): + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloudquotas.UpdateQuotaPreferenceRequest() + + request.quota_preference.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_quota_preference), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + resources.QuotaPreference() + ) + await client.update_quota_preference(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "quota_preference.name=name_value", + ) in kw["metadata"] + + +def test_update_quota_preference_flattened(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_quota_preference), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = resources.QuotaPreference() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_quota_preference( + quota_preference=resources.QuotaPreference(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].quota_preference + mock_val = resources.QuotaPreference(name="name_value") + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=["paths_value"]) + assert arg == mock_val + + +def test_update_quota_preference_flattened_error(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.update_quota_preference( + cloudquotas.UpdateQuotaPreferenceRequest(), + quota_preference=resources.QuotaPreference(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + +@pytest.mark.asyncio +async def test_update_quota_preference_flattened_async(): + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_quota_preference), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = resources.QuotaPreference() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + resources.QuotaPreference() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_quota_preference( + quota_preference=resources.QuotaPreference(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].quota_preference + mock_val = resources.QuotaPreference(name="name_value") + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=["paths_value"]) + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_update_quota_preference_flattened_error_async(): + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.update_quota_preference( + cloudquotas.UpdateQuotaPreferenceRequest(), + quota_preference=resources.QuotaPreference(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + +def test_list_quota_infos_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.list_quota_infos in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[ + client._transport.list_quota_infos + ] = mock_rpc + + request = {} + client.list_quota_infos(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.list_quota_infos(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_list_quota_infos_rest_required_fields( + request_type=cloudquotas.ListQuotaInfosRequest, +): + transport_class = transports.CloudQuotasRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson(pb_request, use_integers_for_enums=False) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_quota_infos._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = "parent_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_quota_infos._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "page_size", + "page_token", + ) + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = cloudquotas.ListQuotaInfosResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = cloudquotas.ListQuotaInfosResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.list_quota_infos(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_list_quota_infos_rest_unset_required_fields(): + transport = transports.CloudQuotasRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.list_quota_infos._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "pageSize", + "pageToken", + ) + ) + & set(("parent",)) + ) + + +def test_list_quota_infos_rest_flattened(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = cloudquotas.ListQuotaInfosResponse() + + # get arguments that satisfy an http rule for this method + sample_request = { + "parent": "projects/sample1/locations/sample2/services/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = cloudquotas.ListQuotaInfosResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.list_quota_infos(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1beta/{parent=projects/*/locations/*/services/*}/quotaInfos" + % client.transport._host, + args[1], + ) + + +def test_list_quota_infos_rest_flattened_error(transport: str = "rest"): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_quota_infos( + cloudquotas.ListQuotaInfosRequest(), + parent="parent_value", + ) + + +def test_list_quota_infos_rest_pager(transport: str = "rest"): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + # with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + cloudquotas.ListQuotaInfosResponse( + quota_infos=[ + resources.QuotaInfo(), + resources.QuotaInfo(), + resources.QuotaInfo(), + ], + next_page_token="abc", + ), + cloudquotas.ListQuotaInfosResponse( + quota_infos=[], + next_page_token="def", + ), + cloudquotas.ListQuotaInfosResponse( + quota_infos=[ + resources.QuotaInfo(), + ], + next_page_token="ghi", + ), + cloudquotas.ListQuotaInfosResponse( + quota_infos=[ + resources.QuotaInfo(), + resources.QuotaInfo(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple( + cloudquotas.ListQuotaInfosResponse.to_json(x) for x in response + ) + return_values = tuple(Response() for i in response) + for return_val, response_val in zip(return_values, response): + return_val._content = response_val.encode("UTF-8") + return_val.status_code = 200 + req.side_effect = return_values + + sample_request = { + "parent": "projects/sample1/locations/sample2/services/sample3" + } + + pager = client.list_quota_infos(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, resources.QuotaInfo) for i in results) + + pages = list(client.list_quota_infos(request=sample_request).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +def test_get_quota_info_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.get_quota_info in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[client._transport.get_quota_info] = mock_rpc + + request = {} + client.get_quota_info(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.get_quota_info(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_get_quota_info_rest_required_fields( + request_type=cloudquotas.GetQuotaInfoRequest, +): + transport_class = transports.CloudQuotasRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson(pb_request, use_integers_for_enums=False) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).get_quota_info._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).get_quota_info._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = resources.QuotaInfo() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = resources.QuotaInfo.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.get_quota_info(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_get_quota_info_rest_unset_required_fields(): + transport = transports.CloudQuotasRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.get_quota_info._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) + + +def test_get_quota_info_rest_flattened(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = resources.QuotaInfo() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/services/sample3/quotaInfos/sample4" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = resources.QuotaInfo.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.get_quota_info(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1beta/{name=projects/*/locations/*/services/*/quotaInfos/*}" + % client.transport._host, + args[1], + ) + + +def test_get_quota_info_rest_flattened_error(transport: str = "rest"): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_quota_info( + cloudquotas.GetQuotaInfoRequest(), + name="name_value", + ) + + +def test_list_quota_preferences_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._transport.list_quota_preferences + in client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[ + client._transport.list_quota_preferences + ] = mock_rpc + + request = {} + client.list_quota_preferences(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.list_quota_preferences(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_list_quota_preferences_rest_required_fields( + request_type=cloudquotas.ListQuotaPreferencesRequest, +): + transport_class = transports.CloudQuotasRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson(pb_request, use_integers_for_enums=False) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_quota_preferences._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = "parent_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_quota_preferences._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "filter", + "order_by", + "page_size", + "page_token", + ) + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = cloudquotas.ListQuotaPreferencesResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = cloudquotas.ListQuotaPreferencesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.list_quota_preferences(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_list_quota_preferences_rest_unset_required_fields(): + transport = transports.CloudQuotasRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.list_quota_preferences._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "filter", + "orderBy", + "pageSize", + "pageToken", + ) + ) + & set(("parent",)) + ) + + +def test_list_quota_preferences_rest_flattened(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = cloudquotas.ListQuotaPreferencesResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {"parent": "projects/sample1/locations/sample2"} + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = cloudquotas.ListQuotaPreferencesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.list_quota_preferences(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1beta/{parent=projects/*/locations/*}/quotaPreferences" + % client.transport._host, + args[1], + ) + + +def test_list_quota_preferences_rest_flattened_error(transport: str = "rest"): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_quota_preferences( + cloudquotas.ListQuotaPreferencesRequest(), + parent="parent_value", + ) + + +def test_list_quota_preferences_rest_pager(transport: str = "rest"): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + # with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + cloudquotas.ListQuotaPreferencesResponse( + quota_preferences=[ + resources.QuotaPreference(), + resources.QuotaPreference(), + resources.QuotaPreference(), + ], + next_page_token="abc", + ), + cloudquotas.ListQuotaPreferencesResponse( + quota_preferences=[], + next_page_token="def", + ), + cloudquotas.ListQuotaPreferencesResponse( + quota_preferences=[ + resources.QuotaPreference(), + ], + next_page_token="ghi", + ), + cloudquotas.ListQuotaPreferencesResponse( + quota_preferences=[ + resources.QuotaPreference(), + resources.QuotaPreference(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple( + cloudquotas.ListQuotaPreferencesResponse.to_json(x) for x in response + ) + return_values = tuple(Response() for i in response) + for return_val, response_val in zip(return_values, response): + return_val._content = response_val.encode("UTF-8") + return_val.status_code = 200 + req.side_effect = return_values + + sample_request = {"parent": "projects/sample1/locations/sample2"} + + pager = client.list_quota_preferences(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, resources.QuotaPreference) for i in results) + + pages = list(client.list_quota_preferences(request=sample_request).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +def test_get_quota_preference_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._transport.get_quota_preference in client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[ + client._transport.get_quota_preference + ] = mock_rpc + + request = {} + client.get_quota_preference(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.get_quota_preference(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_get_quota_preference_rest_required_fields( + request_type=cloudquotas.GetQuotaPreferenceRequest, +): + transport_class = transports.CloudQuotasRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson(pb_request, use_integers_for_enums=False) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).get_quota_preference._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).get_quota_preference._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = resources.QuotaPreference() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = resources.QuotaPreference.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.get_quota_preference(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_get_quota_preference_rest_unset_required_fields(): + transport = transports.CloudQuotasRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.get_quota_preference._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) + + +def test_get_quota_preference_rest_flattened(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = resources.QuotaPreference() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/quotaPreferences/sample3" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = resources.QuotaPreference.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.get_quota_preference(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1beta/{name=projects/*/locations/*/quotaPreferences/*}" + % client.transport._host, + args[1], + ) + + +def test_get_quota_preference_rest_flattened_error(transport: str = "rest"): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_quota_preference( + cloudquotas.GetQuotaPreferenceRequest(), + name="name_value", + ) + + +def test_create_quota_preference_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._transport.create_quota_preference + in client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[ + client._transport.create_quota_preference + ] = mock_rpc + + request = {} + client.create_quota_preference(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.create_quota_preference(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_create_quota_preference_rest_required_fields( + request_type=cloudquotas.CreateQuotaPreferenceRequest, +): + transport_class = transports.CloudQuotasRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson(pb_request, use_integers_for_enums=False) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).create_quota_preference._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = "parent_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).create_quota_preference._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "ignore_safety_checks", + "quota_preference_id", + ) + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = resources.QuotaPreference() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = resources.QuotaPreference.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.create_quota_preference(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_create_quota_preference_rest_unset_required_fields(): + transport = transports.CloudQuotasRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.create_quota_preference._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "ignoreSafetyChecks", + "quotaPreferenceId", + ) + ) + & set( + ( + "parent", + "quotaPreference", + ) + ) + ) + + +def test_create_quota_preference_rest_flattened(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = resources.QuotaPreference() + + # get arguments that satisfy an http rule for this method + sample_request = {"parent": "projects/sample1/locations/sample2"} + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + quota_preference=resources.QuotaPreference(name="name_value"), + quota_preference_id="quota_preference_id_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = resources.QuotaPreference.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.create_quota_preference(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1beta/{parent=projects/*/locations/*}/quotaPreferences" + % client.transport._host, + args[1], + ) + + +def test_create_quota_preference_rest_flattened_error(transport: str = "rest"): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_quota_preference( + cloudquotas.CreateQuotaPreferenceRequest(), + parent="parent_value", + quota_preference=resources.QuotaPreference(name="name_value"), + quota_preference_id="quota_preference_id_value", + ) + + +def test_update_quota_preference_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._transport.update_quota_preference + in client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[ + client._transport.update_quota_preference + ] = mock_rpc + + request = {} + client.update_quota_preference(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.update_quota_preference(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_update_quota_preference_rest_required_fields( + request_type=cloudquotas.UpdateQuotaPreferenceRequest, +): + transport_class = transports.CloudQuotasRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson(pb_request, use_integers_for_enums=False) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).update_quota_preference._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).update_quota_preference._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "allow_missing", + "ignore_safety_checks", + "update_mask", + "validate_only", + ) + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = resources.QuotaPreference() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "patch", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = resources.QuotaPreference.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.update_quota_preference(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_update_quota_preference_rest_unset_required_fields(): + transport = transports.CloudQuotasRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.update_quota_preference._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "allowMissing", + "ignoreSafetyChecks", + "updateMask", + "validateOnly", + ) + ) + & set(("quotaPreference",)) + ) + + +def test_update_quota_preference_rest_flattened(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = resources.QuotaPreference() + + # get arguments that satisfy an http rule for this method + sample_request = { + "quota_preference": { + "name": "projects/sample1/locations/sample2/quotaPreferences/sample3" + } + } + + # get truthy value for each flattened field + mock_args = dict( + quota_preference=resources.QuotaPreference(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = resources.QuotaPreference.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.update_quota_preference(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1beta/{quota_preference.name=projects/*/locations/*/quotaPreferences/*}" + % client.transport._host, + args[1], + ) + + +def test_update_quota_preference_rest_flattened_error(transport: str = "rest"): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.update_quota_preference( + cloudquotas.UpdateQuotaPreferenceRequest(), + quota_preference=resources.QuotaPreference(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.CloudQuotasGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.CloudQuotasGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = CloudQuotasClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.CloudQuotasGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = CloudQuotasClient( + client_options=options, + transport=transport, + ) + + # It is an error to provide an api_key and a credential. + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = CloudQuotasClient( + client_options=options, credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.CloudQuotasGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = CloudQuotasClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.CloudQuotasGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = CloudQuotasClient(transport=transport) + assert client.transport is transport + + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.CloudQuotasGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.CloudQuotasGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.CloudQuotasGrpcTransport, + transports.CloudQuotasGrpcAsyncIOTransport, + transports.CloudQuotasRestTransport, + ], +) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, "default") as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + + +def test_transport_kind_grpc(): + transport = CloudQuotasClient.get_transport_class("grpc")( + credentials=ga_credentials.AnonymousCredentials() + ) + assert transport.kind == "grpc" + + +def test_initialize_client_w_grpc(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc" + ) + assert client is not None + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_list_quota_infos_empty_call_grpc(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object(type(client.transport.list_quota_infos), "__call__") as call: + call.return_value = cloudquotas.ListQuotaInfosResponse() + client.list_quota_infos(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = cloudquotas.ListQuotaInfosRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_get_quota_info_empty_call_grpc(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object(type(client.transport.get_quota_info), "__call__") as call: + call.return_value = resources.QuotaInfo() + client.get_quota_info(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = cloudquotas.GetQuotaInfoRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_list_quota_preferences_empty_call_grpc(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_quota_preferences), "__call__" + ) as call: + call.return_value = cloudquotas.ListQuotaPreferencesResponse() + client.list_quota_preferences(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = cloudquotas.ListQuotaPreferencesRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_get_quota_preference_empty_call_grpc(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.get_quota_preference), "__call__" + ) as call: + call.return_value = resources.QuotaPreference() + client.get_quota_preference(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = cloudquotas.GetQuotaPreferenceRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_create_quota_preference_empty_call_grpc(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.create_quota_preference), "__call__" + ) as call: + call.return_value = resources.QuotaPreference() + client.create_quota_preference(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = cloudquotas.CreateQuotaPreferenceRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_update_quota_preference_empty_call_grpc(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.update_quota_preference), "__call__" + ) as call: + call.return_value = resources.QuotaPreference() + client.update_quota_preference(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = cloudquotas.UpdateQuotaPreferenceRequest() + + assert args[0] == request_msg + + +def test_transport_kind_grpc_asyncio(): + transport = CloudQuotasAsyncClient.get_transport_class("grpc_asyncio")( + credentials=async_anonymous_credentials() + ) + assert transport.kind == "grpc_asyncio" + + +def test_initialize_client_w_grpc_asyncio(): + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), transport="grpc_asyncio" + ) + assert client is not None + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_list_quota_infos_empty_call_grpc_asyncio(): + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object(type(client.transport.list_quota_infos), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + cloudquotas.ListQuotaInfosResponse( + next_page_token="next_page_token_value", + ) + ) + await client.list_quota_infos(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = cloudquotas.ListQuotaInfosRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_get_quota_info_empty_call_grpc_asyncio(): + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object(type(client.transport.get_quota_info), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + resources.QuotaInfo( + name="name_value", + quota_id="quota_id_value", + metric="metric_value", + service="service_value", + is_precise=True, + refresh_interval="refresh_interval_value", + container_type=resources.QuotaInfo.ContainerType.PROJECT, + dimensions=["dimensions_value"], + metric_display_name="metric_display_name_value", + quota_display_name="quota_display_name_value", + metric_unit="metric_unit_value", + is_fixed=True, + is_concurrent=True, + service_request_quota_uri="service_request_quota_uri_value", + ) + ) + await client.get_quota_info(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = cloudquotas.GetQuotaInfoRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_list_quota_preferences_empty_call_grpc_asyncio(): + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_quota_preferences), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + cloudquotas.ListQuotaPreferencesResponse( + next_page_token="next_page_token_value", + unreachable=["unreachable_value"], + ) + ) + await client.list_quota_preferences(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = cloudquotas.ListQuotaPreferencesRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_get_quota_preference_empty_call_grpc_asyncio(): + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.get_quota_preference), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + resources.QuotaPreference( + name="name_value", + etag="etag_value", + service="service_value", + quota_id="quota_id_value", + reconciling=True, + justification="justification_value", + contact_email="contact_email_value", + ) + ) + await client.get_quota_preference(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = cloudquotas.GetQuotaPreferenceRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_create_quota_preference_empty_call_grpc_asyncio(): + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.create_quota_preference), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + resources.QuotaPreference( + name="name_value", + etag="etag_value", + service="service_value", + quota_id="quota_id_value", + reconciling=True, + justification="justification_value", + contact_email="contact_email_value", + ) + ) + await client.create_quota_preference(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = cloudquotas.CreateQuotaPreferenceRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_update_quota_preference_empty_call_grpc_asyncio(): + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.update_quota_preference), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + resources.QuotaPreference( + name="name_value", + etag="etag_value", + service="service_value", + quota_id="quota_id_value", + reconciling=True, + justification="justification_value", + contact_email="contact_email_value", + ) + ) + await client.update_quota_preference(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = cloudquotas.UpdateQuotaPreferenceRequest() + + assert args[0] == request_msg + + +def test_transport_kind_rest(): + transport = CloudQuotasClient.get_transport_class("rest")( + credentials=ga_credentials.AnonymousCredentials() + ) + assert transport.kind == "rest" + + +def test_list_quota_infos_rest_bad_request( + request_type=cloudquotas.ListQuotaInfosRequest, +): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2/services/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = mock.Mock() + json_return_value = "" + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.list_quota_infos(request) + + +@pytest.mark.parametrize( + "request_type", + [ + cloudquotas.ListQuotaInfosRequest, + dict, + ], +) +def test_list_quota_infos_rest_call_success(request_type): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2/services/sample3"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = cloudquotas.ListQuotaInfosResponse( + next_page_token="next_page_token_value", + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = cloudquotas.ListQuotaInfosResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.list_quota_infos(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListQuotaInfosPager) + assert response.next_page_token == "next_page_token_value" + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_quota_infos_rest_interceptors(null_interceptor): + transport = transports.CloudQuotasRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.CloudQuotasRestInterceptor(), + ) + client = CloudQuotasClient(transport=transport) + + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.CloudQuotasRestInterceptor, "post_list_quota_infos" + ) as post, mock.patch.object( + transports.CloudQuotasRestInterceptor, "pre_list_quota_infos" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloudquotas.ListQuotaInfosRequest.pb( + cloudquotas.ListQuotaInfosRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = cloudquotas.ListQuotaInfosResponse.to_json( + cloudquotas.ListQuotaInfosResponse() + ) + req.return_value.content = return_value + + request = cloudquotas.ListQuotaInfosRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = cloudquotas.ListQuotaInfosResponse() + + client.list_quota_infos( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_quota_info_rest_bad_request(request_type=cloudquotas.GetQuotaInfoRequest): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/services/sample3/quotaInfos/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = mock.Mock() + json_return_value = "" + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.get_quota_info(request) + + +@pytest.mark.parametrize( + "request_type", + [ + cloudquotas.GetQuotaInfoRequest, + dict, + ], +) +def test_get_quota_info_rest_call_success(request_type): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/services/sample3/quotaInfos/sample4" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = resources.QuotaInfo( + name="name_value", + quota_id="quota_id_value", + metric="metric_value", + service="service_value", + is_precise=True, + refresh_interval="refresh_interval_value", + container_type=resources.QuotaInfo.ContainerType.PROJECT, + dimensions=["dimensions_value"], + metric_display_name="metric_display_name_value", + quota_display_name="quota_display_name_value", + metric_unit="metric_unit_value", + is_fixed=True, + is_concurrent=True, + service_request_quota_uri="service_request_quota_uri_value", + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = resources.QuotaInfo.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.get_quota_info(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, resources.QuotaInfo) + assert response.name == "name_value" + assert response.quota_id == "quota_id_value" + assert response.metric == "metric_value" + assert response.service == "service_value" + assert response.is_precise is True + assert response.refresh_interval == "refresh_interval_value" + assert response.container_type == resources.QuotaInfo.ContainerType.PROJECT + assert response.dimensions == ["dimensions_value"] + assert response.metric_display_name == "metric_display_name_value" + assert response.quota_display_name == "quota_display_name_value" + assert response.metric_unit == "metric_unit_value" + assert response.is_fixed is True + assert response.is_concurrent is True + assert response.service_request_quota_uri == "service_request_quota_uri_value" + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_quota_info_rest_interceptors(null_interceptor): + transport = transports.CloudQuotasRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.CloudQuotasRestInterceptor(), + ) + client = CloudQuotasClient(transport=transport) + + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.CloudQuotasRestInterceptor, "post_get_quota_info" + ) as post, mock.patch.object( + transports.CloudQuotasRestInterceptor, "pre_get_quota_info" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloudquotas.GetQuotaInfoRequest.pb( + cloudquotas.GetQuotaInfoRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = resources.QuotaInfo.to_json(resources.QuotaInfo()) + req.return_value.content = return_value + + request = cloudquotas.GetQuotaInfoRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = resources.QuotaInfo() + + client.get_quota_info( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_quota_preferences_rest_bad_request( + request_type=cloudquotas.ListQuotaPreferencesRequest, +): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = mock.Mock() + json_return_value = "" + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.list_quota_preferences(request) + + +@pytest.mark.parametrize( + "request_type", + [ + cloudquotas.ListQuotaPreferencesRequest, + dict, + ], +) +def test_list_quota_preferences_rest_call_success(request_type): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = cloudquotas.ListQuotaPreferencesResponse( + next_page_token="next_page_token_value", + unreachable=["unreachable_value"], + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = cloudquotas.ListQuotaPreferencesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.list_quota_preferences(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListQuotaPreferencesPager) + assert response.next_page_token == "next_page_token_value" + assert response.unreachable == ["unreachable_value"] + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_quota_preferences_rest_interceptors(null_interceptor): + transport = transports.CloudQuotasRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.CloudQuotasRestInterceptor(), + ) + client = CloudQuotasClient(transport=transport) + + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.CloudQuotasRestInterceptor, "post_list_quota_preferences" + ) as post, mock.patch.object( + transports.CloudQuotasRestInterceptor, "pre_list_quota_preferences" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloudquotas.ListQuotaPreferencesRequest.pb( + cloudquotas.ListQuotaPreferencesRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = cloudquotas.ListQuotaPreferencesResponse.to_json( + cloudquotas.ListQuotaPreferencesResponse() + ) + req.return_value.content = return_value + + request = cloudquotas.ListQuotaPreferencesRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = cloudquotas.ListQuotaPreferencesResponse() + + client.list_quota_preferences( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_quota_preference_rest_bad_request( + request_type=cloudquotas.GetQuotaPreferenceRequest, +): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/quotaPreferences/sample3" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = mock.Mock() + json_return_value = "" + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.get_quota_preference(request) + + +@pytest.mark.parametrize( + "request_type", + [ + cloudquotas.GetQuotaPreferenceRequest, + dict, + ], +) +def test_get_quota_preference_rest_call_success(request_type): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "projects/sample1/locations/sample2/quotaPreferences/sample3" + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = resources.QuotaPreference( + name="name_value", + etag="etag_value", + service="service_value", + quota_id="quota_id_value", + reconciling=True, + justification="justification_value", + contact_email="contact_email_value", + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = resources.QuotaPreference.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.get_quota_preference(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, resources.QuotaPreference) + assert response.name == "name_value" + assert response.etag == "etag_value" + assert response.service == "service_value" + assert response.quota_id == "quota_id_value" + assert response.reconciling is True + assert response.justification == "justification_value" + assert response.contact_email == "contact_email_value" + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_quota_preference_rest_interceptors(null_interceptor): + transport = transports.CloudQuotasRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.CloudQuotasRestInterceptor(), + ) + client = CloudQuotasClient(transport=transport) + + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.CloudQuotasRestInterceptor, "post_get_quota_preference" + ) as post, mock.patch.object( + transports.CloudQuotasRestInterceptor, "pre_get_quota_preference" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloudquotas.GetQuotaPreferenceRequest.pb( + cloudquotas.GetQuotaPreferenceRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = resources.QuotaPreference.to_json(resources.QuotaPreference()) + req.return_value.content = return_value + + request = cloudquotas.GetQuotaPreferenceRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = resources.QuotaPreference() + + client.get_quota_preference( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_create_quota_preference_rest_bad_request( + request_type=cloudquotas.CreateQuotaPreferenceRequest, +): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = mock.Mock() + json_return_value = "" + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.create_quota_preference(request) + + +@pytest.mark.parametrize( + "request_type", + [ + cloudquotas.CreateQuotaPreferenceRequest, + dict, + ], +) +def test_create_quota_preference_rest_call_success(request_type): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "projects/sample1/locations/sample2"} + request_init["quota_preference"] = { + "name": "name_value", + "dimensions": {}, + "quota_config": { + "preferred_value": 1595, + "state_detail": "state_detail_value", + "granted_value": {"value": 541}, + "trace_id": "trace_id_value", + "annotations": {}, + "request_origin": 1, + }, + "etag": "etag_value", + "create_time": {"seconds": 751, "nanos": 543}, + "update_time": {}, + "service": "service_value", + "quota_id": "quota_id_value", + "reconciling": True, + "justification": "justification_value", + "contact_email": "contact_email_value", + } + # The version of a generated dependency at test runtime may differ from the version used during generation. + # Delete any fields which are not present in the current runtime dependency + # See https://github.com/googleapis/gapic-generator-python/issues/1748 + + # Determine if the message type is proto-plus or protobuf + test_field = cloudquotas.CreateQuotaPreferenceRequest.meta.fields[ + "quota_preference" + ] + + def get_message_fields(field): + # Given a field which is a message (composite type), return a list with + # all the fields of the message. + # If the field is not a composite type, return an empty list. + message_fields = [] + + if hasattr(field, "message") and field.message: + is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") + + if is_field_type_proto_plus_type: + message_fields = field.message.meta.fields.values() + # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types + else: # pragma: NO COVER + message_fields = field.message.DESCRIPTOR.fields + return message_fields + + runtime_nested_fields = [ + (field.name, nested_field.name) + for field in get_message_fields(test_field) + for nested_field in get_message_fields(field) + ] + + subfields_not_in_runtime = [] + + # For each item in the sample request, create a list of sub fields which are not present at runtime + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for field, value in request_init["quota_preference"].items(): # pragma: NO COVER + result = None + is_repeated = False + # For repeated fields + if isinstance(value, list) and len(value): + is_repeated = True + result = value[0] + # For fields where the type is another message + if isinstance(value, dict): + result = value + + if result and hasattr(result, "keys"): + for subfield in result.keys(): + if (field, subfield) not in runtime_nested_fields: + subfields_not_in_runtime.append( + { + "field": field, + "subfield": subfield, + "is_repeated": is_repeated, + } + ) + + # Remove fields from the sample request which are not present in the runtime version of the dependency + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER + field = subfield_to_delete.get("field") + field_repeated = subfield_to_delete.get("is_repeated") + subfield = subfield_to_delete.get("subfield") + if subfield: + if field_repeated: + for i in range(0, len(request_init["quota_preference"][field])): + del request_init["quota_preference"][field][i][subfield] + else: + del request_init["quota_preference"][field][subfield] + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = resources.QuotaPreference( + name="name_value", + etag="etag_value", + service="service_value", + quota_id="quota_id_value", + reconciling=True, + justification="justification_value", + contact_email="contact_email_value", + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = resources.QuotaPreference.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.create_quota_preference(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, resources.QuotaPreference) + assert response.name == "name_value" + assert response.etag == "etag_value" + assert response.service == "service_value" + assert response.quota_id == "quota_id_value" + assert response.reconciling is True + assert response.justification == "justification_value" + assert response.contact_email == "contact_email_value" + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_create_quota_preference_rest_interceptors(null_interceptor): + transport = transports.CloudQuotasRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.CloudQuotasRestInterceptor(), + ) + client = CloudQuotasClient(transport=transport) + + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.CloudQuotasRestInterceptor, "post_create_quota_preference" + ) as post, mock.patch.object( + transports.CloudQuotasRestInterceptor, "pre_create_quota_preference" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloudquotas.CreateQuotaPreferenceRequest.pb( + cloudquotas.CreateQuotaPreferenceRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = resources.QuotaPreference.to_json(resources.QuotaPreference()) + req.return_value.content = return_value + + request = cloudquotas.CreateQuotaPreferenceRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = resources.QuotaPreference() + + client.create_quota_preference( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_update_quota_preference_rest_bad_request( + request_type=cloudquotas.UpdateQuotaPreferenceRequest, +): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + # send a request that will satisfy transcoding + request_init = { + "quota_preference": { + "name": "projects/sample1/locations/sample2/quotaPreferences/sample3" + } + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = mock.Mock() + json_return_value = "" + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.update_quota_preference(request) + + +@pytest.mark.parametrize( + "request_type", + [ + cloudquotas.UpdateQuotaPreferenceRequest, + dict, + ], +) +def test_update_quota_preference_rest_call_success(request_type): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = { + "quota_preference": { + "name": "projects/sample1/locations/sample2/quotaPreferences/sample3" + } + } + request_init["quota_preference"] = { + "name": "projects/sample1/locations/sample2/quotaPreferences/sample3", + "dimensions": {}, + "quota_config": { + "preferred_value": 1595, + "state_detail": "state_detail_value", + "granted_value": {"value": 541}, + "trace_id": "trace_id_value", + "annotations": {}, + "request_origin": 1, + }, + "etag": "etag_value", + "create_time": {"seconds": 751, "nanos": 543}, + "update_time": {}, + "service": "service_value", + "quota_id": "quota_id_value", + "reconciling": True, + "justification": "justification_value", + "contact_email": "contact_email_value", + } + # The version of a generated dependency at test runtime may differ from the version used during generation. + # Delete any fields which are not present in the current runtime dependency + # See https://github.com/googleapis/gapic-generator-python/issues/1748 + + # Determine if the message type is proto-plus or protobuf + test_field = cloudquotas.UpdateQuotaPreferenceRequest.meta.fields[ + "quota_preference" + ] + + def get_message_fields(field): + # Given a field which is a message (composite type), return a list with + # all the fields of the message. + # If the field is not a composite type, return an empty list. + message_fields = [] + + if hasattr(field, "message") and field.message: + is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") + + if is_field_type_proto_plus_type: + message_fields = field.message.meta.fields.values() + # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types + else: # pragma: NO COVER + message_fields = field.message.DESCRIPTOR.fields + return message_fields + + runtime_nested_fields = [ + (field.name, nested_field.name) + for field in get_message_fields(test_field) + for nested_field in get_message_fields(field) + ] + + subfields_not_in_runtime = [] + + # For each item in the sample request, create a list of sub fields which are not present at runtime + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for field, value in request_init["quota_preference"].items(): # pragma: NO COVER + result = None + is_repeated = False + # For repeated fields + if isinstance(value, list) and len(value): + is_repeated = True + result = value[0] + # For fields where the type is another message + if isinstance(value, dict): + result = value + + if result and hasattr(result, "keys"): + for subfield in result.keys(): + if (field, subfield) not in runtime_nested_fields: + subfields_not_in_runtime.append( + { + "field": field, + "subfield": subfield, + "is_repeated": is_repeated, + } + ) + + # Remove fields from the sample request which are not present in the runtime version of the dependency + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER + field = subfield_to_delete.get("field") + field_repeated = subfield_to_delete.get("is_repeated") + subfield = subfield_to_delete.get("subfield") + if subfield: + if field_repeated: + for i in range(0, len(request_init["quota_preference"][field])): + del request_init["quota_preference"][field][i][subfield] + else: + del request_init["quota_preference"][field][subfield] + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = resources.QuotaPreference( + name="name_value", + etag="etag_value", + service="service_value", + quota_id="quota_id_value", + reconciling=True, + justification="justification_value", + contact_email="contact_email_value", + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = resources.QuotaPreference.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.update_quota_preference(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, resources.QuotaPreference) + assert response.name == "name_value" + assert response.etag == "etag_value" + assert response.service == "service_value" + assert response.quota_id == "quota_id_value" + assert response.reconciling is True + assert response.justification == "justification_value" + assert response.contact_email == "contact_email_value" + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_quota_preference_rest_interceptors(null_interceptor): + transport = transports.CloudQuotasRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.CloudQuotasRestInterceptor(), + ) + client = CloudQuotasClient(transport=transport) + + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.CloudQuotasRestInterceptor, "post_update_quota_preference" + ) as post, mock.patch.object( + transports.CloudQuotasRestInterceptor, "pre_update_quota_preference" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = cloudquotas.UpdateQuotaPreferenceRequest.pb( + cloudquotas.UpdateQuotaPreferenceRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = resources.QuotaPreference.to_json(resources.QuotaPreference()) + req.return_value.content = return_value + + request = cloudquotas.UpdateQuotaPreferenceRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = resources.QuotaPreference() + + client.update_quota_preference( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_initialize_client_w_rest(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + assert client is not None + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_list_quota_infos_empty_call_rest(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object(type(client.transport.list_quota_infos), "__call__") as call: + client.list_quota_infos(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = cloudquotas.ListQuotaInfosRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_get_quota_info_empty_call_rest(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object(type(client.transport.get_quota_info), "__call__") as call: + client.get_quota_info(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = cloudquotas.GetQuotaInfoRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_list_quota_preferences_empty_call_rest(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_quota_preferences), "__call__" + ) as call: + client.list_quota_preferences(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = cloudquotas.ListQuotaPreferencesRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_get_quota_preference_empty_call_rest(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.get_quota_preference), "__call__" + ) as call: + client.get_quota_preference(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = cloudquotas.GetQuotaPreferenceRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_create_quota_preference_empty_call_rest(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.create_quota_preference), "__call__" + ) as call: + client.create_quota_preference(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = cloudquotas.CreateQuotaPreferenceRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_update_quota_preference_empty_call_rest(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.update_quota_preference), "__call__" + ) as call: + client.update_quota_preference(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = cloudquotas.UpdateQuotaPreferenceRequest() + + assert args[0] == request_msg + + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.CloudQuotasGrpcTransport, + ) + + +def test_cloud_quotas_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.CloudQuotasTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json", + ) + + +def test_cloud_quotas_base_transport(): + # Instantiate the base transport. + with mock.patch( + "google.cloud.cloudquotas_v1beta.services.cloud_quotas.transports.CloudQuotasTransport.__init__" + ) as Transport: + Transport.return_value = None + transport = transports.CloudQuotasTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + "list_quota_infos", + "get_quota_info", + "list_quota_preferences", + "get_quota_preference", + "create_quota_preference", + "update_quota_preference", + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + with pytest.raises(NotImplementedError): + transport.close() + + # Catch all for all remaining methods and properties + remainder = [ + "kind", + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +def test_cloud_quotas_base_transport_with_credentials_file(): + # Instantiate the base transport with a credentials file + with mock.patch.object( + google.auth, "load_credentials_from_file", autospec=True + ) as load_creds, mock.patch( + "google.cloud.cloudquotas_v1beta.services.cloud_quotas.transports.CloudQuotasTransport._prep_wrapped_messages" + ) as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.CloudQuotasTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with( + "credentials.json", + scopes=None, + default_scopes=("https://www.googleapis.com/auth/cloud-platform",), + quota_project_id="octopus", + ) + + +def test_cloud_quotas_base_transport_with_adc(): + # Test the default credentials are used if credentials and credentials_file are None. + with mock.patch.object(google.auth, "default", autospec=True) as adc, mock.patch( + "google.cloud.cloudquotas_v1beta.services.cloud_quotas.transports.CloudQuotasTransport._prep_wrapped_messages" + ) as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.CloudQuotasTransport() + adc.assert_called_once() + + +def test_cloud_quotas_auth_adc(): + # If no credentials are provided, we should use ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + CloudQuotasClient() + adc.assert_called_once_with( + scopes=None, + default_scopes=("https://www.googleapis.com/auth/cloud-platform",), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.CloudQuotasGrpcTransport, + transports.CloudQuotasGrpcAsyncIOTransport, + ], +) +def test_cloud_quotas_transport_auth_adc(transport_class): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class(quota_project_id="octopus", scopes=["1", "2"]) + adc.assert_called_once_with( + scopes=["1", "2"], + default_scopes=("https://www.googleapis.com/auth/cloud-platform",), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.CloudQuotasGrpcTransport, + transports.CloudQuotasGrpcAsyncIOTransport, + transports.CloudQuotasRestTransport, + ], +) +def test_cloud_quotas_transport_auth_gdch_credentials(transport_class): + host = "https://language.com" + api_audience_tests = [None, "https://language2.com"] + api_audience_expect = [host, "https://language2.com"] + for t, e in zip(api_audience_tests, api_audience_expect): + with mock.patch.object(google.auth, "default", autospec=True) as adc: + gdch_mock = mock.MagicMock() + type(gdch_mock).with_gdch_audience = mock.PropertyMock( + return_value=gdch_mock + ) + adc.return_value = (gdch_mock, None) + transport_class(host=host, api_audience=t) + gdch_mock.with_gdch_audience.assert_called_once_with(e) + + +@pytest.mark.parametrize( + "transport_class,grpc_helpers", + [ + (transports.CloudQuotasGrpcTransport, grpc_helpers), + (transports.CloudQuotasGrpcAsyncIOTransport, grpc_helpers_async), + ], +) +def test_cloud_quotas_transport_create_channel(transport_class, grpc_helpers): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object( + google.auth, "default", autospec=True + ) as adc, mock.patch.object( + grpc_helpers, "create_channel", autospec=True + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + adc.return_value = (creds, None) + transport_class(quota_project_id="octopus", scopes=["1", "2"]) + + create_channel.assert_called_with( + "cloudquotas.googleapis.com:443", + credentials=creds, + credentials_file=None, + quota_project_id="octopus", + default_scopes=("https://www.googleapis.com/auth/cloud-platform",), + scopes=["1", "2"], + default_host="cloudquotas.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize( + "transport_class", + [transports.CloudQuotasGrpcTransport, transports.CloudQuotasGrpcAsyncIOTransport], +) +def test_cloud_quotas_grpc_transport_client_cert_source_for_mtls(transport_class): + cred = ga_credentials.AnonymousCredentials() + + # Check ssl_channel_credentials is used if provided. + with mock.patch.object(transport_class, "create_channel") as mock_create_channel: + mock_ssl_channel_creds = mock.Mock() + transport_class( + host="squid.clam.whelk", + credentials=cred, + ssl_channel_credentials=mock_ssl_channel_creds, + ) + mock_create_channel.assert_called_once_with( + "squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_channel_creds, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Check if ssl_channel_credentials is not provided, then client_cert_source_for_mtls + # is used. + with mock.patch.object(transport_class, "create_channel", return_value=mock.Mock()): + with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: + transport_class( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback, + ) + expected_cert, expected_key = client_cert_source_callback() + mock_ssl_cred.assert_called_once_with( + certificate_chain=expected_cert, private_key=expected_key + ) + + +def test_cloud_quotas_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch( + "google.auth.transport.requests.AuthorizedSession.configure_mtls_channel" + ) as mock_configure_mtls_channel: + transports.CloudQuotasRestTransport( + credentials=cred, client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +@pytest.mark.parametrize( + "transport_name", + [ + "grpc", + "grpc_asyncio", + "rest", + ], +) +def test_cloud_quotas_host_no_port(transport_name): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions( + api_endpoint="cloudquotas.googleapis.com" + ), + transport=transport_name, + ) + assert client.transport._host == ( + "cloudquotas.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://cloudquotas.googleapis.com" + ) + + +@pytest.mark.parametrize( + "transport_name", + [ + "grpc", + "grpc_asyncio", + "rest", + ], +) +def test_cloud_quotas_host_with_port(transport_name): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions( + api_endpoint="cloudquotas.googleapis.com:8000" + ), + transport=transport_name, + ) + assert client.transport._host == ( + "cloudquotas.googleapis.com:8000" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://cloudquotas.googleapis.com:8000" + ) + + +@pytest.mark.parametrize( + "transport_name", + [ + "rest", + ], +) +def test_cloud_quotas_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = CloudQuotasClient( + credentials=creds1, + transport=transport_name, + ) + client2 = CloudQuotasClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.list_quota_infos._session + session2 = client2.transport.list_quota_infos._session + assert session1 != session2 + session1 = client1.transport.get_quota_info._session + session2 = client2.transport.get_quota_info._session + assert session1 != session2 + session1 = client1.transport.list_quota_preferences._session + session2 = client2.transport.list_quota_preferences._session + assert session1 != session2 + session1 = client1.transport.get_quota_preference._session + session2 = client2.transport.get_quota_preference._session + assert session1 != session2 + session1 = client1.transport.create_quota_preference._session + session2 = client2.transport.create_quota_preference._session + assert session1 != session2 + session1 = client1.transport.update_quota_preference._session + session2 = client2.transport.update_quota_preference._session + assert session1 != session2 + + +def test_cloud_quotas_grpc_transport_channel(): + channel = grpc.secure_channel("http://localhost/", grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.CloudQuotasGrpcTransport( + host="squid.clam.whelk", + channel=channel, + ) + assert transport.grpc_channel == channel + assert transport._host == "squid.clam.whelk:443" + assert transport._ssl_channel_credentials == None + + +def test_cloud_quotas_grpc_asyncio_transport_channel(): + channel = aio.secure_channel("http://localhost/", grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.CloudQuotasGrpcAsyncIOTransport( + host="squid.clam.whelk", + channel=channel, + ) + assert transport.grpc_channel == channel + assert transport._host == "squid.clam.whelk:443" + assert transport._ssl_channel_credentials == None + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize( + "transport_class", + [transports.CloudQuotasGrpcTransport, transports.CloudQuotasGrpcAsyncIOTransport], +) +def test_cloud_quotas_transport_channel_mtls_with_client_cert_source(transport_class): + with mock.patch( + "grpc.ssl_channel_credentials", autospec=True + ) as grpc_ssl_channel_cred: + with mock.patch.object( + transport_class, "create_channel" + ) as grpc_create_channel: + mock_ssl_cred = mock.Mock() + grpc_ssl_channel_cred.return_value = mock_ssl_cred + + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + + cred = ga_credentials.AnonymousCredentials() + with pytest.warns(DeprecationWarning): + with mock.patch.object(google.auth, "default") as adc: + adc.return_value = (cred, None) + transport = transport_class( + host="squid.clam.whelk", + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=client_cert_source_callback, + ) + adc.assert_called_once() + + grpc_ssl_channel_cred.assert_called_once_with( + certificate_chain=b"cert bytes", private_key=b"key bytes" + ) + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + assert transport._ssl_channel_credentials == mock_ssl_cred + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize( + "transport_class", + [transports.CloudQuotasGrpcTransport, transports.CloudQuotasGrpcAsyncIOTransport], +) +def test_cloud_quotas_transport_channel_mtls_with_adc(transport_class): + mock_ssl_cred = mock.Mock() + with mock.patch.multiple( + "google.auth.transport.grpc.SslCredentials", + __init__=mock.Mock(return_value=None), + ssl_credentials=mock.PropertyMock(return_value=mock_ssl_cred), + ): + with mock.patch.object( + transport_class, "create_channel" + ) as grpc_create_channel: + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + mock_cred = mock.Mock() + + with pytest.warns(DeprecationWarning): + transport = transport_class( + host="squid.clam.whelk", + credentials=mock_cred, + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=None, + ) + + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=mock_cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + + +def test_quota_info_path(): + project = "squid" + location = "clam" + service = "whelk" + quota_info = "octopus" + expected = "projects/{project}/locations/{location}/services/{service}/quotaInfos/{quota_info}".format( + project=project, + location=location, + service=service, + quota_info=quota_info, + ) + actual = CloudQuotasClient.quota_info_path(project, location, service, quota_info) + assert expected == actual + + +def test_parse_quota_info_path(): + expected = { + "project": "oyster", + "location": "nudibranch", + "service": "cuttlefish", + "quota_info": "mussel", + } + path = CloudQuotasClient.quota_info_path(**expected) + + # Check that the path construction is reversible. + actual = CloudQuotasClient.parse_quota_info_path(path) + assert expected == actual + + +def test_quota_preference_path(): + project = "winkle" + location = "nautilus" + quota_preference = "scallop" + expected = "projects/{project}/locations/{location}/quotaPreferences/{quota_preference}".format( + project=project, + location=location, + quota_preference=quota_preference, + ) + actual = CloudQuotasClient.quota_preference_path( + project, location, quota_preference + ) + assert expected == actual + + +def test_parse_quota_preference_path(): + expected = { + "project": "abalone", + "location": "squid", + "quota_preference": "clam", + } + path = CloudQuotasClient.quota_preference_path(**expected) + + # Check that the path construction is reversible. + actual = CloudQuotasClient.parse_quota_preference_path(path) + assert expected == actual + + +def test_common_billing_account_path(): + billing_account = "whelk" + expected = "billingAccounts/{billing_account}".format( + billing_account=billing_account, + ) + actual = CloudQuotasClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "octopus", + } + path = CloudQuotasClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = CloudQuotasClient.parse_common_billing_account_path(path) + assert expected == actual + + +def test_common_folder_path(): + folder = "oyster" + expected = "folders/{folder}".format( + folder=folder, + ) + actual = CloudQuotasClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "nudibranch", + } + path = CloudQuotasClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = CloudQuotasClient.parse_common_folder_path(path) + assert expected == actual + + +def test_common_organization_path(): + organization = "cuttlefish" + expected = "organizations/{organization}".format( + organization=organization, + ) + actual = CloudQuotasClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "mussel", + } + path = CloudQuotasClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = CloudQuotasClient.parse_common_organization_path(path) + assert expected == actual + + +def test_common_project_path(): + project = "winkle" + expected = "projects/{project}".format( + project=project, + ) + actual = CloudQuotasClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "nautilus", + } + path = CloudQuotasClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = CloudQuotasClient.parse_common_project_path(path) + assert expected == actual + + +def test_common_location_path(): + project = "scallop" + location = "abalone" + expected = "projects/{project}/locations/{location}".format( + project=project, + location=location, + ) + actual = CloudQuotasClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "squid", + "location": "clam", + } + path = CloudQuotasClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = CloudQuotasClient.parse_common_location_path(path) + assert expected == actual + + +def test_client_with_default_client_info(): + client_info = gapic_v1.client_info.ClientInfo() + + with mock.patch.object( + transports.CloudQuotasTransport, "_prep_wrapped_messages" + ) as prep: + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object( + transports.CloudQuotasTransport, "_prep_wrapped_messages" + ) as prep: + transport_class = CloudQuotasClient.get_transport_class() + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + +def test_transport_close_grpc(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc" + ) + with mock.patch.object( + type(getattr(client.transport, "_grpc_channel")), "close" + ) as close: + with client: + close.assert_not_called() + close.assert_called_once() + + +@pytest.mark.asyncio +async def test_transport_close_grpc_asyncio(): + client = CloudQuotasAsyncClient( + credentials=async_anonymous_credentials(), transport="grpc_asyncio" + ) + with mock.patch.object( + type(getattr(client.transport, "_grpc_channel")), "close" + ) as close: + async with client: + close.assert_not_called() + close.assert_called_once() + + +def test_transport_close_rest(): + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + with mock.patch.object( + type(getattr(client.transport, "_session")), "close" + ) as close: + with client: + close.assert_not_called() + close.assert_called_once() + + +def test_client_ctx(): + transports = [ + "rest", + "grpc", + ] + for transport in transports: + client = CloudQuotasClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport + ) + # Test client calls underlying transport. + with mock.patch.object(type(client.transport), "close") as close: + close.assert_not_called() + with client: + pass + close.assert_called() + + +@pytest.mark.parametrize( + "client_class,transport_class", + [ + (CloudQuotasClient, transports.CloudQuotasGrpcTransport), + (CloudQuotasAsyncClient, transports.CloudQuotasGrpcAsyncIOTransport), + ], +) +def test_api_key_credentials(client_class, transport_class): + with mock.patch.object( + google.auth._default, "get_api_key_credentials", create=True + ) as get_api_key_credentials: + mock_cred = mock.Mock() + get_api_key_credentials.return_value = mock_cred + options = client_options.ClientOptions() + options.api_key = "api_key" + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=mock_cred, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) diff --git a/packages/google-cloud-quotas/tests/unit/gapic/cloudquotas_v1beta/test_quota_adjuster_settings_manager.py b/packages/google-cloud-quotas/tests/unit/gapic/cloudquotas_v1beta/test_quota_adjuster_settings_manager.py new file mode 100644 index 000000000000..1141de8a8476 --- /dev/null +++ b/packages/google-cloud-quotas/tests/unit/gapic/cloudquotas_v1beta/test_quota_adjuster_settings_manager.py @@ -0,0 +1,3602 @@ +# -*- coding: utf-8 -*- +# 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. +# 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 os + +# try/except added for compatibility with python < 3.8 +try: + from unittest import mock + from unittest.mock import AsyncMock # pragma: NO COVER +except ImportError: # pragma: NO COVER + import mock + +from collections.abc import AsyncIterable, Iterable +import json +import math + +from google.api_core import api_core_version +from google.protobuf import json_format +import grpc +from grpc.experimental import aio +from proto.marshal.rules import wrappers +from proto.marshal.rules.dates import DurationRule, TimestampRule +import pytest +from requests import PreparedRequest, Request, Response +from requests.sessions import Session + +try: + from google.auth.aio import credentials as ga_credentials_async + + HAS_GOOGLE_AUTH_AIO = True +except ImportError: # pragma: NO COVER + HAS_GOOGLE_AUTH_AIO = False + +from google.api_core import gapic_v1, grpc_helpers, grpc_helpers_async, path_template +from google.api_core import client_options +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +import google.auth +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.oauth2 import service_account +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore + +from google.cloud.cloudquotas_v1beta.services.quota_adjuster_settings_manager import ( + QuotaAdjusterSettingsManagerAsyncClient, + QuotaAdjusterSettingsManagerClient, + transports, +) +from google.cloud.cloudquotas_v1beta.types import ( + quota_adjuster_settings as gac_quota_adjuster_settings, +) +from google.cloud.cloudquotas_v1beta.types import quota_adjuster_settings + + +async def mock_async_gen(data, chunk_size=1): + for i in range(0, len(data)): # pragma: NO COVER + chunk = data[i : i + chunk_size] + yield chunk.encode("utf-8") + + +def client_cert_source_callback(): + return b"cert bytes", b"key bytes" + + +# TODO: use async auth anon credentials by default once the minimum version of google-auth is upgraded. +# See related issue: https://github.com/googleapis/gapic-generator-python/issues/2107. +def async_anonymous_credentials(): + if HAS_GOOGLE_AUTH_AIO: + return ga_credentials_async.AnonymousCredentials() + return ga_credentials.AnonymousCredentials() + + +# If default endpoint is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint(client): + return ( + "foo.googleapis.com" + if ("localhost" in client.DEFAULT_ENDPOINT) + else client.DEFAULT_ENDPOINT + ) + + +# If default endpoint template is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint template so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint_template(client): + return ( + "test.{UNIVERSE_DOMAIN}" + if ("localhost" in client._DEFAULT_ENDPOINT_TEMPLATE) + else client._DEFAULT_ENDPOINT_TEMPLATE + ) + + +def test__get_default_mtls_endpoint(): + api_endpoint = "example.googleapis.com" + api_mtls_endpoint = "example.mtls.googleapis.com" + sandbox_endpoint = "example.sandbox.googleapis.com" + sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" + non_googleapi = "api.example.com" + + assert QuotaAdjusterSettingsManagerClient._get_default_mtls_endpoint(None) is None + assert ( + QuotaAdjusterSettingsManagerClient._get_default_mtls_endpoint(api_endpoint) + == api_mtls_endpoint + ) + assert ( + QuotaAdjusterSettingsManagerClient._get_default_mtls_endpoint(api_mtls_endpoint) + == api_mtls_endpoint + ) + assert ( + QuotaAdjusterSettingsManagerClient._get_default_mtls_endpoint(sandbox_endpoint) + == sandbox_mtls_endpoint + ) + assert ( + QuotaAdjusterSettingsManagerClient._get_default_mtls_endpoint( + sandbox_mtls_endpoint + ) + == sandbox_mtls_endpoint + ) + assert ( + QuotaAdjusterSettingsManagerClient._get_default_mtls_endpoint(non_googleapi) + == non_googleapi + ) + + +def test__read_environment_variables(): + assert QuotaAdjusterSettingsManagerClient._read_environment_variables() == ( + False, + "auto", + None, + ) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + assert QuotaAdjusterSettingsManagerClient._read_environment_variables() == ( + True, + "auto", + None, + ) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): + assert QuotaAdjusterSettingsManagerClient._read_environment_variables() == ( + False, + "auto", + None, + ) + + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"} + ): + with pytest.raises(ValueError) as excinfo: + QuotaAdjusterSettingsManagerClient._read_environment_variables() + assert ( + str(excinfo.value) + == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + ) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + assert QuotaAdjusterSettingsManagerClient._read_environment_variables() == ( + False, + "never", + None, + ) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + assert QuotaAdjusterSettingsManagerClient._read_environment_variables() == ( + False, + "always", + None, + ) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}): + assert QuotaAdjusterSettingsManagerClient._read_environment_variables() == ( + False, + "auto", + None, + ) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError) as excinfo: + QuotaAdjusterSettingsManagerClient._read_environment_variables() + assert ( + str(excinfo.value) + == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + ) + + with mock.patch.dict(os.environ, {"GOOGLE_CLOUD_UNIVERSE_DOMAIN": "foo.com"}): + assert QuotaAdjusterSettingsManagerClient._read_environment_variables() == ( + False, + "auto", + "foo.com", + ) + + +def test__get_client_cert_source(): + mock_provided_cert_source = mock.Mock() + mock_default_cert_source = mock.Mock() + + assert ( + QuotaAdjusterSettingsManagerClient._get_client_cert_source(None, False) is None + ) + assert ( + QuotaAdjusterSettingsManagerClient._get_client_cert_source( + mock_provided_cert_source, False + ) + is None + ) + assert ( + QuotaAdjusterSettingsManagerClient._get_client_cert_source( + mock_provided_cert_source, True + ) + == mock_provided_cert_source + ) + + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", return_value=True + ): + with mock.patch( + "google.auth.transport.mtls.default_client_cert_source", + return_value=mock_default_cert_source, + ): + assert ( + QuotaAdjusterSettingsManagerClient._get_client_cert_source(None, True) + is mock_default_cert_source + ) + assert ( + QuotaAdjusterSettingsManagerClient._get_client_cert_source( + mock_provided_cert_source, "true" + ) + is mock_provided_cert_source + ) + + +@mock.patch.object( + QuotaAdjusterSettingsManagerClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(QuotaAdjusterSettingsManagerClient), +) +@mock.patch.object( + QuotaAdjusterSettingsManagerAsyncClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(QuotaAdjusterSettingsManagerAsyncClient), +) +def test__get_api_endpoint(): + api_override = "foo.com" + mock_client_cert_source = mock.Mock() + default_universe = QuotaAdjusterSettingsManagerClient._DEFAULT_UNIVERSE + default_endpoint = ( + QuotaAdjusterSettingsManagerClient._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=default_universe + ) + ) + mock_universe = "bar.com" + mock_endpoint = ( + QuotaAdjusterSettingsManagerClient._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=mock_universe + ) + ) + + assert ( + QuotaAdjusterSettingsManagerClient._get_api_endpoint( + api_override, mock_client_cert_source, default_universe, "always" + ) + == api_override + ) + assert ( + QuotaAdjusterSettingsManagerClient._get_api_endpoint( + None, mock_client_cert_source, default_universe, "auto" + ) + == QuotaAdjusterSettingsManagerClient.DEFAULT_MTLS_ENDPOINT + ) + assert ( + QuotaAdjusterSettingsManagerClient._get_api_endpoint( + None, None, default_universe, "auto" + ) + == default_endpoint + ) + assert ( + QuotaAdjusterSettingsManagerClient._get_api_endpoint( + None, None, default_universe, "always" + ) + == QuotaAdjusterSettingsManagerClient.DEFAULT_MTLS_ENDPOINT + ) + assert ( + QuotaAdjusterSettingsManagerClient._get_api_endpoint( + None, mock_client_cert_source, default_universe, "always" + ) + == QuotaAdjusterSettingsManagerClient.DEFAULT_MTLS_ENDPOINT + ) + assert ( + QuotaAdjusterSettingsManagerClient._get_api_endpoint( + None, None, mock_universe, "never" + ) + == mock_endpoint + ) + assert ( + QuotaAdjusterSettingsManagerClient._get_api_endpoint( + None, None, default_universe, "never" + ) + == default_endpoint + ) + + with pytest.raises(MutualTLSChannelError) as excinfo: + QuotaAdjusterSettingsManagerClient._get_api_endpoint( + None, mock_client_cert_source, mock_universe, "auto" + ) + assert ( + str(excinfo.value) + == "mTLS is not supported in any universe other than googleapis.com." + ) + + +def test__get_universe_domain(): + client_universe_domain = "foo.com" + universe_domain_env = "bar.com" + + assert ( + QuotaAdjusterSettingsManagerClient._get_universe_domain( + client_universe_domain, universe_domain_env + ) + == client_universe_domain + ) + assert ( + QuotaAdjusterSettingsManagerClient._get_universe_domain( + None, universe_domain_env + ) + == universe_domain_env + ) + assert ( + QuotaAdjusterSettingsManagerClient._get_universe_domain(None, None) + == QuotaAdjusterSettingsManagerClient._DEFAULT_UNIVERSE + ) + + with pytest.raises(ValueError) as excinfo: + QuotaAdjusterSettingsManagerClient._get_universe_domain("", None) + assert str(excinfo.value) == "Universe Domain cannot be an empty string." + + +@pytest.mark.parametrize( + "client_class,transport_name", + [ + (QuotaAdjusterSettingsManagerClient, "grpc"), + (QuotaAdjusterSettingsManagerAsyncClient, "grpc_asyncio"), + (QuotaAdjusterSettingsManagerClient, "rest"), + ], +) +def test_quota_adjuster_settings_manager_client_from_service_account_info( + client_class, transport_name +): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object( + service_account.Credentials, "from_service_account_info" + ) as factory: + factory.return_value = creds + info = {"valid": True} + client = client_class.from_service_account_info(info, transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + "cloudquotas.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://cloudquotas.googleapis.com" + ) + + +@pytest.mark.parametrize( + "transport_class,transport_name", + [ + (transports.QuotaAdjusterSettingsManagerGrpcTransport, "grpc"), + (transports.QuotaAdjusterSettingsManagerGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.QuotaAdjusterSettingsManagerRestTransport, "rest"), + ], +) +def test_quota_adjuster_settings_manager_client_service_account_always_use_jwt( + transport_class, transport_name +): + with mock.patch.object( + service_account.Credentials, "with_always_use_jwt_access", create=True + ) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=True) + use_jwt.assert_called_once_with(True) + + with mock.patch.object( + service_account.Credentials, "with_always_use_jwt_access", create=True + ) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=False) + use_jwt.assert_not_called() + + +@pytest.mark.parametrize( + "client_class,transport_name", + [ + (QuotaAdjusterSettingsManagerClient, "grpc"), + (QuotaAdjusterSettingsManagerAsyncClient, "grpc_asyncio"), + (QuotaAdjusterSettingsManagerClient, "rest"), + ], +) +def test_quota_adjuster_settings_manager_client_from_service_account_file( + client_class, transport_name +): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object( + service_account.Credentials, "from_service_account_file" + ) as factory: + factory.return_value = creds + client = client_class.from_service_account_file( + "dummy/file/path.json", transport=transport_name + ) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json( + "dummy/file/path.json", transport=transport_name + ) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + "cloudquotas.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://cloudquotas.googleapis.com" + ) + + +def test_quota_adjuster_settings_manager_client_get_transport_class(): + transport = QuotaAdjusterSettingsManagerClient.get_transport_class() + available_transports = [ + transports.QuotaAdjusterSettingsManagerGrpcTransport, + transports.QuotaAdjusterSettingsManagerRestTransport, + ] + assert transport in available_transports + + transport = QuotaAdjusterSettingsManagerClient.get_transport_class("grpc") + assert transport == transports.QuotaAdjusterSettingsManagerGrpcTransport + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name", + [ + ( + QuotaAdjusterSettingsManagerClient, + transports.QuotaAdjusterSettingsManagerGrpcTransport, + "grpc", + ), + ( + QuotaAdjusterSettingsManagerAsyncClient, + transports.QuotaAdjusterSettingsManagerGrpcAsyncIOTransport, + "grpc_asyncio", + ), + ( + QuotaAdjusterSettingsManagerClient, + transports.QuotaAdjusterSettingsManagerRestTransport, + "rest", + ), + ], +) +@mock.patch.object( + QuotaAdjusterSettingsManagerClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(QuotaAdjusterSettingsManagerClient), +) +@mock.patch.object( + QuotaAdjusterSettingsManagerAsyncClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(QuotaAdjusterSettingsManagerAsyncClient), +) +def test_quota_adjuster_settings_manager_client_client_options( + client_class, transport_class, transport_name +): + # Check that if channel is provided we won't create a new one. + with mock.patch.object( + QuotaAdjusterSettingsManagerClient, "get_transport_class" + ) as gtc: + transport = transport_class(credentials=ga_credentials.AnonymousCredentials()) + client = client_class(transport=transport) + gtc.assert_not_called() + + # Check that if channel is provided via str we will create a new one. + with mock.patch.object( + QuotaAdjusterSettingsManagerClient, "get_transport_class" + ) as gtc: + client = client_class(transport=transport_name) + gtc.assert_called() + + # Check the case api_endpoint is provided. + options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(transport=transport_name, client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_MTLS_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError) as excinfo: + client = client_class(transport=transport_name) + assert ( + str(excinfo.value) + == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + ) + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"} + ): + with pytest.raises(ValueError) as excinfo: + client = client_class(transport=transport_name) + assert ( + str(excinfo.value) + == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + ) + + # Check the case quota_project_id is provided + options = client_options.ClientOptions(quota_project_id="octopus") + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id="octopus", + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + # Check the case api_endpoint is provided + options = client_options.ClientOptions( + api_audience="https://language.googleapis.com" + ) + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience="https://language.googleapis.com", + ) + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name,use_client_cert_env", + [ + ( + QuotaAdjusterSettingsManagerClient, + transports.QuotaAdjusterSettingsManagerGrpcTransport, + "grpc", + "true", + ), + ( + QuotaAdjusterSettingsManagerAsyncClient, + transports.QuotaAdjusterSettingsManagerGrpcAsyncIOTransport, + "grpc_asyncio", + "true", + ), + ( + QuotaAdjusterSettingsManagerClient, + transports.QuotaAdjusterSettingsManagerGrpcTransport, + "grpc", + "false", + ), + ( + QuotaAdjusterSettingsManagerAsyncClient, + transports.QuotaAdjusterSettingsManagerGrpcAsyncIOTransport, + "grpc_asyncio", + "false", + ), + ( + QuotaAdjusterSettingsManagerClient, + transports.QuotaAdjusterSettingsManagerRestTransport, + "rest", + "true", + ), + ( + QuotaAdjusterSettingsManagerClient, + transports.QuotaAdjusterSettingsManagerRestTransport, + "rest", + "false", + ), + ], +) +@mock.patch.object( + QuotaAdjusterSettingsManagerClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(QuotaAdjusterSettingsManagerClient), +) +@mock.patch.object( + QuotaAdjusterSettingsManagerAsyncClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(QuotaAdjusterSettingsManagerAsyncClient), +) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_quota_adjuster_settings_manager_client_mtls_env_auto( + client_class, transport_class, transport_name, use_client_cert_env +): + # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default + # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. + + # Check the case client_cert_source is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env} + ): + options = client_options.ClientOptions( + client_cert_source=client_cert_source_callback + ) + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + + if use_client_cert_env == "false": + expected_client_cert_source = None + expected_host = client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ) + else: + expected_client_cert_source = client_cert_source_callback + expected_host = client.DEFAULT_MTLS_ENDPOINT + + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case ADC client cert is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env} + ): + with mock.patch.object(transport_class, "__init__") as patched: + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", + return_value=True, + ): + with mock.patch( + "google.auth.transport.mtls.default_client_cert_source", + return_value=client_cert_source_callback, + ): + if use_client_cert_env == "false": + expected_host = client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ) + expected_client_cert_source = None + else: + expected_host = client.DEFAULT_MTLS_ENDPOINT + expected_client_cert_source = client_cert_source_callback + + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case client_cert_source and ADC client cert are not provided. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env} + ): + with mock.patch.object(transport_class, "__init__") as patched: + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", + return_value=False, + ): + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize( + "client_class", + [QuotaAdjusterSettingsManagerClient, QuotaAdjusterSettingsManagerAsyncClient], +) +@mock.patch.object( + QuotaAdjusterSettingsManagerClient, + "DEFAULT_ENDPOINT", + modify_default_endpoint(QuotaAdjusterSettingsManagerClient), +) +@mock.patch.object( + QuotaAdjusterSettingsManagerAsyncClient, + "DEFAULT_ENDPOINT", + modify_default_endpoint(QuotaAdjusterSettingsManagerAsyncClient), +) +def test_quota_adjuster_settings_manager_client_get_mtls_endpoint_and_cert_source( + client_class, +): + mock_client_cert_source = mock.Mock() + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "true". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + mock_api_endpoint = "foo" + options = client_options.ClientOptions( + client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint + ) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source( + options + ) + assert api_endpoint == mock_api_endpoint + assert cert_source == mock_client_cert_source + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "false". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): + mock_client_cert_source = mock.Mock() + mock_api_endpoint = "foo" + options = client_options.ClientOptions( + client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint + ) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source( + options + ) + assert api_endpoint == mock_api_endpoint + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert doesn't exist. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", + return_value=False, + ): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert exists. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", + return_value=True, + ): + with mock.patch( + "google.auth.transport.mtls.default_client_cert_source", + return_value=mock_client_cert_source, + ): + ( + api_endpoint, + cert_source, + ) = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source == mock_client_cert_source + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError) as excinfo: + client_class.get_mtls_endpoint_and_cert_source() + + assert ( + str(excinfo.value) + == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + ) + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"} + ): + with pytest.raises(ValueError) as excinfo: + client_class.get_mtls_endpoint_and_cert_source() + + assert ( + str(excinfo.value) + == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + ) + + +@pytest.mark.parametrize( + "client_class", + [QuotaAdjusterSettingsManagerClient, QuotaAdjusterSettingsManagerAsyncClient], +) +@mock.patch.object( + QuotaAdjusterSettingsManagerClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(QuotaAdjusterSettingsManagerClient), +) +@mock.patch.object( + QuotaAdjusterSettingsManagerAsyncClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(QuotaAdjusterSettingsManagerAsyncClient), +) +def test_quota_adjuster_settings_manager_client_client_api_endpoint(client_class): + mock_client_cert_source = client_cert_source_callback + api_override = "foo.com" + default_universe = QuotaAdjusterSettingsManagerClient._DEFAULT_UNIVERSE + default_endpoint = ( + QuotaAdjusterSettingsManagerClient._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=default_universe + ) + ) + mock_universe = "bar.com" + mock_endpoint = ( + QuotaAdjusterSettingsManagerClient._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=mock_universe + ) + ) + + # If ClientOptions.api_endpoint is set and GOOGLE_API_USE_CLIENT_CERTIFICATE="true", + # use ClientOptions.api_endpoint as the api endpoint regardless. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch( + "google.auth.transport.requests.AuthorizedSession.configure_mtls_channel" + ): + options = client_options.ClientOptions( + client_cert_source=mock_client_cert_source, api_endpoint=api_override + ) + client = client_class( + client_options=options, + credentials=ga_credentials.AnonymousCredentials(), + ) + assert client.api_endpoint == api_override + + # If ClientOptions.api_endpoint is not set and GOOGLE_API_USE_MTLS_ENDPOINT="never", + # use the _DEFAULT_ENDPOINT_TEMPLATE populated with GDU as the api endpoint. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + client = client_class(credentials=ga_credentials.AnonymousCredentials()) + assert client.api_endpoint == default_endpoint + + # If ClientOptions.api_endpoint is not set and GOOGLE_API_USE_MTLS_ENDPOINT="always", + # use the DEFAULT_MTLS_ENDPOINT as the api endpoint. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + client = client_class(credentials=ga_credentials.AnonymousCredentials()) + assert client.api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + + # If ClientOptions.api_endpoint is not set, GOOGLE_API_USE_MTLS_ENDPOINT="auto" (default), + # GOOGLE_API_USE_CLIENT_CERTIFICATE="false" (default), default cert source doesn't exist, + # and ClientOptions.universe_domain="bar.com", + # use the _DEFAULT_ENDPOINT_TEMPLATE populated with universe domain as the api endpoint. + options = client_options.ClientOptions() + universe_exists = hasattr(options, "universe_domain") + if universe_exists: + options = client_options.ClientOptions(universe_domain=mock_universe) + client = client_class( + client_options=options, credentials=ga_credentials.AnonymousCredentials() + ) + else: + client = client_class( + client_options=options, credentials=ga_credentials.AnonymousCredentials() + ) + assert client.api_endpoint == ( + mock_endpoint if universe_exists else default_endpoint + ) + assert client.universe_domain == ( + mock_universe if universe_exists else default_universe + ) + + # If ClientOptions does not have a universe domain attribute and GOOGLE_API_USE_MTLS_ENDPOINT="never", + # use the _DEFAULT_ENDPOINT_TEMPLATE populated with GDU as the api endpoint. + options = client_options.ClientOptions() + if hasattr(options, "universe_domain"): + delattr(options, "universe_domain") + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + client = client_class( + client_options=options, credentials=ga_credentials.AnonymousCredentials() + ) + assert client.api_endpoint == default_endpoint + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name", + [ + ( + QuotaAdjusterSettingsManagerClient, + transports.QuotaAdjusterSettingsManagerGrpcTransport, + "grpc", + ), + ( + QuotaAdjusterSettingsManagerAsyncClient, + transports.QuotaAdjusterSettingsManagerGrpcAsyncIOTransport, + "grpc_asyncio", + ), + ( + QuotaAdjusterSettingsManagerClient, + transports.QuotaAdjusterSettingsManagerRestTransport, + "rest", + ), + ], +) +def test_quota_adjuster_settings_manager_client_client_options_scopes( + client_class, transport_class, transport_name +): + # Check the case scopes are provided. + options = client_options.ClientOptions( + scopes=["1", "2"], + ) + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=["1", "2"], + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name,grpc_helpers", + [ + ( + QuotaAdjusterSettingsManagerClient, + transports.QuotaAdjusterSettingsManagerGrpcTransport, + "grpc", + grpc_helpers, + ), + ( + QuotaAdjusterSettingsManagerAsyncClient, + transports.QuotaAdjusterSettingsManagerGrpcAsyncIOTransport, + "grpc_asyncio", + grpc_helpers_async, + ), + ( + QuotaAdjusterSettingsManagerClient, + transports.QuotaAdjusterSettingsManagerRestTransport, + "rest", + None, + ), + ], +) +def test_quota_adjuster_settings_manager_client_client_options_credentials_file( + client_class, transport_class, transport_name, grpc_helpers +): + # Check the case credentials file is provided. + options = client_options.ClientOptions(credentials_file="credentials.json") + + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +def test_quota_adjuster_settings_manager_client_client_options_from_dict(): + with mock.patch( + "google.cloud.cloudquotas_v1beta.services.quota_adjuster_settings_manager.transports.QuotaAdjusterSettingsManagerGrpcTransport.__init__" + ) as grpc_transport: + grpc_transport.return_value = None + client = QuotaAdjusterSettingsManagerClient( + client_options={"api_endpoint": "squid.clam.whelk"} + ) + grpc_transport.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name,grpc_helpers", + [ + ( + QuotaAdjusterSettingsManagerClient, + transports.QuotaAdjusterSettingsManagerGrpcTransport, + "grpc", + grpc_helpers, + ), + ( + QuotaAdjusterSettingsManagerAsyncClient, + transports.QuotaAdjusterSettingsManagerGrpcAsyncIOTransport, + "grpc_asyncio", + grpc_helpers_async, + ), + ], +) +def test_quota_adjuster_settings_manager_client_create_channel_credentials_file( + client_class, transport_class, transport_name, grpc_helpers +): + # Check the case credentials file is provided. + options = client_options.ClientOptions(credentials_file="credentials.json") + + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # test that the credentials from file are saved and used as the credentials. + with mock.patch.object( + google.auth, "load_credentials_from_file", autospec=True + ) as load_creds, mock.patch.object( + google.auth, "default", autospec=True + ) as adc, mock.patch.object( + grpc_helpers, "create_channel" + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + file_creds = ga_credentials.AnonymousCredentials() + load_creds.return_value = (file_creds, None) + adc.return_value = (creds, None) + client = client_class(client_options=options, transport=transport_name) + create_channel.assert_called_with( + "cloudquotas.googleapis.com:443", + credentials=file_creds, + credentials_file=None, + quota_project_id=None, + default_scopes=("https://www.googleapis.com/auth/cloud-platform",), + scopes=None, + default_host="cloudquotas.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize( + "request_type", + [ + gac_quota_adjuster_settings.UpdateQuotaAdjusterSettingsRequest, + dict, + ], +) +def test_update_quota_adjuster_settings(request_type, transport: str = "grpc"): + client = QuotaAdjusterSettingsManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_quota_adjuster_settings), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = gac_quota_adjuster_settings.QuotaAdjusterSettings( + name="name_value", + enablement=gac_quota_adjuster_settings.QuotaAdjusterSettings.Enablement.ENABLED, + etag="etag_value", + ) + response = client.update_quota_adjuster_settings(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = gac_quota_adjuster_settings.UpdateQuotaAdjusterSettingsRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, gac_quota_adjuster_settings.QuotaAdjusterSettings) + assert response.name == "name_value" + assert ( + response.enablement + == gac_quota_adjuster_settings.QuotaAdjusterSettings.Enablement.ENABLED + ) + assert response.etag == "etag_value" + + +def test_update_quota_adjuster_settings_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = QuotaAdjusterSettingsManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = gac_quota_adjuster_settings.UpdateQuotaAdjusterSettingsRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_quota_adjuster_settings), "__call__" + ) as call: + call.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client.update_quota_adjuster_settings(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert ( + args[0] == gac_quota_adjuster_settings.UpdateQuotaAdjusterSettingsRequest() + ) + + +def test_update_quota_adjuster_settings_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = QuotaAdjusterSettingsManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._transport.update_quota_adjuster_settings + in client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[ + client._transport.update_quota_adjuster_settings + ] = mock_rpc + request = {} + client.update_quota_adjuster_settings(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.update_quota_adjuster_settings(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +@pytest.mark.asyncio +async def test_update_quota_adjuster_settings_async_use_cached_wrapped_rpc( + transport: str = "grpc_asyncio", +): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = QuotaAdjusterSettingsManagerAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._client._transport.update_quota_adjuster_settings + in client._client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[ + client._client._transport.update_quota_adjuster_settings + ] = mock_rpc + + request = {} + await client.update_quota_adjuster_settings(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.update_quota_adjuster_settings(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +@pytest.mark.asyncio +async def test_update_quota_adjuster_settings_async( + transport: str = "grpc_asyncio", + request_type=gac_quota_adjuster_settings.UpdateQuotaAdjusterSettingsRequest, +): + client = QuotaAdjusterSettingsManagerAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_quota_adjuster_settings), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + gac_quota_adjuster_settings.QuotaAdjusterSettings( + name="name_value", + enablement=gac_quota_adjuster_settings.QuotaAdjusterSettings.Enablement.ENABLED, + etag="etag_value", + ) + ) + response = await client.update_quota_adjuster_settings(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = gac_quota_adjuster_settings.UpdateQuotaAdjusterSettingsRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, gac_quota_adjuster_settings.QuotaAdjusterSettings) + assert response.name == "name_value" + assert ( + response.enablement + == gac_quota_adjuster_settings.QuotaAdjusterSettings.Enablement.ENABLED + ) + assert response.etag == "etag_value" + + +@pytest.mark.asyncio +async def test_update_quota_adjuster_settings_async_from_dict(): + await test_update_quota_adjuster_settings_async(request_type=dict) + + +def test_update_quota_adjuster_settings_field_headers(): + client = QuotaAdjusterSettingsManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = gac_quota_adjuster_settings.UpdateQuotaAdjusterSettingsRequest() + + request.quota_adjuster_settings.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_quota_adjuster_settings), "__call__" + ) as call: + call.return_value = gac_quota_adjuster_settings.QuotaAdjusterSettings() + client.update_quota_adjuster_settings(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "quota_adjuster_settings.name=name_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_update_quota_adjuster_settings_field_headers_async(): + client = QuotaAdjusterSettingsManagerAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = gac_quota_adjuster_settings.UpdateQuotaAdjusterSettingsRequest() + + request.quota_adjuster_settings.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_quota_adjuster_settings), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + gac_quota_adjuster_settings.QuotaAdjusterSettings() + ) + await client.update_quota_adjuster_settings(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "quota_adjuster_settings.name=name_value", + ) in kw["metadata"] + + +def test_update_quota_adjuster_settings_flattened(): + client = QuotaAdjusterSettingsManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_quota_adjuster_settings), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = gac_quota_adjuster_settings.QuotaAdjusterSettings() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_quota_adjuster_settings( + quota_adjuster_settings=gac_quota_adjuster_settings.QuotaAdjusterSettings( + name="name_value" + ), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].quota_adjuster_settings + mock_val = gac_quota_adjuster_settings.QuotaAdjusterSettings(name="name_value") + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=["paths_value"]) + assert arg == mock_val + + +def test_update_quota_adjuster_settings_flattened_error(): + client = QuotaAdjusterSettingsManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.update_quota_adjuster_settings( + gac_quota_adjuster_settings.UpdateQuotaAdjusterSettingsRequest(), + quota_adjuster_settings=gac_quota_adjuster_settings.QuotaAdjusterSettings( + name="name_value" + ), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + +@pytest.mark.asyncio +async def test_update_quota_adjuster_settings_flattened_async(): + client = QuotaAdjusterSettingsManagerAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_quota_adjuster_settings), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = gac_quota_adjuster_settings.QuotaAdjusterSettings() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + gac_quota_adjuster_settings.QuotaAdjusterSettings() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_quota_adjuster_settings( + quota_adjuster_settings=gac_quota_adjuster_settings.QuotaAdjusterSettings( + name="name_value" + ), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].quota_adjuster_settings + mock_val = gac_quota_adjuster_settings.QuotaAdjusterSettings(name="name_value") + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=["paths_value"]) + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_update_quota_adjuster_settings_flattened_error_async(): + client = QuotaAdjusterSettingsManagerAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.update_quota_adjuster_settings( + gac_quota_adjuster_settings.UpdateQuotaAdjusterSettingsRequest(), + quota_adjuster_settings=gac_quota_adjuster_settings.QuotaAdjusterSettings( + name="name_value" + ), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + +@pytest.mark.parametrize( + "request_type", + [ + quota_adjuster_settings.GetQuotaAdjusterSettingsRequest, + dict, + ], +) +def test_get_quota_adjuster_settings(request_type, transport: str = "grpc"): + client = QuotaAdjusterSettingsManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_quota_adjuster_settings), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = quota_adjuster_settings.QuotaAdjusterSettings( + name="name_value", + enablement=quota_adjuster_settings.QuotaAdjusterSettings.Enablement.ENABLED, + etag="etag_value", + ) + response = client.get_quota_adjuster_settings(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = quota_adjuster_settings.GetQuotaAdjusterSettingsRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, quota_adjuster_settings.QuotaAdjusterSettings) + assert response.name == "name_value" + assert ( + response.enablement + == quota_adjuster_settings.QuotaAdjusterSettings.Enablement.ENABLED + ) + assert response.etag == "etag_value" + + +def test_get_quota_adjuster_settings_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = QuotaAdjusterSettingsManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = quota_adjuster_settings.GetQuotaAdjusterSettingsRequest( + name="name_value", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_quota_adjuster_settings), "__call__" + ) as call: + call.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client.get_quota_adjuster_settings(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == quota_adjuster_settings.GetQuotaAdjusterSettingsRequest( + name="name_value", + ) + + +def test_get_quota_adjuster_settings_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = QuotaAdjusterSettingsManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._transport.get_quota_adjuster_settings + in client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[ + client._transport.get_quota_adjuster_settings + ] = mock_rpc + request = {} + client.get_quota_adjuster_settings(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.get_quota_adjuster_settings(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +@pytest.mark.asyncio +async def test_get_quota_adjuster_settings_async_use_cached_wrapped_rpc( + transport: str = "grpc_asyncio", +): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = QuotaAdjusterSettingsManagerAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._client._transport.get_quota_adjuster_settings + in client._client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[ + client._client._transport.get_quota_adjuster_settings + ] = mock_rpc + + request = {} + await client.get_quota_adjuster_settings(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.get_quota_adjuster_settings(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +@pytest.mark.asyncio +async def test_get_quota_adjuster_settings_async( + transport: str = "grpc_asyncio", + request_type=quota_adjuster_settings.GetQuotaAdjusterSettingsRequest, +): + client = QuotaAdjusterSettingsManagerAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_quota_adjuster_settings), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + quota_adjuster_settings.QuotaAdjusterSettings( + name="name_value", + enablement=quota_adjuster_settings.QuotaAdjusterSettings.Enablement.ENABLED, + etag="etag_value", + ) + ) + response = await client.get_quota_adjuster_settings(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = quota_adjuster_settings.GetQuotaAdjusterSettingsRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, quota_adjuster_settings.QuotaAdjusterSettings) + assert response.name == "name_value" + assert ( + response.enablement + == quota_adjuster_settings.QuotaAdjusterSettings.Enablement.ENABLED + ) + assert response.etag == "etag_value" + + +@pytest.mark.asyncio +async def test_get_quota_adjuster_settings_async_from_dict(): + await test_get_quota_adjuster_settings_async(request_type=dict) + + +def test_get_quota_adjuster_settings_field_headers(): + client = QuotaAdjusterSettingsManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = quota_adjuster_settings.GetQuotaAdjusterSettingsRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_quota_adjuster_settings), "__call__" + ) as call: + call.return_value = quota_adjuster_settings.QuotaAdjusterSettings() + client.get_quota_adjuster_settings(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_get_quota_adjuster_settings_field_headers_async(): + client = QuotaAdjusterSettingsManagerAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = quota_adjuster_settings.GetQuotaAdjusterSettingsRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_quota_adjuster_settings), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + quota_adjuster_settings.QuotaAdjusterSettings() + ) + await client.get_quota_adjuster_settings(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name_value", + ) in kw["metadata"] + + +def test_get_quota_adjuster_settings_flattened(): + client = QuotaAdjusterSettingsManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_quota_adjuster_settings), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = quota_adjuster_settings.QuotaAdjusterSettings() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_quota_adjuster_settings( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +def test_get_quota_adjuster_settings_flattened_error(): + client = QuotaAdjusterSettingsManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_quota_adjuster_settings( + quota_adjuster_settings.GetQuotaAdjusterSettingsRequest(), + name="name_value", + ) + + +@pytest.mark.asyncio +async def test_get_quota_adjuster_settings_flattened_async(): + client = QuotaAdjusterSettingsManagerAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_quota_adjuster_settings), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = quota_adjuster_settings.QuotaAdjusterSettings() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + quota_adjuster_settings.QuotaAdjusterSettings() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_quota_adjuster_settings( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_get_quota_adjuster_settings_flattened_error_async(): + client = QuotaAdjusterSettingsManagerAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_quota_adjuster_settings( + quota_adjuster_settings.GetQuotaAdjusterSettingsRequest(), + name="name_value", + ) + + +def test_update_quota_adjuster_settings_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = QuotaAdjusterSettingsManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._transport.update_quota_adjuster_settings + in client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[ + client._transport.update_quota_adjuster_settings + ] = mock_rpc + + request = {} + client.update_quota_adjuster_settings(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.update_quota_adjuster_settings(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_update_quota_adjuster_settings_rest_required_fields( + request_type=gac_quota_adjuster_settings.UpdateQuotaAdjusterSettingsRequest, +): + transport_class = transports.QuotaAdjusterSettingsManagerRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson(pb_request, use_integers_for_enums=False) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).update_quota_adjuster_settings._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).update_quota_adjuster_settings._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "update_mask", + "validate_only", + ) + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = QuotaAdjusterSettingsManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = gac_quota_adjuster_settings.QuotaAdjusterSettings() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "patch", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = gac_quota_adjuster_settings.QuotaAdjusterSettings.pb( + return_value + ) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.update_quota_adjuster_settings(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_update_quota_adjuster_settings_rest_unset_required_fields(): + transport = transports.QuotaAdjusterSettingsManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.update_quota_adjuster_settings._get_unset_required_fields( + {} + ) + assert set(unset_fields) == ( + set( + ( + "updateMask", + "validateOnly", + ) + ) + & set(("quotaAdjusterSettings",)) + ) + + +def test_update_quota_adjuster_settings_rest_flattened(): + client = QuotaAdjusterSettingsManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = gac_quota_adjuster_settings.QuotaAdjusterSettings() + + # get arguments that satisfy an http rule for this method + sample_request = { + "quota_adjuster_settings": { + "name": "projects/sample1/locations/sample2/quotaAdjusterSettings" + } + } + + # get truthy value for each flattened field + mock_args = dict( + quota_adjuster_settings=gac_quota_adjuster_settings.QuotaAdjusterSettings( + name="name_value" + ), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = gac_quota_adjuster_settings.QuotaAdjusterSettings.pb( + return_value + ) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.update_quota_adjuster_settings(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1beta/{quota_adjuster_settings.name=projects/*/locations/*/quotaAdjusterSettings}" + % client.transport._host, + args[1], + ) + + +def test_update_quota_adjuster_settings_rest_flattened_error(transport: str = "rest"): + client = QuotaAdjusterSettingsManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.update_quota_adjuster_settings( + gac_quota_adjuster_settings.UpdateQuotaAdjusterSettingsRequest(), + quota_adjuster_settings=gac_quota_adjuster_settings.QuotaAdjusterSettings( + name="name_value" + ), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + +def test_get_quota_adjuster_settings_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = QuotaAdjusterSettingsManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._transport.get_quota_adjuster_settings + in client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[ + client._transport.get_quota_adjuster_settings + ] = mock_rpc + + request = {} + client.get_quota_adjuster_settings(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.get_quota_adjuster_settings(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_get_quota_adjuster_settings_rest_required_fields( + request_type=quota_adjuster_settings.GetQuotaAdjusterSettingsRequest, +): + transport_class = transports.QuotaAdjusterSettingsManagerRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson(pb_request, use_integers_for_enums=False) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).get_quota_adjuster_settings._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).get_quota_adjuster_settings._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + + client = QuotaAdjusterSettingsManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = quota_adjuster_settings.QuotaAdjusterSettings() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = quota_adjuster_settings.QuotaAdjusterSettings.pb( + return_value + ) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.get_quota_adjuster_settings(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_get_quota_adjuster_settings_rest_unset_required_fields(): + transport = transports.QuotaAdjusterSettingsManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.get_quota_adjuster_settings._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name",))) + + +def test_get_quota_adjuster_settings_rest_flattened(): + client = QuotaAdjusterSettingsManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = quota_adjuster_settings.QuotaAdjusterSettings() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "projects/sample1/locations/sample2/quotaAdjusterSettings" + } + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = quota_adjuster_settings.QuotaAdjusterSettings.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.get_quota_adjuster_settings(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v1beta/{name=projects/*/locations/*/quotaAdjusterSettings}" + % client.transport._host, + args[1], + ) + + +def test_get_quota_adjuster_settings_rest_flattened_error(transport: str = "rest"): + client = QuotaAdjusterSettingsManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_quota_adjuster_settings( + quota_adjuster_settings.GetQuotaAdjusterSettingsRequest(), + name="name_value", + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.QuotaAdjusterSettingsManagerGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = QuotaAdjusterSettingsManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.QuotaAdjusterSettingsManagerGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = QuotaAdjusterSettingsManagerClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.QuotaAdjusterSettingsManagerGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = QuotaAdjusterSettingsManagerClient( + client_options=options, + transport=transport, + ) + + # It is an error to provide an api_key and a credential. + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = QuotaAdjusterSettingsManagerClient( + client_options=options, credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.QuotaAdjusterSettingsManagerGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = QuotaAdjusterSettingsManagerClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.QuotaAdjusterSettingsManagerGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = QuotaAdjusterSettingsManagerClient(transport=transport) + assert client.transport is transport + + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.QuotaAdjusterSettingsManagerGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.QuotaAdjusterSettingsManagerGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.QuotaAdjusterSettingsManagerGrpcTransport, + transports.QuotaAdjusterSettingsManagerGrpcAsyncIOTransport, + transports.QuotaAdjusterSettingsManagerRestTransport, + ], +) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, "default") as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + + +def test_transport_kind_grpc(): + transport = QuotaAdjusterSettingsManagerClient.get_transport_class("grpc")( + credentials=ga_credentials.AnonymousCredentials() + ) + assert transport.kind == "grpc" + + +def test_initialize_client_w_grpc(): + client = QuotaAdjusterSettingsManagerClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc" + ) + assert client is not None + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_update_quota_adjuster_settings_empty_call_grpc(): + client = QuotaAdjusterSettingsManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.update_quota_adjuster_settings), "__call__" + ) as call: + call.return_value = gac_quota_adjuster_settings.QuotaAdjusterSettings() + client.update_quota_adjuster_settings(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = gac_quota_adjuster_settings.UpdateQuotaAdjusterSettingsRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_get_quota_adjuster_settings_empty_call_grpc(): + client = QuotaAdjusterSettingsManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.get_quota_adjuster_settings), "__call__" + ) as call: + call.return_value = quota_adjuster_settings.QuotaAdjusterSettings() + client.get_quota_adjuster_settings(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = quota_adjuster_settings.GetQuotaAdjusterSettingsRequest() + + assert args[0] == request_msg + + +def test_transport_kind_grpc_asyncio(): + transport = QuotaAdjusterSettingsManagerAsyncClient.get_transport_class( + "grpc_asyncio" + )(credentials=async_anonymous_credentials()) + assert transport.kind == "grpc_asyncio" + + +def test_initialize_client_w_grpc_asyncio(): + client = QuotaAdjusterSettingsManagerAsyncClient( + credentials=async_anonymous_credentials(), transport="grpc_asyncio" + ) + assert client is not None + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_update_quota_adjuster_settings_empty_call_grpc_asyncio(): + client = QuotaAdjusterSettingsManagerAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.update_quota_adjuster_settings), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + gac_quota_adjuster_settings.QuotaAdjusterSettings( + name="name_value", + enablement=gac_quota_adjuster_settings.QuotaAdjusterSettings.Enablement.ENABLED, + etag="etag_value", + ) + ) + await client.update_quota_adjuster_settings(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = gac_quota_adjuster_settings.UpdateQuotaAdjusterSettingsRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_get_quota_adjuster_settings_empty_call_grpc_asyncio(): + client = QuotaAdjusterSettingsManagerAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.get_quota_adjuster_settings), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + quota_adjuster_settings.QuotaAdjusterSettings( + name="name_value", + enablement=quota_adjuster_settings.QuotaAdjusterSettings.Enablement.ENABLED, + etag="etag_value", + ) + ) + await client.get_quota_adjuster_settings(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = quota_adjuster_settings.GetQuotaAdjusterSettingsRequest() + + assert args[0] == request_msg + + +def test_transport_kind_rest(): + transport = QuotaAdjusterSettingsManagerClient.get_transport_class("rest")( + credentials=ga_credentials.AnonymousCredentials() + ) + assert transport.kind == "rest" + + +def test_update_quota_adjuster_settings_rest_bad_request( + request_type=gac_quota_adjuster_settings.UpdateQuotaAdjusterSettingsRequest, +): + client = QuotaAdjusterSettingsManagerClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + # send a request that will satisfy transcoding + request_init = { + "quota_adjuster_settings": { + "name": "projects/sample1/locations/sample2/quotaAdjusterSettings" + } + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = mock.Mock() + json_return_value = "" + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.update_quota_adjuster_settings(request) + + +@pytest.mark.parametrize( + "request_type", + [ + gac_quota_adjuster_settings.UpdateQuotaAdjusterSettingsRequest, + dict, + ], +) +def test_update_quota_adjuster_settings_rest_call_success(request_type): + client = QuotaAdjusterSettingsManagerClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = { + "quota_adjuster_settings": { + "name": "projects/sample1/locations/sample2/quotaAdjusterSettings" + } + } + request_init["quota_adjuster_settings"] = { + "name": "projects/sample1/locations/sample2/quotaAdjusterSettings", + "enablement": 2, + "update_time": {"seconds": 751, "nanos": 543}, + "etag": "etag_value", + } + # The version of a generated dependency at test runtime may differ from the version used during generation. + # Delete any fields which are not present in the current runtime dependency + # See https://github.com/googleapis/gapic-generator-python/issues/1748 + + # Determine if the message type is proto-plus or protobuf + test_field = ( + gac_quota_adjuster_settings.UpdateQuotaAdjusterSettingsRequest.meta.fields[ + "quota_adjuster_settings" + ] + ) + + def get_message_fields(field): + # Given a field which is a message (composite type), return a list with + # all the fields of the message. + # If the field is not a composite type, return an empty list. + message_fields = [] + + if hasattr(field, "message") and field.message: + is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") + + if is_field_type_proto_plus_type: + message_fields = field.message.meta.fields.values() + # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types + else: # pragma: NO COVER + message_fields = field.message.DESCRIPTOR.fields + return message_fields + + runtime_nested_fields = [ + (field.name, nested_field.name) + for field in get_message_fields(test_field) + for nested_field in get_message_fields(field) + ] + + subfields_not_in_runtime = [] + + # For each item in the sample request, create a list of sub fields which are not present at runtime + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for field, value in request_init[ + "quota_adjuster_settings" + ].items(): # pragma: NO COVER + result = None + is_repeated = False + # For repeated fields + if isinstance(value, list) and len(value): + is_repeated = True + result = value[0] + # For fields where the type is another message + if isinstance(value, dict): + result = value + + if result and hasattr(result, "keys"): + for subfield in result.keys(): + if (field, subfield) not in runtime_nested_fields: + subfields_not_in_runtime.append( + { + "field": field, + "subfield": subfield, + "is_repeated": is_repeated, + } + ) + + # Remove fields from the sample request which are not present in the runtime version of the dependency + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER + field = subfield_to_delete.get("field") + field_repeated = subfield_to_delete.get("is_repeated") + subfield = subfield_to_delete.get("subfield") + if subfield: + if field_repeated: + for i in range(0, len(request_init["quota_adjuster_settings"][field])): + del request_init["quota_adjuster_settings"][field][i][subfield] + else: + del request_init["quota_adjuster_settings"][field][subfield] + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = gac_quota_adjuster_settings.QuotaAdjusterSettings( + name="name_value", + enablement=gac_quota_adjuster_settings.QuotaAdjusterSettings.Enablement.ENABLED, + etag="etag_value", + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = gac_quota_adjuster_settings.QuotaAdjusterSettings.pb( + return_value + ) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.update_quota_adjuster_settings(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, gac_quota_adjuster_settings.QuotaAdjusterSettings) + assert response.name == "name_value" + assert ( + response.enablement + == gac_quota_adjuster_settings.QuotaAdjusterSettings.Enablement.ENABLED + ) + assert response.etag == "etag_value" + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_quota_adjuster_settings_rest_interceptors(null_interceptor): + transport = transports.QuotaAdjusterSettingsManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.QuotaAdjusterSettingsManagerRestInterceptor(), + ) + client = QuotaAdjusterSettingsManagerClient(transport=transport) + + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.QuotaAdjusterSettingsManagerRestInterceptor, + "post_update_quota_adjuster_settings", + ) as post, mock.patch.object( + transports.QuotaAdjusterSettingsManagerRestInterceptor, + "pre_update_quota_adjuster_settings", + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = gac_quota_adjuster_settings.UpdateQuotaAdjusterSettingsRequest.pb( + gac_quota_adjuster_settings.UpdateQuotaAdjusterSettingsRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = gac_quota_adjuster_settings.QuotaAdjusterSettings.to_json( + gac_quota_adjuster_settings.QuotaAdjusterSettings() + ) + req.return_value.content = return_value + + request = gac_quota_adjuster_settings.UpdateQuotaAdjusterSettingsRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = gac_quota_adjuster_settings.QuotaAdjusterSettings() + + client.update_quota_adjuster_settings( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_quota_adjuster_settings_rest_bad_request( + request_type=quota_adjuster_settings.GetQuotaAdjusterSettingsRequest, +): + client = QuotaAdjusterSettingsManagerClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/quotaAdjusterSettings"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = mock.Mock() + json_return_value = "" + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.get_quota_adjuster_settings(request) + + +@pytest.mark.parametrize( + "request_type", + [ + quota_adjuster_settings.GetQuotaAdjusterSettingsRequest, + dict, + ], +) +def test_get_quota_adjuster_settings_rest_call_success(request_type): + client = QuotaAdjusterSettingsManagerClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {"name": "projects/sample1/locations/sample2/quotaAdjusterSettings"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = quota_adjuster_settings.QuotaAdjusterSettings( + name="name_value", + enablement=quota_adjuster_settings.QuotaAdjusterSettings.Enablement.ENABLED, + etag="etag_value", + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = quota_adjuster_settings.QuotaAdjusterSettings.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.get_quota_adjuster_settings(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, quota_adjuster_settings.QuotaAdjusterSettings) + assert response.name == "name_value" + assert ( + response.enablement + == quota_adjuster_settings.QuotaAdjusterSettings.Enablement.ENABLED + ) + assert response.etag == "etag_value" + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_quota_adjuster_settings_rest_interceptors(null_interceptor): + transport = transports.QuotaAdjusterSettingsManagerRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.QuotaAdjusterSettingsManagerRestInterceptor(), + ) + client = QuotaAdjusterSettingsManagerClient(transport=transport) + + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.QuotaAdjusterSettingsManagerRestInterceptor, + "post_get_quota_adjuster_settings", + ) as post, mock.patch.object( + transports.QuotaAdjusterSettingsManagerRestInterceptor, + "pre_get_quota_adjuster_settings", + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = quota_adjuster_settings.GetQuotaAdjusterSettingsRequest.pb( + quota_adjuster_settings.GetQuotaAdjusterSettingsRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = quota_adjuster_settings.QuotaAdjusterSettings.to_json( + quota_adjuster_settings.QuotaAdjusterSettings() + ) + req.return_value.content = return_value + + request = quota_adjuster_settings.GetQuotaAdjusterSettingsRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = quota_adjuster_settings.QuotaAdjusterSettings() + + client.get_quota_adjuster_settings( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_initialize_client_w_rest(): + client = QuotaAdjusterSettingsManagerClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + assert client is not None + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_update_quota_adjuster_settings_empty_call_rest(): + client = QuotaAdjusterSettingsManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.update_quota_adjuster_settings), "__call__" + ) as call: + client.update_quota_adjuster_settings(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = gac_quota_adjuster_settings.UpdateQuotaAdjusterSettingsRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_get_quota_adjuster_settings_empty_call_rest(): + client = QuotaAdjusterSettingsManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.get_quota_adjuster_settings), "__call__" + ) as call: + client.get_quota_adjuster_settings(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = quota_adjuster_settings.GetQuotaAdjusterSettingsRequest() + + assert args[0] == request_msg + + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = QuotaAdjusterSettingsManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.QuotaAdjusterSettingsManagerGrpcTransport, + ) + + +def test_quota_adjuster_settings_manager_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.QuotaAdjusterSettingsManagerTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json", + ) + + +def test_quota_adjuster_settings_manager_base_transport(): + # Instantiate the base transport. + with mock.patch( + "google.cloud.cloudquotas_v1beta.services.quota_adjuster_settings_manager.transports.QuotaAdjusterSettingsManagerTransport.__init__" + ) as Transport: + Transport.return_value = None + transport = transports.QuotaAdjusterSettingsManagerTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + "update_quota_adjuster_settings", + "get_quota_adjuster_settings", + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + with pytest.raises(NotImplementedError): + transport.close() + + # Catch all for all remaining methods and properties + remainder = [ + "kind", + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +def test_quota_adjuster_settings_manager_base_transport_with_credentials_file(): + # Instantiate the base transport with a credentials file + with mock.patch.object( + google.auth, "load_credentials_from_file", autospec=True + ) as load_creds, mock.patch( + "google.cloud.cloudquotas_v1beta.services.quota_adjuster_settings_manager.transports.QuotaAdjusterSettingsManagerTransport._prep_wrapped_messages" + ) as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.QuotaAdjusterSettingsManagerTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with( + "credentials.json", + scopes=None, + default_scopes=("https://www.googleapis.com/auth/cloud-platform",), + quota_project_id="octopus", + ) + + +def test_quota_adjuster_settings_manager_base_transport_with_adc(): + # Test the default credentials are used if credentials and credentials_file are None. + with mock.patch.object(google.auth, "default", autospec=True) as adc, mock.patch( + "google.cloud.cloudquotas_v1beta.services.quota_adjuster_settings_manager.transports.QuotaAdjusterSettingsManagerTransport._prep_wrapped_messages" + ) as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.QuotaAdjusterSettingsManagerTransport() + adc.assert_called_once() + + +def test_quota_adjuster_settings_manager_auth_adc(): + # If no credentials are provided, we should use ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + QuotaAdjusterSettingsManagerClient() + adc.assert_called_once_with( + scopes=None, + default_scopes=("https://www.googleapis.com/auth/cloud-platform",), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.QuotaAdjusterSettingsManagerGrpcTransport, + transports.QuotaAdjusterSettingsManagerGrpcAsyncIOTransport, + ], +) +def test_quota_adjuster_settings_manager_transport_auth_adc(transport_class): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class(quota_project_id="octopus", scopes=["1", "2"]) + adc.assert_called_once_with( + scopes=["1", "2"], + default_scopes=("https://www.googleapis.com/auth/cloud-platform",), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.QuotaAdjusterSettingsManagerGrpcTransport, + transports.QuotaAdjusterSettingsManagerGrpcAsyncIOTransport, + transports.QuotaAdjusterSettingsManagerRestTransport, + ], +) +def test_quota_adjuster_settings_manager_transport_auth_gdch_credentials( + transport_class, +): + host = "https://language.com" + api_audience_tests = [None, "https://language2.com"] + api_audience_expect = [host, "https://language2.com"] + for t, e in zip(api_audience_tests, api_audience_expect): + with mock.patch.object(google.auth, "default", autospec=True) as adc: + gdch_mock = mock.MagicMock() + type(gdch_mock).with_gdch_audience = mock.PropertyMock( + return_value=gdch_mock + ) + adc.return_value = (gdch_mock, None) + transport_class(host=host, api_audience=t) + gdch_mock.with_gdch_audience.assert_called_once_with(e) + + +@pytest.mark.parametrize( + "transport_class,grpc_helpers", + [ + (transports.QuotaAdjusterSettingsManagerGrpcTransport, grpc_helpers), + ( + transports.QuotaAdjusterSettingsManagerGrpcAsyncIOTransport, + grpc_helpers_async, + ), + ], +) +def test_quota_adjuster_settings_manager_transport_create_channel( + transport_class, grpc_helpers +): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object( + google.auth, "default", autospec=True + ) as adc, mock.patch.object( + grpc_helpers, "create_channel", autospec=True + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + adc.return_value = (creds, None) + transport_class(quota_project_id="octopus", scopes=["1", "2"]) + + create_channel.assert_called_with( + "cloudquotas.googleapis.com:443", + credentials=creds, + credentials_file=None, + quota_project_id="octopus", + default_scopes=("https://www.googleapis.com/auth/cloud-platform",), + scopes=["1", "2"], + default_host="cloudquotas.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.QuotaAdjusterSettingsManagerGrpcTransport, + transports.QuotaAdjusterSettingsManagerGrpcAsyncIOTransport, + ], +) +def test_quota_adjuster_settings_manager_grpc_transport_client_cert_source_for_mtls( + transport_class, +): + cred = ga_credentials.AnonymousCredentials() + + # Check ssl_channel_credentials is used if provided. + with mock.patch.object(transport_class, "create_channel") as mock_create_channel: + mock_ssl_channel_creds = mock.Mock() + transport_class( + host="squid.clam.whelk", + credentials=cred, + ssl_channel_credentials=mock_ssl_channel_creds, + ) + mock_create_channel.assert_called_once_with( + "squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_channel_creds, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Check if ssl_channel_credentials is not provided, then client_cert_source_for_mtls + # is used. + with mock.patch.object(transport_class, "create_channel", return_value=mock.Mock()): + with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: + transport_class( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback, + ) + expected_cert, expected_key = client_cert_source_callback() + mock_ssl_cred.assert_called_once_with( + certificate_chain=expected_cert, private_key=expected_key + ) + + +def test_quota_adjuster_settings_manager_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch( + "google.auth.transport.requests.AuthorizedSession.configure_mtls_channel" + ) as mock_configure_mtls_channel: + transports.QuotaAdjusterSettingsManagerRestTransport( + credentials=cred, client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +@pytest.mark.parametrize( + "transport_name", + [ + "grpc", + "grpc_asyncio", + "rest", + ], +) +def test_quota_adjuster_settings_manager_host_no_port(transport_name): + client = QuotaAdjusterSettingsManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions( + api_endpoint="cloudquotas.googleapis.com" + ), + transport=transport_name, + ) + assert client.transport._host == ( + "cloudquotas.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://cloudquotas.googleapis.com" + ) + + +@pytest.mark.parametrize( + "transport_name", + [ + "grpc", + "grpc_asyncio", + "rest", + ], +) +def test_quota_adjuster_settings_manager_host_with_port(transport_name): + client = QuotaAdjusterSettingsManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions( + api_endpoint="cloudquotas.googleapis.com:8000" + ), + transport=transport_name, + ) + assert client.transport._host == ( + "cloudquotas.googleapis.com:8000" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://cloudquotas.googleapis.com:8000" + ) + + +@pytest.mark.parametrize( + "transport_name", + [ + "rest", + ], +) +def test_quota_adjuster_settings_manager_client_transport_session_collision( + transport_name, +): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = QuotaAdjusterSettingsManagerClient( + credentials=creds1, + transport=transport_name, + ) + client2 = QuotaAdjusterSettingsManagerClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.update_quota_adjuster_settings._session + session2 = client2.transport.update_quota_adjuster_settings._session + assert session1 != session2 + session1 = client1.transport.get_quota_adjuster_settings._session + session2 = client2.transport.get_quota_adjuster_settings._session + assert session1 != session2 + + +def test_quota_adjuster_settings_manager_grpc_transport_channel(): + channel = grpc.secure_channel("http://localhost/", grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.QuotaAdjusterSettingsManagerGrpcTransport( + host="squid.clam.whelk", + channel=channel, + ) + assert transport.grpc_channel == channel + assert transport._host == "squid.clam.whelk:443" + assert transport._ssl_channel_credentials == None + + +def test_quota_adjuster_settings_manager_grpc_asyncio_transport_channel(): + channel = aio.secure_channel("http://localhost/", grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.QuotaAdjusterSettingsManagerGrpcAsyncIOTransport( + host="squid.clam.whelk", + channel=channel, + ) + assert transport.grpc_channel == channel + assert transport._host == "squid.clam.whelk:443" + assert transport._ssl_channel_credentials == None + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize( + "transport_class", + [ + transports.QuotaAdjusterSettingsManagerGrpcTransport, + transports.QuotaAdjusterSettingsManagerGrpcAsyncIOTransport, + ], +) +def test_quota_adjuster_settings_manager_transport_channel_mtls_with_client_cert_source( + transport_class, +): + with mock.patch( + "grpc.ssl_channel_credentials", autospec=True + ) as grpc_ssl_channel_cred: + with mock.patch.object( + transport_class, "create_channel" + ) as grpc_create_channel: + mock_ssl_cred = mock.Mock() + grpc_ssl_channel_cred.return_value = mock_ssl_cred + + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + + cred = ga_credentials.AnonymousCredentials() + with pytest.warns(DeprecationWarning): + with mock.patch.object(google.auth, "default") as adc: + adc.return_value = (cred, None) + transport = transport_class( + host="squid.clam.whelk", + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=client_cert_source_callback, + ) + adc.assert_called_once() + + grpc_ssl_channel_cred.assert_called_once_with( + certificate_chain=b"cert bytes", private_key=b"key bytes" + ) + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + assert transport._ssl_channel_credentials == mock_ssl_cred + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize( + "transport_class", + [ + transports.QuotaAdjusterSettingsManagerGrpcTransport, + transports.QuotaAdjusterSettingsManagerGrpcAsyncIOTransport, + ], +) +def test_quota_adjuster_settings_manager_transport_channel_mtls_with_adc( + transport_class, +): + mock_ssl_cred = mock.Mock() + with mock.patch.multiple( + "google.auth.transport.grpc.SslCredentials", + __init__=mock.Mock(return_value=None), + ssl_credentials=mock.PropertyMock(return_value=mock_ssl_cred), + ): + with mock.patch.object( + transport_class, "create_channel" + ) as grpc_create_channel: + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + mock_cred = mock.Mock() + + with pytest.warns(DeprecationWarning): + transport = transport_class( + host="squid.clam.whelk", + credentials=mock_cred, + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=None, + ) + + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=mock_cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + + +def test_quota_adjuster_settings_path(): + project = "squid" + location = "clam" + expected = "projects/{project}/locations/{location}/quotaAdjusterSettings".format( + project=project, + location=location, + ) + actual = QuotaAdjusterSettingsManagerClient.quota_adjuster_settings_path( + project, location + ) + assert expected == actual + + +def test_parse_quota_adjuster_settings_path(): + expected = { + "project": "whelk", + "location": "octopus", + } + path = QuotaAdjusterSettingsManagerClient.quota_adjuster_settings_path(**expected) + + # Check that the path construction is reversible. + actual = QuotaAdjusterSettingsManagerClient.parse_quota_adjuster_settings_path(path) + assert expected == actual + + +def test_common_billing_account_path(): + billing_account = "oyster" + expected = "billingAccounts/{billing_account}".format( + billing_account=billing_account, + ) + actual = QuotaAdjusterSettingsManagerClient.common_billing_account_path( + billing_account + ) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "nudibranch", + } + path = QuotaAdjusterSettingsManagerClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = QuotaAdjusterSettingsManagerClient.parse_common_billing_account_path(path) + assert expected == actual + + +def test_common_folder_path(): + folder = "cuttlefish" + expected = "folders/{folder}".format( + folder=folder, + ) + actual = QuotaAdjusterSettingsManagerClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "mussel", + } + path = QuotaAdjusterSettingsManagerClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = QuotaAdjusterSettingsManagerClient.parse_common_folder_path(path) + assert expected == actual + + +def test_common_organization_path(): + organization = "winkle" + expected = "organizations/{organization}".format( + organization=organization, + ) + actual = QuotaAdjusterSettingsManagerClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "nautilus", + } + path = QuotaAdjusterSettingsManagerClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = QuotaAdjusterSettingsManagerClient.parse_common_organization_path(path) + assert expected == actual + + +def test_common_project_path(): + project = "scallop" + expected = "projects/{project}".format( + project=project, + ) + actual = QuotaAdjusterSettingsManagerClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "abalone", + } + path = QuotaAdjusterSettingsManagerClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = QuotaAdjusterSettingsManagerClient.parse_common_project_path(path) + assert expected == actual + + +def test_common_location_path(): + project = "squid" + location = "clam" + expected = "projects/{project}/locations/{location}".format( + project=project, + location=location, + ) + actual = QuotaAdjusterSettingsManagerClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "whelk", + "location": "octopus", + } + path = QuotaAdjusterSettingsManagerClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = QuotaAdjusterSettingsManagerClient.parse_common_location_path(path) + assert expected == actual + + +def test_client_with_default_client_info(): + client_info = gapic_v1.client_info.ClientInfo() + + with mock.patch.object( + transports.QuotaAdjusterSettingsManagerTransport, "_prep_wrapped_messages" + ) as prep: + client = QuotaAdjusterSettingsManagerClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object( + transports.QuotaAdjusterSettingsManagerTransport, "_prep_wrapped_messages" + ) as prep: + transport_class = QuotaAdjusterSettingsManagerClient.get_transport_class() + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + +def test_transport_close_grpc(): + client = QuotaAdjusterSettingsManagerClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc" + ) + with mock.patch.object( + type(getattr(client.transport, "_grpc_channel")), "close" + ) as close: + with client: + close.assert_not_called() + close.assert_called_once() + + +@pytest.mark.asyncio +async def test_transport_close_grpc_asyncio(): + client = QuotaAdjusterSettingsManagerAsyncClient( + credentials=async_anonymous_credentials(), transport="grpc_asyncio" + ) + with mock.patch.object( + type(getattr(client.transport, "_grpc_channel")), "close" + ) as close: + async with client: + close.assert_not_called() + close.assert_called_once() + + +def test_transport_close_rest(): + client = QuotaAdjusterSettingsManagerClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + with mock.patch.object( + type(getattr(client.transport, "_session")), "close" + ) as close: + with client: + close.assert_not_called() + close.assert_called_once() + + +def test_client_ctx(): + transports = [ + "rest", + "grpc", + ] + for transport in transports: + client = QuotaAdjusterSettingsManagerClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport + ) + # Test client calls underlying transport. + with mock.patch.object(type(client.transport), "close") as close: + close.assert_not_called() + with client: + pass + close.assert_called() + + +@pytest.mark.parametrize( + "client_class,transport_class", + [ + ( + QuotaAdjusterSettingsManagerClient, + transports.QuotaAdjusterSettingsManagerGrpcTransport, + ), + ( + QuotaAdjusterSettingsManagerAsyncClient, + transports.QuotaAdjusterSettingsManagerGrpcAsyncIOTransport, + ), + ], +) +def test_api_key_credentials(client_class, transport_class): + with mock.patch.object( + google.auth._default, "get_api_key_credentials", create=True + ) as get_api_key_credentials: + mock_cred = mock.Mock() + get_api_key_credentials.return_value = mock_cred + options = client_options.ClientOptions() + options.api_key = "api_key" + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=mock_cred, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + )