diff --git a/.librarian/state.yaml b/.librarian/state.yaml index addf1c7a7908..3cafe6829f5d 100644 --- a/.librarian/state.yaml +++ b/.librarian/state.yaml @@ -1182,7 +1182,7 @@ libraries: tag_format: '{id}-v{version}' - id: google-cloud-cloudsecuritycompliance version: 0.3.0 - last_generated_commit: 72e7439c8e7e9986cf1865e337fc7c64ca5bda1f + last_generated_commit: 97763d6efb2d35474e0363c254ee6994837a08fa apis: - path: google/cloud/cloudsecuritycompliance/v1 service_config: cloudsecuritycompliance_v1.yaml diff --git a/packages/google-cloud-cloudsecuritycompliance/.repo-metadata.json b/packages/google-cloud-cloudsecuritycompliance/.repo-metadata.json index c38f20636d37..a1bf1b7ff2f7 100644 --- a/packages/google-cloud-cloudsecuritycompliance/.repo-metadata.json +++ b/packages/google-cloud-cloudsecuritycompliance/.repo-metadata.json @@ -1,7 +1,7 @@ { "name": "google-cloud-cloudsecuritycompliance", "name_pretty": "Cloud Security Compliance API", - "api_description": "null ", + "api_description": "", "product_documentation": "https://cloud.google.com/security-command-center/docs/compliance-manager-overview", "client_documentation": "https://cloud.google.com/python/docs/reference/google-cloud-cloudsecuritycompliance/latest", "issue_tracker": "https://issuetracker.google.com/issues/new?component=1761967&template=0", @@ -13,4 +13,4 @@ "api_id": "cloudsecuritycompliance.googleapis.com", "default_version": "v1", "api_shortname": "cloudsecuritycompliance" -} \ No newline at end of file +} diff --git a/packages/google-cloud-cloudsecuritycompliance/README.rst b/packages/google-cloud-cloudsecuritycompliance/README.rst index a7ef9b9ab0e8..03efe1d74619 100644 --- a/packages/google-cloud-cloudsecuritycompliance/README.rst +++ b/packages/google-cloud-cloudsecuritycompliance/README.rst @@ -3,7 +3,7 @@ Python Client for Cloud Security Compliance API |preview| |pypi| |versions| -`Cloud Security Compliance API`_: null +`Cloud Security Compliance API`_: - `Client Library Documentation`_ - `Product Documentation`_ diff --git a/packages/google-cloud-cloudsecuritycompliance/docs/cloudsecuritycompliance_v1/monitoring.rst b/packages/google-cloud-cloudsecuritycompliance/docs/cloudsecuritycompliance_v1/monitoring.rst new file mode 100644 index 000000000000..4d9f179eb398 --- /dev/null +++ b/packages/google-cloud-cloudsecuritycompliance/docs/cloudsecuritycompliance_v1/monitoring.rst @@ -0,0 +1,10 @@ +Monitoring +---------------------------- + +.. automodule:: google.cloud.cloudsecuritycompliance_v1.services.monitoring + :members: + :inherited-members: + +.. automodule:: google.cloud.cloudsecuritycompliance_v1.services.monitoring.pagers + :members: + :inherited-members: diff --git a/packages/google-cloud-cloudsecuritycompliance/docs/cloudsecuritycompliance_v1/services_.rst b/packages/google-cloud-cloudsecuritycompliance/docs/cloudsecuritycompliance_v1/services_.rst index 80065d89c786..4b9aa6cfeb0c 100644 --- a/packages/google-cloud-cloudsecuritycompliance/docs/cloudsecuritycompliance_v1/services_.rst +++ b/packages/google-cloud-cloudsecuritycompliance/docs/cloudsecuritycompliance_v1/services_.rst @@ -7,3 +7,4 @@ Services for Google Cloud Cloudsecuritycompliance v1 API cm_enrollment_service config deployment + monitoring diff --git a/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance/__init__.py b/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance/__init__.py index 302f8b8c6666..b4c89c91615c 100644 --- a/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance/__init__.py +++ b/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance/__init__.py @@ -38,6 +38,12 @@ from google.cloud.cloudsecuritycompliance_v1.services.deployment.client import ( DeploymentClient, ) +from google.cloud.cloudsecuritycompliance_v1.services.monitoring.async_client import ( + MonitoringAsyncClient, +) +from google.cloud.cloudsecuritycompliance_v1.services.monitoring.client import ( + MonitoringClient, +) from google.cloud.cloudsecuritycompliance_v1.types.audit import ( BucketDestination, CloudControlAuditDetails, @@ -126,6 +132,30 @@ TargetResourceConfig, TargetResourceCreationConfig, ) +from google.cloud.cloudsecuritycompliance_v1.types.monitoring import ( + AggregatedComplianceReport, + AggregateFrameworkComplianceReportRequest, + AggregateFrameworkComplianceReportResponse, + CloudControlAssessmentDetails, + CloudControlReport, + ControlAssessmentDetails, + ControlComplianceSummary, + EvaluationState, + FetchFrameworkComplianceReportRequest, + FindingClass, + FindingSummary, + FrameworkComplianceReport, + FrameworkComplianceSummary, + ListControlComplianceSummariesRequest, + ListControlComplianceSummariesResponse, + ListFindingSummariesRequest, + ListFindingSummariesResponse, + ListFrameworkComplianceSummariesRequest, + ListFrameworkComplianceSummariesResponse, + ManualCloudControlAssessmentDetails, + SimilarControls, + TargetResourceDetails, +) __all__ = ( "AuditClient", @@ -136,6 +166,8 @@ "ConfigAsyncClient", "DeploymentClient", "DeploymentAsyncClient", + "MonitoringClient", + "MonitoringAsyncClient", "BucketDestination", "CloudControlAuditDetails", "CloudControlGroupAuditDetails", @@ -214,4 +246,26 @@ "TargetResourceConfig", "TargetResourceCreationConfig", "DeploymentState", + "AggregatedComplianceReport", + "AggregateFrameworkComplianceReportRequest", + "AggregateFrameworkComplianceReportResponse", + "CloudControlAssessmentDetails", + "CloudControlReport", + "ControlAssessmentDetails", + "ControlComplianceSummary", + "FetchFrameworkComplianceReportRequest", + "FindingSummary", + "FrameworkComplianceReport", + "FrameworkComplianceSummary", + "ListControlComplianceSummariesRequest", + "ListControlComplianceSummariesResponse", + "ListFindingSummariesRequest", + "ListFindingSummariesResponse", + "ListFrameworkComplianceSummariesRequest", + "ListFrameworkComplianceSummariesResponse", + "ManualCloudControlAssessmentDetails", + "SimilarControls", + "TargetResourceDetails", + "EvaluationState", + "FindingClass", ) diff --git a/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/__init__.py b/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/__init__.py index 60e3e13d2a7e..87e375596324 100644 --- a/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/__init__.py +++ b/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/__init__.py @@ -25,6 +25,7 @@ ) from .services.config import ConfigAsyncClient, ConfigClient from .services.deployment import DeploymentAsyncClient, DeploymentClient +from .services.monitoring import MonitoringAsyncClient, MonitoringClient from .types.audit import ( BucketDestination, CloudControlAuditDetails, @@ -113,12 +114,40 @@ TargetResourceConfig, TargetResourceCreationConfig, ) +from .types.monitoring import ( + AggregatedComplianceReport, + AggregateFrameworkComplianceReportRequest, + AggregateFrameworkComplianceReportResponse, + CloudControlAssessmentDetails, + CloudControlReport, + ControlAssessmentDetails, + ControlComplianceSummary, + EvaluationState, + FetchFrameworkComplianceReportRequest, + FindingClass, + FindingSummary, + FrameworkComplianceReport, + FrameworkComplianceSummary, + ListControlComplianceSummariesRequest, + ListControlComplianceSummariesResponse, + ListFindingSummariesRequest, + ListFindingSummariesResponse, + ListFrameworkComplianceSummariesRequest, + ListFrameworkComplianceSummariesResponse, + ManualCloudControlAssessmentDetails, + SimilarControls, + TargetResourceDetails, +) __all__ = ( "AuditAsyncClient", "CmEnrollmentServiceAsyncClient", "ConfigAsyncClient", "DeploymentAsyncClient", + "MonitoringAsyncClient", + "AggregateFrameworkComplianceReportRequest", + "AggregateFrameworkComplianceReportResponse", + "AggregatedComplianceReport", "AllowedValues", "AttributeSubstitutionRule", "AuditClient", @@ -128,6 +157,7 @@ "CalculateEffectiveCmEnrollmentRequest", "CalculateEffectiveCmEnrollmentResponse", "CloudControl", + "CloudControlAssessmentDetails", "CloudControlAuditDetails", "CloudControlCategory", "CloudControlDeployment", @@ -135,11 +165,14 @@ "CloudControlDetails", "CloudControlGroupAuditDetails", "CloudControlMetadata", + "CloudControlReport", "CloudProvider", "CmEnrollment", "CmEnrollmentServiceClient", "ComplianceState", "ConfigClient", + "ControlAssessmentDetails", + "ControlComplianceSummary", "ControlFamily", "CreateCloudControlRequest", "CreateFrameworkAuditRequest", @@ -151,13 +184,19 @@ "DeploymentClient", "DeploymentState", "EnforcementMode", + "EvaluationState", "EvidenceDetails", + "FetchFrameworkComplianceReportRequest", + "FindingClass", "FindingDetails", + "FindingSummary", "FolderCreationConfig", "Framework", "FrameworkAudit", "FrameworkAuditDestination", "FrameworkCategory", + "FrameworkComplianceReport", + "FrameworkComplianceSummary", "FrameworkDeployment", "FrameworkDeploymentReference", "FrameworkReference", @@ -173,12 +212,20 @@ "ListCloudControlDeploymentsResponse", "ListCloudControlsRequest", "ListCloudControlsResponse", + "ListControlComplianceSummariesRequest", + "ListControlComplianceSummariesResponse", + "ListFindingSummariesRequest", + "ListFindingSummariesResponse", "ListFrameworkAuditsRequest", "ListFrameworkAuditsResponse", + "ListFrameworkComplianceSummariesRequest", + "ListFrameworkComplianceSummariesResponse", "ListFrameworkDeploymentsRequest", "ListFrameworkDeploymentsResponse", "ListFrameworksRequest", "ListFrameworksResponse", + "ManualCloudControlAssessmentDetails", + "MonitoringClient", "ObservationDetails", "OperationMetadata", "ParamValue", @@ -193,9 +240,11 @@ "Rule", "RuleActionType", "Severity", + "SimilarControls", "StringList", "TargetResourceConfig", "TargetResourceCreationConfig", + "TargetResourceDetails", "TargetResourceType", "UpdateCloudControlRequest", "UpdateCmEnrollmentRequest", diff --git a/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/gapic_metadata.json b/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/gapic_metadata.json index cda696c6068c..91c3d80353af 100644 --- a/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/gapic_metadata.json +++ b/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/gapic_metadata.json @@ -410,6 +410,100 @@ } } } + }, + "Monitoring": { + "clients": { + "grpc": { + "libraryClient": "MonitoringClient", + "rpcs": { + "AggregateFrameworkComplianceReport": { + "methods": [ + "aggregate_framework_compliance_report" + ] + }, + "FetchFrameworkComplianceReport": { + "methods": [ + "fetch_framework_compliance_report" + ] + }, + "ListControlComplianceSummaries": { + "methods": [ + "list_control_compliance_summaries" + ] + }, + "ListFindingSummaries": { + "methods": [ + "list_finding_summaries" + ] + }, + "ListFrameworkComplianceSummaries": { + "methods": [ + "list_framework_compliance_summaries" + ] + } + } + }, + "grpc-async": { + "libraryClient": "MonitoringAsyncClient", + "rpcs": { + "AggregateFrameworkComplianceReport": { + "methods": [ + "aggregate_framework_compliance_report" + ] + }, + "FetchFrameworkComplianceReport": { + "methods": [ + "fetch_framework_compliance_report" + ] + }, + "ListControlComplianceSummaries": { + "methods": [ + "list_control_compliance_summaries" + ] + }, + "ListFindingSummaries": { + "methods": [ + "list_finding_summaries" + ] + }, + "ListFrameworkComplianceSummaries": { + "methods": [ + "list_framework_compliance_summaries" + ] + } + } + }, + "rest": { + "libraryClient": "MonitoringClient", + "rpcs": { + "AggregateFrameworkComplianceReport": { + "methods": [ + "aggregate_framework_compliance_report" + ] + }, + "FetchFrameworkComplianceReport": { + "methods": [ + "fetch_framework_compliance_report" + ] + }, + "ListControlComplianceSummaries": { + "methods": [ + "list_control_compliance_summaries" + ] + }, + "ListFindingSummaries": { + "methods": [ + "list_finding_summaries" + ] + }, + "ListFrameworkComplianceSummaries": { + "methods": [ + "list_framework_compliance_summaries" + ] + } + } + } + } } } } diff --git a/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/services/monitoring/__init__.py b/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/services/monitoring/__init__.py new file mode 100644 index 000000000000..e7c72c30d128 --- /dev/null +++ b/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/services/monitoring/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from .async_client import MonitoringAsyncClient +from .client import MonitoringClient + +__all__ = ( + "MonitoringClient", + "MonitoringAsyncClient", +) diff --git a/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/services/monitoring/async_client.py b/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/services/monitoring/async_client.py new file mode 100644 index 000000000000..915f2ac94bea --- /dev/null +++ b/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/services/monitoring/async_client.py @@ -0,0 +1,1270 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +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 +import google.protobuf + +from google.cloud.cloudsecuritycompliance_v1 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.cloud.location import locations_pb2 # type: ignore +from google.longrunning import operations_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore + +from google.cloud.cloudsecuritycompliance_v1.services.monitoring import pagers +from google.cloud.cloudsecuritycompliance_v1.types import common, monitoring + +from .client import MonitoringClient +from .transports.base import DEFAULT_CLIENT_INFO, MonitoringTransport +from .transports.grpc_asyncio import MonitoringGrpcAsyncIOTransport + +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 MonitoringAsyncClient: + """Service describing handlers for resources""" + + _client: MonitoringClient + + # Copy defaults from the synchronous client for use here. + # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead. + DEFAULT_ENDPOINT = MonitoringClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = MonitoringClient.DEFAULT_MTLS_ENDPOINT + _DEFAULT_ENDPOINT_TEMPLATE = MonitoringClient._DEFAULT_ENDPOINT_TEMPLATE + _DEFAULT_UNIVERSE = MonitoringClient._DEFAULT_UNIVERSE + + control_compliance_summary_path = staticmethod( + MonitoringClient.control_compliance_summary_path + ) + parse_control_compliance_summary_path = staticmethod( + MonitoringClient.parse_control_compliance_summary_path + ) + finding_summary_path = staticmethod(MonitoringClient.finding_summary_path) + parse_finding_summary_path = staticmethod( + MonitoringClient.parse_finding_summary_path + ) + framework_compliance_report_path = staticmethod( + MonitoringClient.framework_compliance_report_path + ) + parse_framework_compliance_report_path = staticmethod( + MonitoringClient.parse_framework_compliance_report_path + ) + framework_compliance_summary_path = staticmethod( + MonitoringClient.framework_compliance_summary_path + ) + parse_framework_compliance_summary_path = staticmethod( + MonitoringClient.parse_framework_compliance_summary_path + ) + common_billing_account_path = staticmethod( + MonitoringClient.common_billing_account_path + ) + parse_common_billing_account_path = staticmethod( + MonitoringClient.parse_common_billing_account_path + ) + common_folder_path = staticmethod(MonitoringClient.common_folder_path) + parse_common_folder_path = staticmethod(MonitoringClient.parse_common_folder_path) + common_organization_path = staticmethod(MonitoringClient.common_organization_path) + parse_common_organization_path = staticmethod( + MonitoringClient.parse_common_organization_path + ) + common_project_path = staticmethod(MonitoringClient.common_project_path) + parse_common_project_path = staticmethod(MonitoringClient.parse_common_project_path) + common_location_path = staticmethod(MonitoringClient.common_location_path) + parse_common_location_path = staticmethod( + MonitoringClient.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: + MonitoringAsyncClient: The constructed client. + """ + return MonitoringClient.from_service_account_info.__func__(MonitoringAsyncClient, 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: + MonitoringAsyncClient: The constructed client. + """ + return MonitoringClient.from_service_account_file.__func__(MonitoringAsyncClient, 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 MonitoringClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore + + @property + def transport(self) -> MonitoringTransport: + """Returns the transport used by the client instance. + + Returns: + MonitoringTransport: 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 = MonitoringClient.get_transport_class + + def __init__( + self, + *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Optional[ + Union[str, MonitoringTransport, Callable[..., MonitoringTransport]] + ] = "grpc_asyncio", + client_options: Optional[ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the monitoring 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,MonitoringTransport,Callable[..., MonitoringTransport]]]): + 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 MonitoringTransport 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 = MonitoringClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + ) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + std_logging.DEBUG + ): # pragma: NO COVER + _LOGGER.debug( + "Created client `google.cloud.cloudsecuritycompliance_v1.MonitoringAsyncClient`.", + extra={ + "serviceName": "google.cloud.cloudsecuritycompliance.v1.Monitoring", + "universeDomain": getattr( + self._client._transport._credentials, "universe_domain", "" + ), + "credentialsType": f"{type(self._client._transport._credentials).__module__}.{type(self._client._transport._credentials).__qualname__}", + "credentialsInfo": getattr( + self.transport._credentials, "get_cred_info", lambda: None + )(), + } + if hasattr(self._client._transport, "_credentials") + else { + "serviceName": "google.cloud.cloudsecuritycompliance.v1.Monitoring", + "credentialsType": None, + }, + ) + + async def list_framework_compliance_summaries( + self, + request: Optional[ + Union[monitoring.ListFrameworkComplianceSummariesRequest, 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.ListFrameworkComplianceSummariesAsyncPager: + r"""Lists the framework compliance summary for a given + scope. + + .. 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 cloudsecuritycompliance_v1 + + async def sample_list_framework_compliance_summaries(): + # Create a client + client = cloudsecuritycompliance_v1.MonitoringAsyncClient() + + # Initialize request argument(s) + request = cloudsecuritycompliance_v1.ListFrameworkComplianceSummariesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_framework_compliance_summaries(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.cloudsecuritycompliance_v1.types.ListFrameworkComplianceSummariesRequest, dict]]): + The request object. The request message for + [ListFrameworkComplianceSummariesRequest][google.cloud.cloudsecuritycompliance.v1.ListFrameworkComplianceSummariesRequest]. + parent (:class:`str`): + Required. The parent scope for the + framework compliance summary. + + 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.cloudsecuritycompliance_v1.services.monitoring.pagers.ListFrameworkComplianceSummariesAsyncPager: + The response message for + [ListFrameworkComplianceSummariesResponse][google.cloud.cloudsecuritycompliance.v1.ListFrameworkComplianceSummariesResponse]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # - Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + flattened_params = [parent] + has_flattened_params = ( + len([param for param in flattened_params if param is not None]) > 0 + ) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, monitoring.ListFrameworkComplianceSummariesRequest): + request = monitoring.ListFrameworkComplianceSummariesRequest(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_framework_compliance_summaries + ] + + # 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.ListFrameworkComplianceSummariesAsyncPager( + method=rpc, + request=request, + response=response, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def list_finding_summaries( + self, + request: Optional[Union[monitoring.ListFindingSummariesRequest, 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.ListFindingSummariesAsyncPager: + r"""Lists the finding summary by category for a given + scope. + + .. 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 cloudsecuritycompliance_v1 + + async def sample_list_finding_summaries(): + # Create a client + client = cloudsecuritycompliance_v1.MonitoringAsyncClient() + + # Initialize request argument(s) + request = cloudsecuritycompliance_v1.ListFindingSummariesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_finding_summaries(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.cloudsecuritycompliance_v1.types.ListFindingSummariesRequest, dict]]): + The request object. The request message for [ListFindingSummaries][]. + parent (:class:`str`): + Required. The parent scope for the + framework overview page. + + 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.cloudsecuritycompliance_v1.services.monitoring.pagers.ListFindingSummariesAsyncPager: + The response message for [ListFindingSummaries][]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # - Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + flattened_params = [parent] + has_flattened_params = ( + len([param for param in flattened_params if param is not None]) > 0 + ) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, monitoring.ListFindingSummariesRequest): + request = monitoring.ListFindingSummariesRequest(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_finding_summaries + ] + + # 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.ListFindingSummariesAsyncPager( + method=rpc, + request=request, + response=response, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def fetch_framework_compliance_report( + self, + request: Optional[ + Union[monitoring.FetchFrameworkComplianceReportRequest, 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]]] = (), + ) -> monitoring.FrameworkComplianceReport: + r"""Fetches the framework compliance report for a given + scope. + + .. 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 cloudsecuritycompliance_v1 + + async def sample_fetch_framework_compliance_report(): + # Create a client + client = cloudsecuritycompliance_v1.MonitoringAsyncClient() + + # Initialize request argument(s) + request = cloudsecuritycompliance_v1.FetchFrameworkComplianceReportRequest( + name="name_value", + ) + + # Make the request + response = await client.fetch_framework_compliance_report(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.cloudsecuritycompliance_v1.types.FetchFrameworkComplianceReportRequest, dict]]): + The request object. The request message for + [FetchFrameworkComplianceReport][]. + name (:class:`str`): + Required. The name of the framework + compliance report to retrieve. + + 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.cloudsecuritycompliance_v1.types.FrameworkComplianceReport: + The response message for + [GetFrameworkComplianceReport][]. + + """ + # Create or coerce a protobuf request object. + # - Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + flattened_params = [name] + has_flattened_params = ( + len([param for param in flattened_params if param is not None]) > 0 + ) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, monitoring.FetchFrameworkComplianceReportRequest): + request = monitoring.FetchFrameworkComplianceReportRequest(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.fetch_framework_compliance_report + ] + + # 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_control_compliance_summaries( + self, + request: Optional[ + Union[monitoring.ListControlComplianceSummariesRequest, 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.ListControlComplianceSummariesAsyncPager: + r"""Lists the control compliance summary for a given + scope. + + .. 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 cloudsecuritycompliance_v1 + + async def sample_list_control_compliance_summaries(): + # Create a client + client = cloudsecuritycompliance_v1.MonitoringAsyncClient() + + # Initialize request argument(s) + request = cloudsecuritycompliance_v1.ListControlComplianceSummariesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_control_compliance_summaries(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.cloud.cloudsecuritycompliance_v1.types.ListControlComplianceSummariesRequest, dict]]): + The request object. The request message for + [ListControlComplianceSummaries][]. + parent (:class:`str`): + Required. The parent scope for the + framework overview page. + + 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.cloudsecuritycompliance_v1.services.monitoring.pagers.ListControlComplianceSummariesAsyncPager: + The response message for + [ListControlComplianceSummaries][]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # - Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + flattened_params = [parent] + has_flattened_params = ( + len([param for param in flattened_params if param is not None]) > 0 + ) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, monitoring.ListControlComplianceSummariesRequest): + request = monitoring.ListControlComplianceSummariesRequest(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_control_compliance_summaries + ] + + # 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.ListControlComplianceSummariesAsyncPager( + method=rpc, + request=request, + response=response, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def aggregate_framework_compliance_report( + self, + request: Optional[ + Union[monitoring.AggregateFrameworkComplianceReportRequest, 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]]] = (), + ) -> monitoring.AggregateFrameworkComplianceReportResponse: + r"""Gets the aggregated compliance report over time for a + given scope. + + .. 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 cloudsecuritycompliance_v1 + + async def sample_aggregate_framework_compliance_report(): + # Create a client + client = cloudsecuritycompliance_v1.MonitoringAsyncClient() + + # Initialize request argument(s) + request = cloudsecuritycompliance_v1.AggregateFrameworkComplianceReportRequest( + name="name_value", + ) + + # Make the request + response = await client.aggregate_framework_compliance_report(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.cloudsecuritycompliance_v1.types.AggregateFrameworkComplianceReportRequest, dict]]): + The request object. The request message for + [AggregateFrameworkComplianceReport][]. + name (:class:`str`): + Required. The name of the aggregated compliance report + over time to retrieve. + + The supported format is: + ``organizations/{organization_id}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}`` + + 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.cloudsecuritycompliance_v1.types.AggregateFrameworkComplianceReportResponse: + The response message for + [AggregateFrameworkComplianceReport][]. + + """ + # Create or coerce a protobuf request object. + # - Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + flattened_params = [name] + has_flattened_params = ( + len([param for param in flattened_params if param is not None]) > 0 + ) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance( + request, monitoring.AggregateFrameworkComplianceReportRequest + ): + request = monitoring.AggregateFrameworkComplianceReportRequest(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.aggregate_framework_compliance_report + ] + + # 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_operations( + self, + request: Optional[operations_pb2.ListOperationsRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> operations_pb2.ListOperationsResponse: + r"""Lists operations that match the specified filter in the request. + + Args: + request (:class:`~.operations_pb2.ListOperationsRequest`): + The request object. Request message for + `ListOperations` method. + 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: + ~.operations_pb2.ListOperationsResponse: + Response message for ``ListOperations`` method. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.ListOperationsRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self.transport._wrapped_methods[self._client._transport.list_operations] + + # 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 get_operation( + self, + request: Optional[operations_pb2.GetOperationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> operations_pb2.Operation: + r"""Gets the latest state of a long-running operation. + + Args: + request (:class:`~.operations_pb2.GetOperationRequest`): + The request object. Request message for + `GetOperation` method. + 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: + ~.operations_pb2.Operation: + An ``Operation`` object. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.GetOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self.transport._wrapped_methods[self._client._transport.get_operation] + + # 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 delete_operation( + self, + request: Optional[operations_pb2.DeleteOperationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> None: + r"""Deletes a long-running operation. + + This method indicates that the client is no longer interested + in the operation result. It does not cancel the operation. + If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + + Args: + request (:class:`~.operations_pb2.DeleteOperationRequest`): + The request object. Request message for + `DeleteOperation` method. + 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: + None + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.DeleteOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self.transport._wrapped_methods[self._client._transport.delete_operation] + + # 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. + await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + async def cancel_operation( + self, + request: Optional[operations_pb2.CancelOperationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> None: + r"""Starts asynchronous cancellation on a long-running operation. + + The server makes a best effort to cancel the operation, but success + is not guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + + Args: + request (:class:`~.operations_pb2.CancelOperationRequest`): + The request object. Request message for + `CancelOperation` method. + 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: + None + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.CancelOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self.transport._wrapped_methods[self._client._transport.cancel_operation] + + # 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. + await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + async def get_location( + self, + request: Optional[locations_pb2.GetLocationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> locations_pb2.Location: + r"""Gets information about a location. + + Args: + request (:class:`~.location_pb2.GetLocationRequest`): + The request object. Request message for + `GetLocation` method. + 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: + ~.location_pb2.Location: + Location object. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = locations_pb2.GetLocationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self.transport._wrapped_methods[self._client._transport.get_location] + + # 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_locations( + self, + request: Optional[locations_pb2.ListLocationsRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> locations_pb2.ListLocationsResponse: + r"""Lists information about the supported locations for this service. + + Args: + request (:class:`~.location_pb2.ListLocationsRequest`): + The request object. Request message for + `ListLocations` method. + 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: + ~.location_pb2.ListLocationsResponse: + Response message for ``ListLocations`` method. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = locations_pb2.ListLocationsRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self.transport._wrapped_methods[self._client._transport.list_locations] + + # 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) -> "MonitoringAsyncClient": + return self + + async def __aexit__(self, exc_type, exc, tb): + await self.transport.close() + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=package_version.__version__ +) + +if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER + DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ + + +__all__ = ("MonitoringAsyncClient",) diff --git a/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/services/monitoring/client.py b/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/services/monitoring/client.py new file mode 100644 index 000000000000..ae294197466c --- /dev/null +++ b/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/services/monitoring/client.py @@ -0,0 +1,1757 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +from http import HTTPStatus +import json +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 +import google.protobuf + +from google.cloud.cloudsecuritycompliance_v1 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.cloud.location import locations_pb2 # type: ignore +from google.longrunning import operations_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore + +from google.cloud.cloudsecuritycompliance_v1.services.monitoring import pagers +from google.cloud.cloudsecuritycompliance_v1.types import common, monitoring + +from .transports.base import DEFAULT_CLIENT_INFO, MonitoringTransport +from .transports.grpc import MonitoringGrpcTransport +from .transports.grpc_asyncio import MonitoringGrpcAsyncIOTransport +from .transports.rest import MonitoringRestTransport + + +class MonitoringClientMeta(type): + """Metaclass for the Monitoring 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[MonitoringTransport]] + _transport_registry["grpc"] = MonitoringGrpcTransport + _transport_registry["grpc_asyncio"] = MonitoringGrpcAsyncIOTransport + _transport_registry["rest"] = MonitoringRestTransport + + def get_transport_class( + cls, + label: Optional[str] = None, + ) -> Type[MonitoringTransport]: + """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 MonitoringClient(metaclass=MonitoringClientMeta): + """Service describing handlers for resources""" + + @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 = "cloudsecuritycompliance.googleapis.com" + DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore + DEFAULT_ENDPOINT + ) + + _DEFAULT_ENDPOINT_TEMPLATE = "cloudsecuritycompliance.{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: + MonitoringClient: 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: + MonitoringClient: 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) -> MonitoringTransport: + """Returns the transport used by the client instance. + + Returns: + MonitoringTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def control_compliance_summary_path( + project: str, + location: str, + framework_compliance_report: str, + control_compliance_summary: str, + ) -> str: + """Returns a fully-qualified control_compliance_summary string.""" + return "projects/{project}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}/controlComplianceSummaries/{control_compliance_summary}".format( + project=project, + location=location, + framework_compliance_report=framework_compliance_report, + control_compliance_summary=control_compliance_summary, + ) + + @staticmethod + def parse_control_compliance_summary_path(path: str) -> Dict[str, str]: + """Parses a control_compliance_summary path into its component segments.""" + m = re.match( + r"^projects/(?P.+?)/locations/(?P.+?)/frameworkComplianceReports/(?P.+?)/controlComplianceSummaries/(?P.+?)$", + path, + ) + return m.groupdict() if m else {} + + @staticmethod + def finding_summary_path( + project: str, + location: str, + finding_summary: str, + ) -> str: + """Returns a fully-qualified finding_summary string.""" + return "projects/{project}/locations/{location}/findingSummaries/{finding_summary}".format( + project=project, + location=location, + finding_summary=finding_summary, + ) + + @staticmethod + def parse_finding_summary_path(path: str) -> Dict[str, str]: + """Parses a finding_summary path into its component segments.""" + m = re.match( + r"^projects/(?P.+?)/locations/(?P.+?)/findingSummaries/(?P.+?)$", + path, + ) + return m.groupdict() if m else {} + + @staticmethod + def framework_compliance_report_path( + project: str, + location: str, + framework_compliance_report: str, + ) -> str: + """Returns a fully-qualified framework_compliance_report string.""" + return "projects/{project}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}".format( + project=project, + location=location, + framework_compliance_report=framework_compliance_report, + ) + + @staticmethod + def parse_framework_compliance_report_path(path: str) -> Dict[str, str]: + """Parses a framework_compliance_report path into its component segments.""" + m = re.match( + r"^projects/(?P.+?)/locations/(?P.+?)/frameworkComplianceReports/(?P.+?)$", + path, + ) + return m.groupdict() if m else {} + + @staticmethod + def framework_compliance_summary_path( + project: str, + location: str, + framework_compliance_summary: str, + ) -> str: + """Returns a fully-qualified framework_compliance_summary string.""" + return "projects/{project}/locations/{location}/frameworkComplianceSummaries/{framework_compliance_summary}".format( + project=project, + location=location, + framework_compliance_summary=framework_compliance_summary, + ) + + @staticmethod + def parse_framework_compliance_summary_path(path: str) -> Dict[str, str]: + """Parses a framework_compliance_summary path into its component segments.""" + m = re.match( + r"^projects/(?P.+?)/locations/(?P.+?)/frameworkComplianceSummaries/(?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 = MonitoringClient._DEFAULT_UNIVERSE + if universe_domain != _default_universe: + raise MutualTLSChannelError( + f"mTLS is not supported in any universe other than {_default_universe}." + ) + api_endpoint = MonitoringClient.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = MonitoringClient._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 = MonitoringClient._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 + + def _add_cred_info_for_auth_errors( + self, error: core_exceptions.GoogleAPICallError + ) -> None: + """Adds credential info string to error details for 401/403/404 errors. + + Args: + error (google.api_core.exceptions.GoogleAPICallError): The error to add the cred info. + """ + if error.code not in [ + HTTPStatus.UNAUTHORIZED, + HTTPStatus.FORBIDDEN, + HTTPStatus.NOT_FOUND, + ]: + return + + cred = self._transport._credentials + + # get_cred_info is only available in google-auth>=2.35.0 + if not hasattr(cred, "get_cred_info"): + return + + # ignore the type check since pypy test fails when get_cred_info + # is not available + cred_info = cred.get_cred_info() # type: ignore + if cred_info and hasattr(error._details, "append"): + error._details.append(json.dumps(cred_info)) + + @property + def api_endpoint(self): + """Return the API endpoint used by the client instance. + + 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, MonitoringTransport, Callable[..., MonitoringTransport]] + ] = None, + client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the monitoring 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,MonitoringTransport,Callable[..., MonitoringTransport]]]): + 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 MonitoringTransport 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, + ) = MonitoringClient._read_environment_variables() + self._client_cert_source = MonitoringClient._get_client_cert_source( + self._client_options.client_cert_source, self._use_client_cert + ) + self._universe_domain = MonitoringClient._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, MonitoringTransport) + if transport_provided: + # transport is a MonitoringTransport 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(MonitoringTransport, transport) + self._api_endpoint = self._transport.host + + self._api_endpoint = self._api_endpoint or MonitoringClient._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[MonitoringTransport], Callable[..., MonitoringTransport] + ] = ( + MonitoringClient.get_transport_class(transport) + if isinstance(transport, str) or transport is None + else cast(Callable[..., MonitoringTransport], 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.cloud.cloudsecuritycompliance_v1.MonitoringClient`.", + extra={ + "serviceName": "google.cloud.cloudsecuritycompliance.v1.Monitoring", + "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.cloud.cloudsecuritycompliance.v1.Monitoring", + "credentialsType": None, + }, + ) + + def list_framework_compliance_summaries( + self, + request: Optional[ + Union[monitoring.ListFrameworkComplianceSummariesRequest, 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.ListFrameworkComplianceSummariesPager: + r"""Lists the framework compliance summary for a given + scope. + + .. 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 cloudsecuritycompliance_v1 + + def sample_list_framework_compliance_summaries(): + # Create a client + client = cloudsecuritycompliance_v1.MonitoringClient() + + # Initialize request argument(s) + request = cloudsecuritycompliance_v1.ListFrameworkComplianceSummariesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_framework_compliance_summaries(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.cloudsecuritycompliance_v1.types.ListFrameworkComplianceSummariesRequest, dict]): + The request object. The request message for + [ListFrameworkComplianceSummariesRequest][google.cloud.cloudsecuritycompliance.v1.ListFrameworkComplianceSummariesRequest]. + parent (str): + Required. The parent scope for the + framework compliance summary. + + 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.cloudsecuritycompliance_v1.services.monitoring.pagers.ListFrameworkComplianceSummariesPager: + The response message for + [ListFrameworkComplianceSummariesResponse][google.cloud.cloudsecuritycompliance.v1.ListFrameworkComplianceSummariesResponse]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # - Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + flattened_params = [parent] + has_flattened_params = ( + len([param for param in flattened_params if param is not None]) > 0 + ) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, monitoring.ListFrameworkComplianceSummariesRequest): + request = monitoring.ListFrameworkComplianceSummariesRequest(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_framework_compliance_summaries + ] + + # 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.ListFrameworkComplianceSummariesPager( + method=rpc, + request=request, + response=response, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def list_finding_summaries( + self, + request: Optional[Union[monitoring.ListFindingSummariesRequest, 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.ListFindingSummariesPager: + r"""Lists the finding summary by category for a given + scope. + + .. 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 cloudsecuritycompliance_v1 + + def sample_list_finding_summaries(): + # Create a client + client = cloudsecuritycompliance_v1.MonitoringClient() + + # Initialize request argument(s) + request = cloudsecuritycompliance_v1.ListFindingSummariesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_finding_summaries(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.cloudsecuritycompliance_v1.types.ListFindingSummariesRequest, dict]): + The request object. The request message for [ListFindingSummaries][]. + parent (str): + Required. The parent scope for the + framework overview page. + + 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.cloudsecuritycompliance_v1.services.monitoring.pagers.ListFindingSummariesPager: + The response message for [ListFindingSummaries][]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # - Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + flattened_params = [parent] + has_flattened_params = ( + len([param for param in flattened_params if param is not None]) > 0 + ) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, monitoring.ListFindingSummariesRequest): + request = monitoring.ListFindingSummariesRequest(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_finding_summaries] + + # 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.ListFindingSummariesPager( + method=rpc, + request=request, + response=response, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def fetch_framework_compliance_report( + self, + request: Optional[ + Union[monitoring.FetchFrameworkComplianceReportRequest, 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]]] = (), + ) -> monitoring.FrameworkComplianceReport: + r"""Fetches the framework compliance report for a given + scope. + + .. 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 cloudsecuritycompliance_v1 + + def sample_fetch_framework_compliance_report(): + # Create a client + client = cloudsecuritycompliance_v1.MonitoringClient() + + # Initialize request argument(s) + request = cloudsecuritycompliance_v1.FetchFrameworkComplianceReportRequest( + name="name_value", + ) + + # Make the request + response = client.fetch_framework_compliance_report(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.cloudsecuritycompliance_v1.types.FetchFrameworkComplianceReportRequest, dict]): + The request object. The request message for + [FetchFrameworkComplianceReport][]. + name (str): + Required. The name of the framework + compliance report to retrieve. + + 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.cloudsecuritycompliance_v1.types.FrameworkComplianceReport: + The response message for + [GetFrameworkComplianceReport][]. + + """ + # Create or coerce a protobuf request object. + # - Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + flattened_params = [name] + has_flattened_params = ( + len([param for param in flattened_params if param is not None]) > 0 + ) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, monitoring.FetchFrameworkComplianceReportRequest): + request = monitoring.FetchFrameworkComplianceReportRequest(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.fetch_framework_compliance_report + ] + + # 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_control_compliance_summaries( + self, + request: Optional[ + Union[monitoring.ListControlComplianceSummariesRequest, 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.ListControlComplianceSummariesPager: + r"""Lists the control compliance summary for a given + scope. + + .. 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 cloudsecuritycompliance_v1 + + def sample_list_control_compliance_summaries(): + # Create a client + client = cloudsecuritycompliance_v1.MonitoringClient() + + # Initialize request argument(s) + request = cloudsecuritycompliance_v1.ListControlComplianceSummariesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_control_compliance_summaries(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.cloudsecuritycompliance_v1.types.ListControlComplianceSummariesRequest, dict]): + The request object. The request message for + [ListControlComplianceSummaries][]. + parent (str): + Required. The parent scope for the + framework overview page. + + 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.cloudsecuritycompliance_v1.services.monitoring.pagers.ListControlComplianceSummariesPager: + The response message for + [ListControlComplianceSummaries][]. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # - Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + flattened_params = [parent] + has_flattened_params = ( + len([param for param in flattened_params if param is not None]) > 0 + ) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, monitoring.ListControlComplianceSummariesRequest): + request = monitoring.ListControlComplianceSummariesRequest(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_control_compliance_summaries + ] + + # 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.ListControlComplianceSummariesPager( + method=rpc, + request=request, + response=response, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def aggregate_framework_compliance_report( + self, + request: Optional[ + Union[monitoring.AggregateFrameworkComplianceReportRequest, 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]]] = (), + ) -> monitoring.AggregateFrameworkComplianceReportResponse: + r"""Gets the aggregated compliance report over time for a + given scope. + + .. 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 cloudsecuritycompliance_v1 + + def sample_aggregate_framework_compliance_report(): + # Create a client + client = cloudsecuritycompliance_v1.MonitoringClient() + + # Initialize request argument(s) + request = cloudsecuritycompliance_v1.AggregateFrameworkComplianceReportRequest( + name="name_value", + ) + + # Make the request + response = client.aggregate_framework_compliance_report(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.cloudsecuritycompliance_v1.types.AggregateFrameworkComplianceReportRequest, dict]): + The request object. The request message for + [AggregateFrameworkComplianceReport][]. + name (str): + Required. The name of the aggregated compliance report + over time to retrieve. + + The supported format is: + ``organizations/{organization_id}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}`` + + 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.cloudsecuritycompliance_v1.types.AggregateFrameworkComplianceReportResponse: + The response message for + [AggregateFrameworkComplianceReport][]. + + """ + # Create or coerce a protobuf request object. + # - Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + flattened_params = [name] + has_flattened_params = ( + len([param for param in flattened_params if param is not None]) > 0 + ) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance( + request, monitoring.AggregateFrameworkComplianceReportRequest + ): + request = monitoring.AggregateFrameworkComplianceReportRequest(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.aggregate_framework_compliance_report + ] + + # 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) -> "MonitoringClient": + 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() + + def list_operations( + self, + request: Optional[operations_pb2.ListOperationsRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> operations_pb2.ListOperationsResponse: + r"""Lists operations that match the specified filter in the request. + + Args: + request (:class:`~.operations_pb2.ListOperationsRequest`): + The request object. Request message for + `ListOperations` method. + 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: + ~.operations_pb2.ListOperationsResponse: + Response message for ``ListOperations`` method. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.ListOperationsRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.list_operations] + + # 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() + + try: + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + except core_exceptions.GoogleAPICallError as e: + self._add_cred_info_for_auth_errors(e) + raise e + + def get_operation( + self, + request: Optional[operations_pb2.GetOperationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> operations_pb2.Operation: + r"""Gets the latest state of a long-running operation. + + Args: + request (:class:`~.operations_pb2.GetOperationRequest`): + The request object. Request message for + `GetOperation` method. + 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: + ~.operations_pb2.Operation: + An ``Operation`` object. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.GetOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.get_operation] + + # 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() + + try: + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + except core_exceptions.GoogleAPICallError as e: + self._add_cred_info_for_auth_errors(e) + raise e + + def delete_operation( + self, + request: Optional[operations_pb2.DeleteOperationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> None: + r"""Deletes a long-running operation. + + This method indicates that the client is no longer interested + in the operation result. It does not cancel the operation. + If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + + Args: + request (:class:`~.operations_pb2.DeleteOperationRequest`): + The request object. Request message for + `DeleteOperation` method. + 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: + None + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.DeleteOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.delete_operation] + + # 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. + rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + def cancel_operation( + self, + request: Optional[operations_pb2.CancelOperationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> None: + r"""Starts asynchronous cancellation on a long-running operation. + + The server makes a best effort to cancel the operation, but success + is not guaranteed. If the server doesn't support this method, it returns + `google.rpc.Code.UNIMPLEMENTED`. + + Args: + request (:class:`~.operations_pb2.CancelOperationRequest`): + The request object. Request message for + `CancelOperation` method. + 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: + None + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.CancelOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.cancel_operation] + + # 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. + rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + def get_location( + self, + request: Optional[locations_pb2.GetLocationRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> locations_pb2.Location: + r"""Gets information about a location. + + Args: + request (:class:`~.location_pb2.GetLocationRequest`): + The request object. Request message for + `GetLocation` method. + 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: + ~.location_pb2.Location: + Location object. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = locations_pb2.GetLocationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.get_location] + + # 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() + + try: + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + except core_exceptions.GoogleAPICallError as e: + self._add_cred_info_for_auth_errors(e) + raise e + + def list_locations( + self, + request: Optional[locations_pb2.ListLocationsRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> locations_pb2.ListLocationsResponse: + r"""Lists information about the supported locations for this service. + + Args: + request (:class:`~.location_pb2.ListLocationsRequest`): + The request object. Request message for + `ListLocations` method. + 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: + ~.location_pb2.ListLocationsResponse: + Response message for ``ListLocations`` method. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = locations_pb2.ListLocationsRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.list_locations] + + # 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() + + try: + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + except core_exceptions.GoogleAPICallError as e: + self._add_cred_info_for_auth_errors(e) + raise e + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=package_version.__version__ +) + +if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER + DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ + +__all__ = ("MonitoringClient",) diff --git a/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/services/monitoring/pagers.py b/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/services/monitoring/pagers.py new file mode 100644 index 000000000000..ba0032ac4612 --- /dev/null +++ b/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/services/monitoring/pagers.py @@ -0,0 +1,517 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +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.cloudsecuritycompliance_v1.types import monitoring + + +class ListFrameworkComplianceSummariesPager: + """A pager for iterating through ``list_framework_compliance_summaries`` requests. + + This class thinly wraps an initial + :class:`google.cloud.cloudsecuritycompliance_v1.types.ListFrameworkComplianceSummariesResponse` object, and + provides an ``__iter__`` method to iterate through its + ``framework_compliance_summaries`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListFrameworkComplianceSummaries`` requests and continue to iterate + through the ``framework_compliance_summaries`` field on the + corresponding responses. + + All the usual :class:`google.cloud.cloudsecuritycompliance_v1.types.ListFrameworkComplianceSummariesResponse` + 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[..., monitoring.ListFrameworkComplianceSummariesResponse], + request: monitoring.ListFrameworkComplianceSummariesRequest, + response: monitoring.ListFrameworkComplianceSummariesResponse, + *, + 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.cloudsecuritycompliance_v1.types.ListFrameworkComplianceSummariesRequest): + The initial request object. + response (google.cloud.cloudsecuritycompliance_v1.types.ListFrameworkComplianceSummariesResponse): + 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 = monitoring.ListFrameworkComplianceSummariesRequest(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[monitoring.ListFrameworkComplianceSummariesResponse]: + 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[monitoring.FrameworkComplianceSummary]: + for page in self.pages: + yield from page.framework_compliance_summaries + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) + + +class ListFrameworkComplianceSummariesAsyncPager: + """A pager for iterating through ``list_framework_compliance_summaries`` requests. + + This class thinly wraps an initial + :class:`google.cloud.cloudsecuritycompliance_v1.types.ListFrameworkComplianceSummariesResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``framework_compliance_summaries`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListFrameworkComplianceSummaries`` requests and continue to iterate + through the ``framework_compliance_summaries`` field on the + corresponding responses. + + All the usual :class:`google.cloud.cloudsecuritycompliance_v1.types.ListFrameworkComplianceSummariesResponse` + 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[monitoring.ListFrameworkComplianceSummariesResponse] + ], + request: monitoring.ListFrameworkComplianceSummariesRequest, + response: monitoring.ListFrameworkComplianceSummariesResponse, + *, + 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.cloudsecuritycompliance_v1.types.ListFrameworkComplianceSummariesRequest): + The initial request object. + response (google.cloud.cloudsecuritycompliance_v1.types.ListFrameworkComplianceSummariesResponse): + 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 = monitoring.ListFrameworkComplianceSummariesRequest(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[monitoring.ListFrameworkComplianceSummariesResponse]: + 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[monitoring.FrameworkComplianceSummary]: + async def async_generator(): + async for page in self.pages: + for response in page.framework_compliance_summaries: + yield response + + return async_generator() + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) + + +class ListFindingSummariesPager: + """A pager for iterating through ``list_finding_summaries`` requests. + + This class thinly wraps an initial + :class:`google.cloud.cloudsecuritycompliance_v1.types.ListFindingSummariesResponse` object, and + provides an ``__iter__`` method to iterate through its + ``finding_summaries`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListFindingSummaries`` requests and continue to iterate + through the ``finding_summaries`` field on the + corresponding responses. + + All the usual :class:`google.cloud.cloudsecuritycompliance_v1.types.ListFindingSummariesResponse` + 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[..., monitoring.ListFindingSummariesResponse], + request: monitoring.ListFindingSummariesRequest, + response: monitoring.ListFindingSummariesResponse, + *, + 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.cloudsecuritycompliance_v1.types.ListFindingSummariesRequest): + The initial request object. + response (google.cloud.cloudsecuritycompliance_v1.types.ListFindingSummariesResponse): + 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 = monitoring.ListFindingSummariesRequest(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[monitoring.ListFindingSummariesResponse]: + 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[monitoring.FindingSummary]: + for page in self.pages: + yield from page.finding_summaries + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) + + +class ListFindingSummariesAsyncPager: + """A pager for iterating through ``list_finding_summaries`` requests. + + This class thinly wraps an initial + :class:`google.cloud.cloudsecuritycompliance_v1.types.ListFindingSummariesResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``finding_summaries`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListFindingSummaries`` requests and continue to iterate + through the ``finding_summaries`` field on the + corresponding responses. + + All the usual :class:`google.cloud.cloudsecuritycompliance_v1.types.ListFindingSummariesResponse` + 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[monitoring.ListFindingSummariesResponse]], + request: monitoring.ListFindingSummariesRequest, + response: monitoring.ListFindingSummariesResponse, + *, + 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.cloudsecuritycompliance_v1.types.ListFindingSummariesRequest): + The initial request object. + response (google.cloud.cloudsecuritycompliance_v1.types.ListFindingSummariesResponse): + 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 = monitoring.ListFindingSummariesRequest(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[monitoring.ListFindingSummariesResponse]: + 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[monitoring.FindingSummary]: + async def async_generator(): + async for page in self.pages: + for response in page.finding_summaries: + yield response + + return async_generator() + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) + + +class ListControlComplianceSummariesPager: + """A pager for iterating through ``list_control_compliance_summaries`` requests. + + This class thinly wraps an initial + :class:`google.cloud.cloudsecuritycompliance_v1.types.ListControlComplianceSummariesResponse` object, and + provides an ``__iter__`` method to iterate through its + ``control_compliance_summaries`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListControlComplianceSummaries`` requests and continue to iterate + through the ``control_compliance_summaries`` field on the + corresponding responses. + + All the usual :class:`google.cloud.cloudsecuritycompliance_v1.types.ListControlComplianceSummariesResponse` + 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[..., monitoring.ListControlComplianceSummariesResponse], + request: monitoring.ListControlComplianceSummariesRequest, + response: monitoring.ListControlComplianceSummariesResponse, + *, + 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.cloudsecuritycompliance_v1.types.ListControlComplianceSummariesRequest): + The initial request object. + response (google.cloud.cloudsecuritycompliance_v1.types.ListControlComplianceSummariesResponse): + 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 = monitoring.ListControlComplianceSummariesRequest(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[monitoring.ListControlComplianceSummariesResponse]: + 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[monitoring.ControlComplianceSummary]: + for page in self.pages: + yield from page.control_compliance_summaries + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) + + +class ListControlComplianceSummariesAsyncPager: + """A pager for iterating through ``list_control_compliance_summaries`` requests. + + This class thinly wraps an initial + :class:`google.cloud.cloudsecuritycompliance_v1.types.ListControlComplianceSummariesResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``control_compliance_summaries`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListControlComplianceSummaries`` requests and continue to iterate + through the ``control_compliance_summaries`` field on the + corresponding responses. + + All the usual :class:`google.cloud.cloudsecuritycompliance_v1.types.ListControlComplianceSummariesResponse` + 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[monitoring.ListControlComplianceSummariesResponse] + ], + request: monitoring.ListControlComplianceSummariesRequest, + response: monitoring.ListControlComplianceSummariesResponse, + *, + 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.cloudsecuritycompliance_v1.types.ListControlComplianceSummariesRequest): + The initial request object. + response (google.cloud.cloudsecuritycompliance_v1.types.ListControlComplianceSummariesResponse): + 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 = monitoring.ListControlComplianceSummariesRequest(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[monitoring.ListControlComplianceSummariesResponse]: + 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[monitoring.ControlComplianceSummary]: + async def async_generator(): + async for page in self.pages: + for response in page.control_compliance_summaries: + 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-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/services/monitoring/transports/README.rst b/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/services/monitoring/transports/README.rst new file mode 100644 index 000000000000..5c05c5143cb9 --- /dev/null +++ b/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/services/monitoring/transports/README.rst @@ -0,0 +1,9 @@ + +transport inheritance structure +_______________________________ + +`MonitoringTransport` is the ABC for all transports. +- public child `MonitoringGrpcTransport` for sync gRPC transport (defined in `grpc.py`). +- public child `MonitoringGrpcAsyncIOTransport` for async gRPC transport (defined in `grpc_asyncio.py`). +- private child `_BaseMonitoringRestTransport` for base REST transport with inner classes `_BaseMETHOD` (defined in `rest_base.py`). +- public child `MonitoringRestTransport` 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-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/services/monitoring/transports/__init__.py b/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/services/monitoring/transports/__init__.py new file mode 100644 index 000000000000..9274f35fea83 --- /dev/null +++ b/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/services/monitoring/transports/__init__.py @@ -0,0 +1,36 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +from typing import Dict, Type + +from .base import MonitoringTransport +from .grpc import MonitoringGrpcTransport +from .grpc_asyncio import MonitoringGrpcAsyncIOTransport +from .rest import MonitoringRestInterceptor, MonitoringRestTransport + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[MonitoringTransport]] +_transport_registry["grpc"] = MonitoringGrpcTransport +_transport_registry["grpc_asyncio"] = MonitoringGrpcAsyncIOTransport +_transport_registry["rest"] = MonitoringRestTransport + +__all__ = ( + "MonitoringTransport", + "MonitoringGrpcTransport", + "MonitoringGrpcAsyncIOTransport", + "MonitoringRestTransport", + "MonitoringRestInterceptor", +) diff --git a/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/services/monitoring/transports/base.py b/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/services/monitoring/transports/base.py new file mode 100644 index 000000000000..e16f6d086f2b --- /dev/null +++ b/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/services/monitoring/transports/base.py @@ -0,0 +1,368 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import 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.cloud.location import locations_pb2 # type: ignore +from google.longrunning import operations_pb2 # type: ignore +from google.oauth2 import service_account # type: ignore +import google.protobuf + +from google.cloud.cloudsecuritycompliance_v1 import gapic_version as package_version +from google.cloud.cloudsecuritycompliance_v1.types import monitoring + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=package_version.__version__ +) + +if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER + DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ + + +class MonitoringTransport(abc.ABC): + """Abstract transport class for Monitoring.""" + + AUTH_SCOPES = ("https://www.googleapis.com/auth/cloud-platform",) + + DEFAULT_HOST: str = "cloudsecuritycompliance.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: 'cloudsecuritycompliance.googleapis.com'). + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + credentials_file (Optional[str]): Deprecated. A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. This argument will be + removed in the next major version of this library. + 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_framework_compliance_summaries: gapic_v1.method.wrap_method( + self.list_framework_compliance_summaries, + 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_finding_summaries: gapic_v1.method.wrap_method( + self.list_finding_summaries, + 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.fetch_framework_compliance_report: gapic_v1.method.wrap_method( + self.fetch_framework_compliance_report, + 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_control_compliance_summaries: gapic_v1.method.wrap_method( + self.list_control_compliance_summaries, + 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.aggregate_framework_compliance_report: gapic_v1.method.wrap_method( + self.aggregate_framework_compliance_report, + 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_location: gapic_v1.method.wrap_method( + self.get_location, + default_timeout=None, + client_info=client_info, + ), + self.list_locations: gapic_v1.method.wrap_method( + self.list_locations, + default_timeout=None, + client_info=client_info, + ), + self.cancel_operation: gapic_v1.method.wrap_method( + self.cancel_operation, + default_timeout=None, + client_info=client_info, + ), + self.delete_operation: gapic_v1.method.wrap_method( + self.delete_operation, + default_timeout=None, + client_info=client_info, + ), + self.get_operation: gapic_v1.method.wrap_method( + self.get_operation, + default_timeout=None, + client_info=client_info, + ), + self.list_operations: gapic_v1.method.wrap_method( + self.list_operations, + default_timeout=None, + 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_framework_compliance_summaries( + self, + ) -> Callable[ + [monitoring.ListFrameworkComplianceSummariesRequest], + Union[ + monitoring.ListFrameworkComplianceSummariesResponse, + Awaitable[monitoring.ListFrameworkComplianceSummariesResponse], + ], + ]: + raise NotImplementedError() + + @property + def list_finding_summaries( + self, + ) -> Callable[ + [monitoring.ListFindingSummariesRequest], + Union[ + monitoring.ListFindingSummariesResponse, + Awaitable[monitoring.ListFindingSummariesResponse], + ], + ]: + raise NotImplementedError() + + @property + def fetch_framework_compliance_report( + self, + ) -> Callable[ + [monitoring.FetchFrameworkComplianceReportRequest], + Union[ + monitoring.FrameworkComplianceReport, + Awaitable[monitoring.FrameworkComplianceReport], + ], + ]: + raise NotImplementedError() + + @property + def list_control_compliance_summaries( + self, + ) -> Callable[ + [monitoring.ListControlComplianceSummariesRequest], + Union[ + monitoring.ListControlComplianceSummariesResponse, + Awaitable[monitoring.ListControlComplianceSummariesResponse], + ], + ]: + raise NotImplementedError() + + @property + def aggregate_framework_compliance_report( + self, + ) -> Callable[ + [monitoring.AggregateFrameworkComplianceReportRequest], + Union[ + monitoring.AggregateFrameworkComplianceReportResponse, + Awaitable[monitoring.AggregateFrameworkComplianceReportResponse], + ], + ]: + raise NotImplementedError() + + @property + def list_operations( + self, + ) -> Callable[ + [operations_pb2.ListOperationsRequest], + Union[ + operations_pb2.ListOperationsResponse, + Awaitable[operations_pb2.ListOperationsResponse], + ], + ]: + raise NotImplementedError() + + @property + def get_operation( + self, + ) -> Callable[ + [operations_pb2.GetOperationRequest], + Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]], + ]: + raise NotImplementedError() + + @property + def cancel_operation( + self, + ) -> Callable[[operations_pb2.CancelOperationRequest], None,]: + raise NotImplementedError() + + @property + def delete_operation( + self, + ) -> Callable[[operations_pb2.DeleteOperationRequest], None,]: + raise NotImplementedError() + + @property + def get_location( + self, + ) -> Callable[ + [locations_pb2.GetLocationRequest], + Union[locations_pb2.Location, Awaitable[locations_pb2.Location]], + ]: + raise NotImplementedError() + + @property + def list_locations( + self, + ) -> Callable[ + [locations_pb2.ListLocationsRequest], + Union[ + locations_pb2.ListLocationsResponse, + Awaitable[locations_pb2.ListLocationsResponse], + ], + ]: + raise NotImplementedError() + + @property + def kind(self) -> str: + raise NotImplementedError() + + +__all__ = ("MonitoringTransport",) diff --git a/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/services/monitoring/transports/grpc.py b/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/services/monitoring/transports/grpc.py new file mode 100644 index 000000000000..3ed517af1b0d --- /dev/null +++ b/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/services/monitoring/transports/grpc.py @@ -0,0 +1,602 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import 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.cloud.location import locations_pb2 # type: ignore +from google.longrunning import operations_pb2 # type: ignore +from google.protobuf.json_format import MessageToJson +import google.protobuf.message +import grpc # type: ignore +import proto # type: ignore + +from google.cloud.cloudsecuritycompliance_v1.types import monitoring + +from .base import DEFAULT_CLIENT_INFO, MonitoringTransport + +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.cloud.cloudsecuritycompliance.v1.Monitoring", + "rpcName": str(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.cloud.cloudsecuritycompliance.v1.Monitoring", + "rpcName": client_call_details.method, + "response": grpc_response, + "metadata": grpc_response["metadata"], + }, + ) + return response + + +class MonitoringGrpcTransport(MonitoringTransport): + """gRPC backend transport for Monitoring. + + Service describing handlers for resources + + 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 = "cloudsecuritycompliance.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: 'cloudsecuritycompliance.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]): Deprecated. 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. + This argument will be removed in the next major version of this library. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if 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 = "cloudsecuritycompliance.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]): Deprecated. A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. This argument will be + removed in the next major version of this library. + 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_framework_compliance_summaries( + self, + ) -> Callable[ + [monitoring.ListFrameworkComplianceSummariesRequest], + monitoring.ListFrameworkComplianceSummariesResponse, + ]: + r"""Return a callable for the list framework compliance + summaries method over gRPC. + + Lists the framework compliance summary for a given + scope. + + Returns: + Callable[[~.ListFrameworkComplianceSummariesRequest], + ~.ListFrameworkComplianceSummariesResponse]: + 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_framework_compliance_summaries" not in self._stubs: + self._stubs[ + "list_framework_compliance_summaries" + ] = self._logged_channel.unary_unary( + "/google.cloud.cloudsecuritycompliance.v1.Monitoring/ListFrameworkComplianceSummaries", + request_serializer=monitoring.ListFrameworkComplianceSummariesRequest.serialize, + response_deserializer=monitoring.ListFrameworkComplianceSummariesResponse.deserialize, + ) + return self._stubs["list_framework_compliance_summaries"] + + @property + def list_finding_summaries( + self, + ) -> Callable[ + [monitoring.ListFindingSummariesRequest], + monitoring.ListFindingSummariesResponse, + ]: + r"""Return a callable for the list finding summaries method over gRPC. + + Lists the finding summary by category for a given + scope. + + Returns: + Callable[[~.ListFindingSummariesRequest], + ~.ListFindingSummariesResponse]: + 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_finding_summaries" not in self._stubs: + self._stubs["list_finding_summaries"] = self._logged_channel.unary_unary( + "/google.cloud.cloudsecuritycompliance.v1.Monitoring/ListFindingSummaries", + request_serializer=monitoring.ListFindingSummariesRequest.serialize, + response_deserializer=monitoring.ListFindingSummariesResponse.deserialize, + ) + return self._stubs["list_finding_summaries"] + + @property + def fetch_framework_compliance_report( + self, + ) -> Callable[ + [monitoring.FetchFrameworkComplianceReportRequest], + monitoring.FrameworkComplianceReport, + ]: + r"""Return a callable for the fetch framework compliance + report method over gRPC. + + Fetches the framework compliance report for a given + scope. + + Returns: + Callable[[~.FetchFrameworkComplianceReportRequest], + ~.FrameworkComplianceReport]: + 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 "fetch_framework_compliance_report" not in self._stubs: + self._stubs[ + "fetch_framework_compliance_report" + ] = self._logged_channel.unary_unary( + "/google.cloud.cloudsecuritycompliance.v1.Monitoring/FetchFrameworkComplianceReport", + request_serializer=monitoring.FetchFrameworkComplianceReportRequest.serialize, + response_deserializer=monitoring.FrameworkComplianceReport.deserialize, + ) + return self._stubs["fetch_framework_compliance_report"] + + @property + def list_control_compliance_summaries( + self, + ) -> Callable[ + [monitoring.ListControlComplianceSummariesRequest], + monitoring.ListControlComplianceSummariesResponse, + ]: + r"""Return a callable for the list control compliance + summaries method over gRPC. + + Lists the control compliance summary for a given + scope. + + Returns: + Callable[[~.ListControlComplianceSummariesRequest], + ~.ListControlComplianceSummariesResponse]: + 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_control_compliance_summaries" not in self._stubs: + self._stubs[ + "list_control_compliance_summaries" + ] = self._logged_channel.unary_unary( + "/google.cloud.cloudsecuritycompliance.v1.Monitoring/ListControlComplianceSummaries", + request_serializer=monitoring.ListControlComplianceSummariesRequest.serialize, + response_deserializer=monitoring.ListControlComplianceSummariesResponse.deserialize, + ) + return self._stubs["list_control_compliance_summaries"] + + @property + def aggregate_framework_compliance_report( + self, + ) -> Callable[ + [monitoring.AggregateFrameworkComplianceReportRequest], + monitoring.AggregateFrameworkComplianceReportResponse, + ]: + r"""Return a callable for the aggregate framework compliance + report method over gRPC. + + Gets the aggregated compliance report over time for a + given scope. + + Returns: + Callable[[~.AggregateFrameworkComplianceReportRequest], + ~.AggregateFrameworkComplianceReportResponse]: + 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 "aggregate_framework_compliance_report" not in self._stubs: + self._stubs[ + "aggregate_framework_compliance_report" + ] = self._logged_channel.unary_unary( + "/google.cloud.cloudsecuritycompliance.v1.Monitoring/AggregateFrameworkComplianceReport", + request_serializer=monitoring.AggregateFrameworkComplianceReportRequest.serialize, + response_deserializer=monitoring.AggregateFrameworkComplianceReportResponse.deserialize, + ) + return self._stubs["aggregate_framework_compliance_report"] + + def close(self): + self._logged_channel.close() + + @property + def delete_operation( + self, + ) -> Callable[[operations_pb2.DeleteOperationRequest], None]: + r"""Return a callable for the delete_operation method over gRPC.""" + # 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 "delete_operation" not in self._stubs: + self._stubs["delete_operation"] = self._logged_channel.unary_unary( + "/google.longrunning.Operations/DeleteOperation", + request_serializer=operations_pb2.DeleteOperationRequest.SerializeToString, + response_deserializer=None, + ) + return self._stubs["delete_operation"] + + @property + def cancel_operation( + self, + ) -> Callable[[operations_pb2.CancelOperationRequest], None]: + r"""Return a callable for the cancel_operation method over gRPC.""" + # 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 "cancel_operation" not in self._stubs: + self._stubs["cancel_operation"] = self._logged_channel.unary_unary( + "/google.longrunning.Operations/CancelOperation", + request_serializer=operations_pb2.CancelOperationRequest.SerializeToString, + response_deserializer=None, + ) + return self._stubs["cancel_operation"] + + @property + def get_operation( + self, + ) -> Callable[[operations_pb2.GetOperationRequest], operations_pb2.Operation]: + r"""Return a callable for the get_operation method over gRPC.""" + # 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_operation" not in self._stubs: + self._stubs["get_operation"] = self._logged_channel.unary_unary( + "/google.longrunning.Operations/GetOperation", + request_serializer=operations_pb2.GetOperationRequest.SerializeToString, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["get_operation"] + + @property + def list_operations( + self, + ) -> Callable[ + [operations_pb2.ListOperationsRequest], operations_pb2.ListOperationsResponse + ]: + r"""Return a callable for the list_operations method over gRPC.""" + # 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_operations" not in self._stubs: + self._stubs["list_operations"] = self._logged_channel.unary_unary( + "/google.longrunning.Operations/ListOperations", + request_serializer=operations_pb2.ListOperationsRequest.SerializeToString, + response_deserializer=operations_pb2.ListOperationsResponse.FromString, + ) + return self._stubs["list_operations"] + + @property + def list_locations( + self, + ) -> Callable[ + [locations_pb2.ListLocationsRequest], locations_pb2.ListLocationsResponse + ]: + r"""Return a callable for the list locations method over gRPC.""" + # 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_locations" not in self._stubs: + self._stubs["list_locations"] = self._logged_channel.unary_unary( + "/google.cloud.location.Locations/ListLocations", + request_serializer=locations_pb2.ListLocationsRequest.SerializeToString, + response_deserializer=locations_pb2.ListLocationsResponse.FromString, + ) + return self._stubs["list_locations"] + + @property + def get_location( + self, + ) -> Callable[[locations_pb2.GetLocationRequest], locations_pb2.Location]: + r"""Return a callable for the list locations method over gRPC.""" + # 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_location" not in self._stubs: + self._stubs["get_location"] = self._logged_channel.unary_unary( + "/google.cloud.location.Locations/GetLocation", + request_serializer=locations_pb2.GetLocationRequest.SerializeToString, + response_deserializer=locations_pb2.Location.FromString, + ) + return self._stubs["get_location"] + + @property + def kind(self) -> str: + return "grpc" + + +__all__ = ("MonitoringGrpcTransport",) diff --git a/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/services/monitoring/transports/grpc_asyncio.py b/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/services/monitoring/transports/grpc_asyncio.py new file mode 100644 index 000000000000..a998d221f40a --- /dev/null +++ b/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/services/monitoring/transports/grpc_asyncio.py @@ -0,0 +1,720 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import 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.cloud.location import locations_pb2 # type: ignore +from google.longrunning import operations_pb2 # 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.cloudsecuritycompliance_v1.types import monitoring + +from .base import DEFAULT_CLIENT_INFO, MonitoringTransport +from .grpc import MonitoringGrpcTransport + +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.cloud.cloudsecuritycompliance.v1.Monitoring", + "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.cloud.cloudsecuritycompliance.v1.Monitoring", + "rpcName": str(client_call_details.method), + "response": grpc_response, + "metadata": grpc_response["metadata"], + }, + ) + return response + + +class MonitoringGrpcAsyncIOTransport(MonitoringTransport): + """gRPC AsyncIO backend transport for Monitoring. + + Service describing handlers for resources + + 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 = "cloudsecuritycompliance.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]): Deprecated. A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. This argument will be + removed in the next major version of this library. + 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 = "cloudsecuritycompliance.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: 'cloudsecuritycompliance.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]): Deprecated. 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. + This argument will be removed in the next major version of this library. + 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_framework_compliance_summaries( + self, + ) -> Callable[ + [monitoring.ListFrameworkComplianceSummariesRequest], + Awaitable[monitoring.ListFrameworkComplianceSummariesResponse], + ]: + r"""Return a callable for the list framework compliance + summaries method over gRPC. + + Lists the framework compliance summary for a given + scope. + + Returns: + Callable[[~.ListFrameworkComplianceSummariesRequest], + Awaitable[~.ListFrameworkComplianceSummariesResponse]]: + 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_framework_compliance_summaries" not in self._stubs: + self._stubs[ + "list_framework_compliance_summaries" + ] = self._logged_channel.unary_unary( + "/google.cloud.cloudsecuritycompliance.v1.Monitoring/ListFrameworkComplianceSummaries", + request_serializer=monitoring.ListFrameworkComplianceSummariesRequest.serialize, + response_deserializer=monitoring.ListFrameworkComplianceSummariesResponse.deserialize, + ) + return self._stubs["list_framework_compliance_summaries"] + + @property + def list_finding_summaries( + self, + ) -> Callable[ + [monitoring.ListFindingSummariesRequest], + Awaitable[monitoring.ListFindingSummariesResponse], + ]: + r"""Return a callable for the list finding summaries method over gRPC. + + Lists the finding summary by category for a given + scope. + + Returns: + Callable[[~.ListFindingSummariesRequest], + Awaitable[~.ListFindingSummariesResponse]]: + 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_finding_summaries" not in self._stubs: + self._stubs["list_finding_summaries"] = self._logged_channel.unary_unary( + "/google.cloud.cloudsecuritycompliance.v1.Monitoring/ListFindingSummaries", + request_serializer=monitoring.ListFindingSummariesRequest.serialize, + response_deserializer=monitoring.ListFindingSummariesResponse.deserialize, + ) + return self._stubs["list_finding_summaries"] + + @property + def fetch_framework_compliance_report( + self, + ) -> Callable[ + [monitoring.FetchFrameworkComplianceReportRequest], + Awaitable[monitoring.FrameworkComplianceReport], + ]: + r"""Return a callable for the fetch framework compliance + report method over gRPC. + + Fetches the framework compliance report for a given + scope. + + Returns: + Callable[[~.FetchFrameworkComplianceReportRequest], + Awaitable[~.FrameworkComplianceReport]]: + 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 "fetch_framework_compliance_report" not in self._stubs: + self._stubs[ + "fetch_framework_compliance_report" + ] = self._logged_channel.unary_unary( + "/google.cloud.cloudsecuritycompliance.v1.Monitoring/FetchFrameworkComplianceReport", + request_serializer=monitoring.FetchFrameworkComplianceReportRequest.serialize, + response_deserializer=monitoring.FrameworkComplianceReport.deserialize, + ) + return self._stubs["fetch_framework_compliance_report"] + + @property + def list_control_compliance_summaries( + self, + ) -> Callable[ + [monitoring.ListControlComplianceSummariesRequest], + Awaitable[monitoring.ListControlComplianceSummariesResponse], + ]: + r"""Return a callable for the list control compliance + summaries method over gRPC. + + Lists the control compliance summary for a given + scope. + + Returns: + Callable[[~.ListControlComplianceSummariesRequest], + Awaitable[~.ListControlComplianceSummariesResponse]]: + 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_control_compliance_summaries" not in self._stubs: + self._stubs[ + "list_control_compliance_summaries" + ] = self._logged_channel.unary_unary( + "/google.cloud.cloudsecuritycompliance.v1.Monitoring/ListControlComplianceSummaries", + request_serializer=monitoring.ListControlComplianceSummariesRequest.serialize, + response_deserializer=monitoring.ListControlComplianceSummariesResponse.deserialize, + ) + return self._stubs["list_control_compliance_summaries"] + + @property + def aggregate_framework_compliance_report( + self, + ) -> Callable[ + [monitoring.AggregateFrameworkComplianceReportRequest], + Awaitable[monitoring.AggregateFrameworkComplianceReportResponse], + ]: + r"""Return a callable for the aggregate framework compliance + report method over gRPC. + + Gets the aggregated compliance report over time for a + given scope. + + Returns: + Callable[[~.AggregateFrameworkComplianceReportRequest], + Awaitable[~.AggregateFrameworkComplianceReportResponse]]: + 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 "aggregate_framework_compliance_report" not in self._stubs: + self._stubs[ + "aggregate_framework_compliance_report" + ] = self._logged_channel.unary_unary( + "/google.cloud.cloudsecuritycompliance.v1.Monitoring/AggregateFrameworkComplianceReport", + request_serializer=monitoring.AggregateFrameworkComplianceReportRequest.serialize, + response_deserializer=monitoring.AggregateFrameworkComplianceReportResponse.deserialize, + ) + return self._stubs["aggregate_framework_compliance_report"] + + 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_framework_compliance_summaries: self._wrap_method( + self.list_framework_compliance_summaries, + 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_finding_summaries: self._wrap_method( + self.list_finding_summaries, + 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.fetch_framework_compliance_report: self._wrap_method( + self.fetch_framework_compliance_report, + 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_control_compliance_summaries: self._wrap_method( + self.list_control_compliance_summaries, + 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.aggregate_framework_compliance_report: self._wrap_method( + self.aggregate_framework_compliance_report, + 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_location: self._wrap_method( + self.get_location, + default_timeout=None, + client_info=client_info, + ), + self.list_locations: self._wrap_method( + self.list_locations, + default_timeout=None, + client_info=client_info, + ), + self.cancel_operation: self._wrap_method( + self.cancel_operation, + default_timeout=None, + client_info=client_info, + ), + self.delete_operation: self._wrap_method( + self.delete_operation, + default_timeout=None, + client_info=client_info, + ), + self.get_operation: self._wrap_method( + self.get_operation, + default_timeout=None, + client_info=client_info, + ), + self.list_operations: self._wrap_method( + self.list_operations, + default_timeout=None, + 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" + + @property + def delete_operation( + self, + ) -> Callable[[operations_pb2.DeleteOperationRequest], None]: + r"""Return a callable for the delete_operation method over gRPC.""" + # 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 "delete_operation" not in self._stubs: + self._stubs["delete_operation"] = self._logged_channel.unary_unary( + "/google.longrunning.Operations/DeleteOperation", + request_serializer=operations_pb2.DeleteOperationRequest.SerializeToString, + response_deserializer=None, + ) + return self._stubs["delete_operation"] + + @property + def cancel_operation( + self, + ) -> Callable[[operations_pb2.CancelOperationRequest], None]: + r"""Return a callable for the cancel_operation method over gRPC.""" + # 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 "cancel_operation" not in self._stubs: + self._stubs["cancel_operation"] = self._logged_channel.unary_unary( + "/google.longrunning.Operations/CancelOperation", + request_serializer=operations_pb2.CancelOperationRequest.SerializeToString, + response_deserializer=None, + ) + return self._stubs["cancel_operation"] + + @property + def get_operation( + self, + ) -> Callable[[operations_pb2.GetOperationRequest], operations_pb2.Operation]: + r"""Return a callable for the get_operation method over gRPC.""" + # 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_operation" not in self._stubs: + self._stubs["get_operation"] = self._logged_channel.unary_unary( + "/google.longrunning.Operations/GetOperation", + request_serializer=operations_pb2.GetOperationRequest.SerializeToString, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["get_operation"] + + @property + def list_operations( + self, + ) -> Callable[ + [operations_pb2.ListOperationsRequest], operations_pb2.ListOperationsResponse + ]: + r"""Return a callable for the list_operations method over gRPC.""" + # 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_operations" not in self._stubs: + self._stubs["list_operations"] = self._logged_channel.unary_unary( + "/google.longrunning.Operations/ListOperations", + request_serializer=operations_pb2.ListOperationsRequest.SerializeToString, + response_deserializer=operations_pb2.ListOperationsResponse.FromString, + ) + return self._stubs["list_operations"] + + @property + def list_locations( + self, + ) -> Callable[ + [locations_pb2.ListLocationsRequest], locations_pb2.ListLocationsResponse + ]: + r"""Return a callable for the list locations method over gRPC.""" + # 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_locations" not in self._stubs: + self._stubs["list_locations"] = self._logged_channel.unary_unary( + "/google.cloud.location.Locations/ListLocations", + request_serializer=locations_pb2.ListLocationsRequest.SerializeToString, + response_deserializer=locations_pb2.ListLocationsResponse.FromString, + ) + return self._stubs["list_locations"] + + @property + def get_location( + self, + ) -> Callable[[locations_pb2.GetLocationRequest], locations_pb2.Location]: + r"""Return a callable for the list locations method over gRPC.""" + # 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_location" not in self._stubs: + self._stubs["get_location"] = self._logged_channel.unary_unary( + "/google.cloud.location.Locations/GetLocation", + request_serializer=locations_pb2.GetLocationRequest.SerializeToString, + response_deserializer=locations_pb2.Location.FromString, + ) + return self._stubs["get_location"] + + +__all__ = ("MonitoringGrpcAsyncIOTransport",) diff --git a/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/services/monitoring/transports/rest.py b/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/services/monitoring/transports/rest.py new file mode 100644 index 000000000000..bc744a7c3e0b --- /dev/null +++ b/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/services/monitoring/transports/rest.py @@ -0,0 +1,2275 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import 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.cloud.location import locations_pb2 # type: ignore +from google.longrunning import operations_pb2 # type: ignore +import google.protobuf +from google.protobuf import json_format +from requests import __version__ as requests_version + +from google.cloud.cloudsecuritycompliance_v1.types import monitoring + +from .base import DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO +from .rest_base import _BaseMonitoringRestTransport + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object, None] # type: ignore + +try: + from google.api_core import client_logging # type: ignore + + CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER +except ImportError: # pragma: NO COVER + CLIENT_LOGGING_SUPPORTED = False + +_LOGGER = logging.getLogger(__name__) + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=f"requests@{requests_version}", +) + +if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER + DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ + + +class MonitoringRestInterceptor: + """Interceptor for Monitoring. + + 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 MonitoringRestTransport. + + .. code-block:: python + class MyCustomMonitoringInterceptor(MonitoringRestInterceptor): + def pre_aggregate_framework_compliance_report(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_aggregate_framework_compliance_report(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_fetch_framework_compliance_report(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_fetch_framework_compliance_report(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_control_compliance_summaries(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_control_compliance_summaries(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_finding_summaries(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_finding_summaries(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_framework_compliance_summaries(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_framework_compliance_summaries(self, response): + logging.log(f"Received response: {response}") + return response + + transport = MonitoringRestTransport(interceptor=MyCustomMonitoringInterceptor()) + client = MonitoringClient(transport=transport) + + + """ + + def pre_aggregate_framework_compliance_report( + self, + request: monitoring.AggregateFrameworkComplianceReportRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + monitoring.AggregateFrameworkComplianceReportRequest, + Sequence[Tuple[str, Union[str, bytes]]], + ]: + """Pre-rpc interceptor for aggregate_framework_compliance_report + + Override in a subclass to manipulate the request or metadata + before they are sent to the Monitoring server. + """ + return request, metadata + + def post_aggregate_framework_compliance_report( + self, response: monitoring.AggregateFrameworkComplianceReportResponse + ) -> monitoring.AggregateFrameworkComplianceReportResponse: + """Post-rpc interceptor for aggregate_framework_compliance_report + + DEPRECATED. Please use the `post_aggregate_framework_compliance_report_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the Monitoring server but before + it is returned to user code. This `post_aggregate_framework_compliance_report` interceptor runs + before the `post_aggregate_framework_compliance_report_with_metadata` interceptor. + """ + return response + + def post_aggregate_framework_compliance_report_with_metadata( + self, + response: monitoring.AggregateFrameworkComplianceReportResponse, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + monitoring.AggregateFrameworkComplianceReportResponse, + Sequence[Tuple[str, Union[str, bytes]]], + ]: + """Post-rpc interceptor for aggregate_framework_compliance_report + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the Monitoring server but before it is returned to user code. + + We recommend only using this `post_aggregate_framework_compliance_report_with_metadata` + interceptor in new development instead of the `post_aggregate_framework_compliance_report` interceptor. + When both interceptors are used, this `post_aggregate_framework_compliance_report_with_metadata` interceptor runs after the + `post_aggregate_framework_compliance_report` interceptor. The (possibly modified) response returned by + `post_aggregate_framework_compliance_report` will be passed to + `post_aggregate_framework_compliance_report_with_metadata`. + """ + return response, metadata + + def pre_fetch_framework_compliance_report( + self, + request: monitoring.FetchFrameworkComplianceReportRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + monitoring.FetchFrameworkComplianceReportRequest, + Sequence[Tuple[str, Union[str, bytes]]], + ]: + """Pre-rpc interceptor for fetch_framework_compliance_report + + Override in a subclass to manipulate the request or metadata + before they are sent to the Monitoring server. + """ + return request, metadata + + def post_fetch_framework_compliance_report( + self, response: monitoring.FrameworkComplianceReport + ) -> monitoring.FrameworkComplianceReport: + """Post-rpc interceptor for fetch_framework_compliance_report + + DEPRECATED. Please use the `post_fetch_framework_compliance_report_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the Monitoring server but before + it is returned to user code. This `post_fetch_framework_compliance_report` interceptor runs + before the `post_fetch_framework_compliance_report_with_metadata` interceptor. + """ + return response + + def post_fetch_framework_compliance_report_with_metadata( + self, + response: monitoring.FrameworkComplianceReport, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + monitoring.FrameworkComplianceReport, Sequence[Tuple[str, Union[str, bytes]]] + ]: + """Post-rpc interceptor for fetch_framework_compliance_report + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the Monitoring server but before it is returned to user code. + + We recommend only using this `post_fetch_framework_compliance_report_with_metadata` + interceptor in new development instead of the `post_fetch_framework_compliance_report` interceptor. + When both interceptors are used, this `post_fetch_framework_compliance_report_with_metadata` interceptor runs after the + `post_fetch_framework_compliance_report` interceptor. The (possibly modified) response returned by + `post_fetch_framework_compliance_report` will be passed to + `post_fetch_framework_compliance_report_with_metadata`. + """ + return response, metadata + + def pre_list_control_compliance_summaries( + self, + request: monitoring.ListControlComplianceSummariesRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + monitoring.ListControlComplianceSummariesRequest, + Sequence[Tuple[str, Union[str, bytes]]], + ]: + """Pre-rpc interceptor for list_control_compliance_summaries + + Override in a subclass to manipulate the request or metadata + before they are sent to the Monitoring server. + """ + return request, metadata + + def post_list_control_compliance_summaries( + self, response: monitoring.ListControlComplianceSummariesResponse + ) -> monitoring.ListControlComplianceSummariesResponse: + """Post-rpc interceptor for list_control_compliance_summaries + + DEPRECATED. Please use the `post_list_control_compliance_summaries_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the Monitoring server but before + it is returned to user code. This `post_list_control_compliance_summaries` interceptor runs + before the `post_list_control_compliance_summaries_with_metadata` interceptor. + """ + return response + + def post_list_control_compliance_summaries_with_metadata( + self, + response: monitoring.ListControlComplianceSummariesResponse, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + monitoring.ListControlComplianceSummariesResponse, + Sequence[Tuple[str, Union[str, bytes]]], + ]: + """Post-rpc interceptor for list_control_compliance_summaries + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the Monitoring server but before it is returned to user code. + + We recommend only using this `post_list_control_compliance_summaries_with_metadata` + interceptor in new development instead of the `post_list_control_compliance_summaries` interceptor. + When both interceptors are used, this `post_list_control_compliance_summaries_with_metadata` interceptor runs after the + `post_list_control_compliance_summaries` interceptor. The (possibly modified) response returned by + `post_list_control_compliance_summaries` will be passed to + `post_list_control_compliance_summaries_with_metadata`. + """ + return response, metadata + + def pre_list_finding_summaries( + self, + request: monitoring.ListFindingSummariesRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + monitoring.ListFindingSummariesRequest, Sequence[Tuple[str, Union[str, bytes]]] + ]: + """Pre-rpc interceptor for list_finding_summaries + + Override in a subclass to manipulate the request or metadata + before they are sent to the Monitoring server. + """ + return request, metadata + + def post_list_finding_summaries( + self, response: monitoring.ListFindingSummariesResponse + ) -> monitoring.ListFindingSummariesResponse: + """Post-rpc interceptor for list_finding_summaries + + DEPRECATED. Please use the `post_list_finding_summaries_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the Monitoring server but before + it is returned to user code. This `post_list_finding_summaries` interceptor runs + before the `post_list_finding_summaries_with_metadata` interceptor. + """ + return response + + def post_list_finding_summaries_with_metadata( + self, + response: monitoring.ListFindingSummariesResponse, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + monitoring.ListFindingSummariesResponse, Sequence[Tuple[str, Union[str, bytes]]] + ]: + """Post-rpc interceptor for list_finding_summaries + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the Monitoring server but before it is returned to user code. + + We recommend only using this `post_list_finding_summaries_with_metadata` + interceptor in new development instead of the `post_list_finding_summaries` interceptor. + When both interceptors are used, this `post_list_finding_summaries_with_metadata` interceptor runs after the + `post_list_finding_summaries` interceptor. The (possibly modified) response returned by + `post_list_finding_summaries` will be passed to + `post_list_finding_summaries_with_metadata`. + """ + return response, metadata + + def pre_list_framework_compliance_summaries( + self, + request: monitoring.ListFrameworkComplianceSummariesRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + monitoring.ListFrameworkComplianceSummariesRequest, + Sequence[Tuple[str, Union[str, bytes]]], + ]: + """Pre-rpc interceptor for list_framework_compliance_summaries + + Override in a subclass to manipulate the request or metadata + before they are sent to the Monitoring server. + """ + return request, metadata + + def post_list_framework_compliance_summaries( + self, response: monitoring.ListFrameworkComplianceSummariesResponse + ) -> monitoring.ListFrameworkComplianceSummariesResponse: + """Post-rpc interceptor for list_framework_compliance_summaries + + DEPRECATED. Please use the `post_list_framework_compliance_summaries_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the Monitoring server but before + it is returned to user code. This `post_list_framework_compliance_summaries` interceptor runs + before the `post_list_framework_compliance_summaries_with_metadata` interceptor. + """ + return response + + def post_list_framework_compliance_summaries_with_metadata( + self, + response: monitoring.ListFrameworkComplianceSummariesResponse, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + monitoring.ListFrameworkComplianceSummariesResponse, + Sequence[Tuple[str, Union[str, bytes]]], + ]: + """Post-rpc interceptor for list_framework_compliance_summaries + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the Monitoring server but before it is returned to user code. + + We recommend only using this `post_list_framework_compliance_summaries_with_metadata` + interceptor in new development instead of the `post_list_framework_compliance_summaries` interceptor. + When both interceptors are used, this `post_list_framework_compliance_summaries_with_metadata` interceptor runs after the + `post_list_framework_compliance_summaries` interceptor. The (possibly modified) response returned by + `post_list_framework_compliance_summaries` will be passed to + `post_list_framework_compliance_summaries_with_metadata`. + """ + return response, metadata + + def pre_get_location( + self, + request: locations_pb2.GetLocationRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + locations_pb2.GetLocationRequest, Sequence[Tuple[str, Union[str, bytes]]] + ]: + """Pre-rpc interceptor for get_location + + Override in a subclass to manipulate the request or metadata + before they are sent to the Monitoring server. + """ + return request, metadata + + def post_get_location( + self, response: locations_pb2.Location + ) -> locations_pb2.Location: + """Post-rpc interceptor for get_location + + Override in a subclass to manipulate the response + after it is returned by the Monitoring server but before + it is returned to user code. + """ + return response + + def pre_list_locations( + self, + request: locations_pb2.ListLocationsRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + locations_pb2.ListLocationsRequest, Sequence[Tuple[str, Union[str, bytes]]] + ]: + """Pre-rpc interceptor for list_locations + + Override in a subclass to manipulate the request or metadata + before they are sent to the Monitoring server. + """ + return request, metadata + + def post_list_locations( + self, response: locations_pb2.ListLocationsResponse + ) -> locations_pb2.ListLocationsResponse: + """Post-rpc interceptor for list_locations + + Override in a subclass to manipulate the response + after it is returned by the Monitoring server but before + it is returned to user code. + """ + return response + + def pre_cancel_operation( + self, + request: operations_pb2.CancelOperationRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + operations_pb2.CancelOperationRequest, Sequence[Tuple[str, Union[str, bytes]]] + ]: + """Pre-rpc interceptor for cancel_operation + + Override in a subclass to manipulate the request or metadata + before they are sent to the Monitoring server. + """ + return request, metadata + + def post_cancel_operation(self, response: None) -> None: + """Post-rpc interceptor for cancel_operation + + Override in a subclass to manipulate the response + after it is returned by the Monitoring server but before + it is returned to user code. + """ + return response + + def pre_delete_operation( + self, + request: operations_pb2.DeleteOperationRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + operations_pb2.DeleteOperationRequest, Sequence[Tuple[str, Union[str, bytes]]] + ]: + """Pre-rpc interceptor for delete_operation + + Override in a subclass to manipulate the request or metadata + before they are sent to the Monitoring server. + """ + return request, metadata + + def post_delete_operation(self, response: None) -> None: + """Post-rpc interceptor for delete_operation + + Override in a subclass to manipulate the response + after it is returned by the Monitoring server but before + it is returned to user code. + """ + return response + + def pre_get_operation( + self, + request: operations_pb2.GetOperationRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + operations_pb2.GetOperationRequest, Sequence[Tuple[str, Union[str, bytes]]] + ]: + """Pre-rpc interceptor for get_operation + + Override in a subclass to manipulate the request or metadata + before they are sent to the Monitoring server. + """ + return request, metadata + + def post_get_operation( + self, response: operations_pb2.Operation + ) -> operations_pb2.Operation: + """Post-rpc interceptor for get_operation + + Override in a subclass to manipulate the response + after it is returned by the Monitoring server but before + it is returned to user code. + """ + return response + + def pre_list_operations( + self, + request: operations_pb2.ListOperationsRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + operations_pb2.ListOperationsRequest, Sequence[Tuple[str, Union[str, bytes]]] + ]: + """Pre-rpc interceptor for list_operations + + Override in a subclass to manipulate the request or metadata + before they are sent to the Monitoring server. + """ + return request, metadata + + def post_list_operations( + self, response: operations_pb2.ListOperationsResponse + ) -> operations_pb2.ListOperationsResponse: + """Post-rpc interceptor for list_operations + + Override in a subclass to manipulate the response + after it is returned by the Monitoring server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class MonitoringRestStub: + _session: AuthorizedSession + _host: str + _interceptor: MonitoringRestInterceptor + + +class MonitoringRestTransport(_BaseMonitoringRestTransport): + """REST backend synchronous transport for Monitoring. + + Service describing handlers for resources + + 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 = "cloudsecuritycompliance.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[MonitoringRestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to (default: 'cloudsecuritycompliance.googleapis.com'). + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + + credentials_file (Optional[str]): Deprecated. A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. This argument will be + removed in the next major version of this library. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + url_scheme=url_scheme, + api_audience=api_audience, + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST + ) + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or MonitoringRestInterceptor() + self._prep_wrapped_messages(client_info) + + class _AggregateFrameworkComplianceReport( + _BaseMonitoringRestTransport._BaseAggregateFrameworkComplianceReport, + MonitoringRestStub, + ): + def __hash__(self): + return hash("MonitoringRestTransport.AggregateFrameworkComplianceReport") + + @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: monitoring.AggregateFrameworkComplianceReportRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> monitoring.AggregateFrameworkComplianceReportResponse: + r"""Call the aggregate framework + compliance report method over HTTP. + + Args: + request (~.monitoring.AggregateFrameworkComplianceReportRequest): + The request object. The request message for + [AggregateFrameworkComplianceReport][]. + 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: + ~.monitoring.AggregateFrameworkComplianceReportResponse: + The response message for + [AggregateFrameworkComplianceReport][]. + + """ + + http_options = ( + _BaseMonitoringRestTransport._BaseAggregateFrameworkComplianceReport._get_http_options() + ) + + ( + request, + metadata, + ) = self._interceptor.pre_aggregate_framework_compliance_report( + request, metadata + ) + transcoded_request = _BaseMonitoringRestTransport._BaseAggregateFrameworkComplianceReport._get_transcoded_request( + http_options, request + ) + + # Jsonify the query params + query_params = _BaseMonitoringRestTransport._BaseAggregateFrameworkComplianceReport._get_query_params_json( + transcoded_request + ) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + request_url = "{host}{uri}".format( + host=self._host, uri=transcoded_request["uri"] + ) + method = transcoded_request["method"] + try: + request_payload = type(request).to_json(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.cloudsecuritycompliance_v1.MonitoringClient.AggregateFrameworkComplianceReport", + extra={ + "serviceName": "google.cloud.cloudsecuritycompliance.v1.Monitoring", + "rpcName": "AggregateFrameworkComplianceReport", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = MonitoringRestTransport._AggregateFrameworkComplianceReport._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 = monitoring.AggregateFrameworkComplianceReportResponse() + pb_resp = monitoring.AggregateFrameworkComplianceReportResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_aggregate_framework_compliance_report(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + ( + resp, + _, + ) = self._interceptor.post_aggregate_framework_compliance_report_with_metadata( + resp, response_metadata + ) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + try: + response_payload = ( + monitoring.AggregateFrameworkComplianceReportResponse.to_json( + response + ) + ) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.cloudsecuritycompliance_v1.MonitoringClient.aggregate_framework_compliance_report", + extra={ + "serviceName": "google.cloud.cloudsecuritycompliance.v1.Monitoring", + "rpcName": "AggregateFrameworkComplianceReport", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _FetchFrameworkComplianceReport( + _BaseMonitoringRestTransport._BaseFetchFrameworkComplianceReport, + MonitoringRestStub, + ): + def __hash__(self): + return hash("MonitoringRestTransport.FetchFrameworkComplianceReport") + + @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: monitoring.FetchFrameworkComplianceReportRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> monitoring.FrameworkComplianceReport: + r"""Call the fetch framework + compliance report method over HTTP. + + Args: + request (~.monitoring.FetchFrameworkComplianceReportRequest): + The request object. The request message for + [FetchFrameworkComplianceReport][]. + 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: + ~.monitoring.FrameworkComplianceReport: + The response message for + [GetFrameworkComplianceReport][]. + + """ + + http_options = ( + _BaseMonitoringRestTransport._BaseFetchFrameworkComplianceReport._get_http_options() + ) + + request, metadata = self._interceptor.pre_fetch_framework_compliance_report( + request, metadata + ) + transcoded_request = _BaseMonitoringRestTransport._BaseFetchFrameworkComplianceReport._get_transcoded_request( + http_options, request + ) + + # Jsonify the query params + query_params = _BaseMonitoringRestTransport._BaseFetchFrameworkComplianceReport._get_query_params_json( + transcoded_request + ) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + request_url = "{host}{uri}".format( + host=self._host, uri=transcoded_request["uri"] + ) + method = transcoded_request["method"] + try: + request_payload = type(request).to_json(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.cloudsecuritycompliance_v1.MonitoringClient.FetchFrameworkComplianceReport", + extra={ + "serviceName": "google.cloud.cloudsecuritycompliance.v1.Monitoring", + "rpcName": "FetchFrameworkComplianceReport", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ( + MonitoringRestTransport._FetchFrameworkComplianceReport._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 = monitoring.FrameworkComplianceReport() + pb_resp = monitoring.FrameworkComplianceReport.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_fetch_framework_compliance_report(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + ( + resp, + _, + ) = self._interceptor.post_fetch_framework_compliance_report_with_metadata( + resp, response_metadata + ) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + try: + response_payload = monitoring.FrameworkComplianceReport.to_json( + response + ) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.cloudsecuritycompliance_v1.MonitoringClient.fetch_framework_compliance_report", + extra={ + "serviceName": "google.cloud.cloudsecuritycompliance.v1.Monitoring", + "rpcName": "FetchFrameworkComplianceReport", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _ListControlComplianceSummaries( + _BaseMonitoringRestTransport._BaseListControlComplianceSummaries, + MonitoringRestStub, + ): + def __hash__(self): + return hash("MonitoringRestTransport.ListControlComplianceSummaries") + + @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: monitoring.ListControlComplianceSummariesRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> monitoring.ListControlComplianceSummariesResponse: + r"""Call the list control compliance + summaries method over HTTP. + + Args: + request (~.monitoring.ListControlComplianceSummariesRequest): + The request object. The request message for + [ListControlComplianceSummaries][]. + 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: + ~.monitoring.ListControlComplianceSummariesResponse: + The response message for + [ListControlComplianceSummaries][]. + + """ + + http_options = ( + _BaseMonitoringRestTransport._BaseListControlComplianceSummaries._get_http_options() + ) + + request, metadata = self._interceptor.pre_list_control_compliance_summaries( + request, metadata + ) + transcoded_request = _BaseMonitoringRestTransport._BaseListControlComplianceSummaries._get_transcoded_request( + http_options, request + ) + + # Jsonify the query params + query_params = _BaseMonitoringRestTransport._BaseListControlComplianceSummaries._get_query_params_json( + transcoded_request + ) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + request_url = "{host}{uri}".format( + host=self._host, uri=transcoded_request["uri"] + ) + method = transcoded_request["method"] + try: + request_payload = type(request).to_json(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.cloudsecuritycompliance_v1.MonitoringClient.ListControlComplianceSummaries", + extra={ + "serviceName": "google.cloud.cloudsecuritycompliance.v1.Monitoring", + "rpcName": "ListControlComplianceSummaries", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ( + MonitoringRestTransport._ListControlComplianceSummaries._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 = monitoring.ListControlComplianceSummariesResponse() + pb_resp = monitoring.ListControlComplianceSummariesResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_list_control_compliance_summaries(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + ( + resp, + _, + ) = self._interceptor.post_list_control_compliance_summaries_with_metadata( + resp, response_metadata + ) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + try: + response_payload = ( + monitoring.ListControlComplianceSummariesResponse.to_json( + response + ) + ) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.cloudsecuritycompliance_v1.MonitoringClient.list_control_compliance_summaries", + extra={ + "serviceName": "google.cloud.cloudsecuritycompliance.v1.Monitoring", + "rpcName": "ListControlComplianceSummaries", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _ListFindingSummaries( + _BaseMonitoringRestTransport._BaseListFindingSummaries, MonitoringRestStub + ): + def __hash__(self): + return hash("MonitoringRestTransport.ListFindingSummaries") + + @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: monitoring.ListFindingSummariesRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> monitoring.ListFindingSummariesResponse: + r"""Call the list finding summaries method over HTTP. + + Args: + request (~.monitoring.ListFindingSummariesRequest): + The request object. The request message for [ListFindingSummaries][]. + 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: + ~.monitoring.ListFindingSummariesResponse: + The response message for [ListFindingSummaries][]. + """ + + http_options = ( + _BaseMonitoringRestTransport._BaseListFindingSummaries._get_http_options() + ) + + request, metadata = self._interceptor.pre_list_finding_summaries( + request, metadata + ) + transcoded_request = _BaseMonitoringRestTransport._BaseListFindingSummaries._get_transcoded_request( + http_options, request + ) + + # Jsonify the query params + query_params = _BaseMonitoringRestTransport._BaseListFindingSummaries._get_query_params_json( + transcoded_request + ) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + request_url = "{host}{uri}".format( + host=self._host, uri=transcoded_request["uri"] + ) + method = transcoded_request["method"] + try: + request_payload = type(request).to_json(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.cloudsecuritycompliance_v1.MonitoringClient.ListFindingSummaries", + extra={ + "serviceName": "google.cloud.cloudsecuritycompliance.v1.Monitoring", + "rpcName": "ListFindingSummaries", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = MonitoringRestTransport._ListFindingSummaries._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 = monitoring.ListFindingSummariesResponse() + pb_resp = monitoring.ListFindingSummariesResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_list_finding_summaries(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_list_finding_summaries_with_metadata( + resp, response_metadata + ) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + try: + response_payload = monitoring.ListFindingSummariesResponse.to_json( + response + ) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.cloudsecuritycompliance_v1.MonitoringClient.list_finding_summaries", + extra={ + "serviceName": "google.cloud.cloudsecuritycompliance.v1.Monitoring", + "rpcName": "ListFindingSummaries", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _ListFrameworkComplianceSummaries( + _BaseMonitoringRestTransport._BaseListFrameworkComplianceSummaries, + MonitoringRestStub, + ): + def __hash__(self): + return hash("MonitoringRestTransport.ListFrameworkComplianceSummaries") + + @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: monitoring.ListFrameworkComplianceSummariesRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> monitoring.ListFrameworkComplianceSummariesResponse: + r"""Call the list framework compliance + summaries method over HTTP. + + Args: + request (~.monitoring.ListFrameworkComplianceSummariesRequest): + The request object. The request message for + [ListFrameworkComplianceSummariesRequest][google.cloud.cloudsecuritycompliance.v1.ListFrameworkComplianceSummariesRequest]. + 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: + ~.monitoring.ListFrameworkComplianceSummariesResponse: + The response message for + [ListFrameworkComplianceSummariesResponse][google.cloud.cloudsecuritycompliance.v1.ListFrameworkComplianceSummariesResponse]. + + """ + + http_options = ( + _BaseMonitoringRestTransport._BaseListFrameworkComplianceSummaries._get_http_options() + ) + + ( + request, + metadata, + ) = self._interceptor.pre_list_framework_compliance_summaries( + request, metadata + ) + transcoded_request = _BaseMonitoringRestTransport._BaseListFrameworkComplianceSummaries._get_transcoded_request( + http_options, request + ) + + # Jsonify the query params + query_params = _BaseMonitoringRestTransport._BaseListFrameworkComplianceSummaries._get_query_params_json( + transcoded_request + ) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + request_url = "{host}{uri}".format( + host=self._host, uri=transcoded_request["uri"] + ) + method = transcoded_request["method"] + try: + request_payload = type(request).to_json(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.cloudsecuritycompliance_v1.MonitoringClient.ListFrameworkComplianceSummaries", + extra={ + "serviceName": "google.cloud.cloudsecuritycompliance.v1.Monitoring", + "rpcName": "ListFrameworkComplianceSummaries", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ( + MonitoringRestTransport._ListFrameworkComplianceSummaries._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 = monitoring.ListFrameworkComplianceSummariesResponse() + pb_resp = monitoring.ListFrameworkComplianceSummariesResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_list_framework_compliance_summaries(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + ( + resp, + _, + ) = self._interceptor.post_list_framework_compliance_summaries_with_metadata( + resp, response_metadata + ) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + try: + response_payload = ( + monitoring.ListFrameworkComplianceSummariesResponse.to_json( + response + ) + ) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.cloudsecuritycompliance_v1.MonitoringClient.list_framework_compliance_summaries", + extra={ + "serviceName": "google.cloud.cloudsecuritycompliance.v1.Monitoring", + "rpcName": "ListFrameworkComplianceSummaries", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + @property + def aggregate_framework_compliance_report( + self, + ) -> Callable[ + [monitoring.AggregateFrameworkComplianceReportRequest], + monitoring.AggregateFrameworkComplianceReportResponse, + ]: + # 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._AggregateFrameworkComplianceReport(self._session, self._host, self._interceptor) # type: ignore + + @property + def fetch_framework_compliance_report( + self, + ) -> Callable[ + [monitoring.FetchFrameworkComplianceReportRequest], + monitoring.FrameworkComplianceReport, + ]: + # 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._FetchFrameworkComplianceReport(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_control_compliance_summaries( + self, + ) -> Callable[ + [monitoring.ListControlComplianceSummariesRequest], + monitoring.ListControlComplianceSummariesResponse, + ]: + # 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._ListControlComplianceSummaries(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_finding_summaries( + self, + ) -> Callable[ + [monitoring.ListFindingSummariesRequest], + monitoring.ListFindingSummariesResponse, + ]: + # 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._ListFindingSummaries(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_framework_compliance_summaries( + self, + ) -> Callable[ + [monitoring.ListFrameworkComplianceSummariesRequest], + monitoring.ListFrameworkComplianceSummariesResponse, + ]: + # 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._ListFrameworkComplianceSummaries(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_location(self): + return self._GetLocation(self._session, self._host, self._interceptor) # type: ignore + + class _GetLocation( + _BaseMonitoringRestTransport._BaseGetLocation, MonitoringRestStub + ): + def __hash__(self): + return hash("MonitoringRestTransport.GetLocation") + + @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: locations_pb2.GetLocationRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> locations_pb2.Location: + r"""Call the get location method over HTTP. + + Args: + request (locations_pb2.GetLocationRequest): + The request object for GetLocation method. + 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: + locations_pb2.Location: Response from GetLocation method. + """ + + http_options = ( + _BaseMonitoringRestTransport._BaseGetLocation._get_http_options() + ) + + request, metadata = self._interceptor.pre_get_location(request, metadata) + transcoded_request = ( + _BaseMonitoringRestTransport._BaseGetLocation._get_transcoded_request( + http_options, request + ) + ) + + # Jsonify the query params + query_params = ( + _BaseMonitoringRestTransport._BaseGetLocation._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 = json_format.MessageToJson(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.cloudsecuritycompliance_v1.MonitoringClient.GetLocation", + extra={ + "serviceName": "google.cloud.cloudsecuritycompliance.v1.Monitoring", + "rpcName": "GetLocation", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = MonitoringRestTransport._GetLocation._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) + + content = response.content.decode("utf-8") + resp = locations_pb2.Location() + resp = json_format.Parse(content, resp) + resp = self._interceptor.post_get_location(resp) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + try: + response_payload = json_format.MessageToJson(resp) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.cloudsecuritycompliance_v1.MonitoringAsyncClient.GetLocation", + extra={ + "serviceName": "google.cloud.cloudsecuritycompliance.v1.Monitoring", + "rpcName": "GetLocation", + "httpResponse": http_response, + "metadata": http_response["headers"], + }, + ) + return resp + + @property + def list_locations(self): + return self._ListLocations(self._session, self._host, self._interceptor) # type: ignore + + class _ListLocations( + _BaseMonitoringRestTransport._BaseListLocations, MonitoringRestStub + ): + def __hash__(self): + return hash("MonitoringRestTransport.ListLocations") + + @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: locations_pb2.ListLocationsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> locations_pb2.ListLocationsResponse: + r"""Call the list locations method over HTTP. + + Args: + request (locations_pb2.ListLocationsRequest): + The request object for ListLocations method. + 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: + locations_pb2.ListLocationsResponse: Response from ListLocations method. + """ + + http_options = ( + _BaseMonitoringRestTransport._BaseListLocations._get_http_options() + ) + + request, metadata = self._interceptor.pre_list_locations(request, metadata) + transcoded_request = ( + _BaseMonitoringRestTransport._BaseListLocations._get_transcoded_request( + http_options, request + ) + ) + + # Jsonify the query params + query_params = ( + _BaseMonitoringRestTransport._BaseListLocations._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 = json_format.MessageToJson(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.cloudsecuritycompliance_v1.MonitoringClient.ListLocations", + extra={ + "serviceName": "google.cloud.cloudsecuritycompliance.v1.Monitoring", + "rpcName": "ListLocations", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = MonitoringRestTransport._ListLocations._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) + + content = response.content.decode("utf-8") + resp = locations_pb2.ListLocationsResponse() + resp = json_format.Parse(content, resp) + resp = self._interceptor.post_list_locations(resp) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + try: + response_payload = json_format.MessageToJson(resp) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.cloudsecuritycompliance_v1.MonitoringAsyncClient.ListLocations", + extra={ + "serviceName": "google.cloud.cloudsecuritycompliance.v1.Monitoring", + "rpcName": "ListLocations", + "httpResponse": http_response, + "metadata": http_response["headers"], + }, + ) + return resp + + @property + def cancel_operation(self): + return self._CancelOperation(self._session, self._host, self._interceptor) # type: ignore + + class _CancelOperation( + _BaseMonitoringRestTransport._BaseCancelOperation, MonitoringRestStub + ): + def __hash__(self): + return hash("MonitoringRestTransport.CancelOperation") + + @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: operations_pb2.CancelOperationRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> None: + r"""Call the cancel operation method over HTTP. + + Args: + request (operations_pb2.CancelOperationRequest): + The request object for CancelOperation method. + 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`. + """ + + http_options = ( + _BaseMonitoringRestTransport._BaseCancelOperation._get_http_options() + ) + + request, metadata = self._interceptor.pre_cancel_operation( + request, metadata + ) + transcoded_request = _BaseMonitoringRestTransport._BaseCancelOperation._get_transcoded_request( + http_options, request + ) + + body = _BaseMonitoringRestTransport._BaseCancelOperation._get_request_body_json( + transcoded_request + ) + + # Jsonify the query params + query_params = _BaseMonitoringRestTransport._BaseCancelOperation._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 = json_format.MessageToJson(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.cloudsecuritycompliance_v1.MonitoringClient.CancelOperation", + extra={ + "serviceName": "google.cloud.cloudsecuritycompliance.v1.Monitoring", + "rpcName": "CancelOperation", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = MonitoringRestTransport._CancelOperation._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 self._interceptor.post_cancel_operation(None) + + @property + def delete_operation(self): + return self._DeleteOperation(self._session, self._host, self._interceptor) # type: ignore + + class _DeleteOperation( + _BaseMonitoringRestTransport._BaseDeleteOperation, MonitoringRestStub + ): + def __hash__(self): + return hash("MonitoringRestTransport.DeleteOperation") + + @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: operations_pb2.DeleteOperationRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> None: + r"""Call the delete operation method over HTTP. + + Args: + request (operations_pb2.DeleteOperationRequest): + The request object for DeleteOperation method. + 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`. + """ + + http_options = ( + _BaseMonitoringRestTransport._BaseDeleteOperation._get_http_options() + ) + + request, metadata = self._interceptor.pre_delete_operation( + request, metadata + ) + transcoded_request = _BaseMonitoringRestTransport._BaseDeleteOperation._get_transcoded_request( + http_options, request + ) + + # Jsonify the query params + query_params = _BaseMonitoringRestTransport._BaseDeleteOperation._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 = json_format.MessageToJson(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.cloudsecuritycompliance_v1.MonitoringClient.DeleteOperation", + extra={ + "serviceName": "google.cloud.cloudsecuritycompliance.v1.Monitoring", + "rpcName": "DeleteOperation", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = MonitoringRestTransport._DeleteOperation._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 self._interceptor.post_delete_operation(None) + + @property + def get_operation(self): + return self._GetOperation(self._session, self._host, self._interceptor) # type: ignore + + class _GetOperation( + _BaseMonitoringRestTransport._BaseGetOperation, MonitoringRestStub + ): + def __hash__(self): + return hash("MonitoringRestTransport.GetOperation") + + @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: operations_pb2.GetOperationRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> operations_pb2.Operation: + r"""Call the get operation method over HTTP. + + Args: + request (operations_pb2.GetOperationRequest): + The request object for GetOperation method. + 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: + operations_pb2.Operation: Response from GetOperation method. + """ + + http_options = ( + _BaseMonitoringRestTransport._BaseGetOperation._get_http_options() + ) + + request, metadata = self._interceptor.pre_get_operation(request, metadata) + transcoded_request = ( + _BaseMonitoringRestTransport._BaseGetOperation._get_transcoded_request( + http_options, request + ) + ) + + # Jsonify the query params + query_params = ( + _BaseMonitoringRestTransport._BaseGetOperation._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 = json_format.MessageToJson(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.cloudsecuritycompliance_v1.MonitoringClient.GetOperation", + extra={ + "serviceName": "google.cloud.cloudsecuritycompliance.v1.Monitoring", + "rpcName": "GetOperation", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = MonitoringRestTransport._GetOperation._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) + + content = response.content.decode("utf-8") + resp = operations_pb2.Operation() + resp = json_format.Parse(content, resp) + resp = self._interceptor.post_get_operation(resp) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + try: + response_payload = json_format.MessageToJson(resp) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.cloudsecuritycompliance_v1.MonitoringAsyncClient.GetOperation", + extra={ + "serviceName": "google.cloud.cloudsecuritycompliance.v1.Monitoring", + "rpcName": "GetOperation", + "httpResponse": http_response, + "metadata": http_response["headers"], + }, + ) + return resp + + @property + def list_operations(self): + return self._ListOperations(self._session, self._host, self._interceptor) # type: ignore + + class _ListOperations( + _BaseMonitoringRestTransport._BaseListOperations, MonitoringRestStub + ): + def __hash__(self): + return hash("MonitoringRestTransport.ListOperations") + + @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: operations_pb2.ListOperationsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> operations_pb2.ListOperationsResponse: + r"""Call the list operations method over HTTP. + + Args: + request (operations_pb2.ListOperationsRequest): + The request object for ListOperations method. + 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: + operations_pb2.ListOperationsResponse: Response from ListOperations method. + """ + + http_options = ( + _BaseMonitoringRestTransport._BaseListOperations._get_http_options() + ) + + request, metadata = self._interceptor.pre_list_operations(request, metadata) + transcoded_request = _BaseMonitoringRestTransport._BaseListOperations._get_transcoded_request( + http_options, request + ) + + # Jsonify the query params + query_params = ( + _BaseMonitoringRestTransport._BaseListOperations._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 = json_format.MessageToJson(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.cloud.cloudsecuritycompliance_v1.MonitoringClient.ListOperations", + extra={ + "serviceName": "google.cloud.cloudsecuritycompliance.v1.Monitoring", + "rpcName": "ListOperations", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = MonitoringRestTransport._ListOperations._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) + + content = response.content.decode("utf-8") + resp = operations_pb2.ListOperationsResponse() + resp = json_format.Parse(content, resp) + resp = self._interceptor.post_list_operations(resp) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + try: + response_payload = json_format.MessageToJson(resp) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.cloud.cloudsecuritycompliance_v1.MonitoringAsyncClient.ListOperations", + extra={ + "serviceName": "google.cloud.cloudsecuritycompliance.v1.Monitoring", + "rpcName": "ListOperations", + "httpResponse": http_response, + "metadata": http_response["headers"], + }, + ) + return resp + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__ = ("MonitoringRestTransport",) diff --git a/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/services/monitoring/transports/rest_base.py b/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/services/monitoring/transports/rest_base.py new file mode 100644 index 000000000000..e20fb3e2cb9b --- /dev/null +++ b/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/services/monitoring/transports/rest_base.py @@ -0,0 +1,526 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import 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.cloud.location import locations_pb2 # type: ignore +from google.longrunning import operations_pb2 # type: ignore +from google.protobuf import json_format + +from google.cloud.cloudsecuritycompliance_v1.types import monitoring + +from .base import DEFAULT_CLIENT_INFO, MonitoringTransport + + +class _BaseMonitoringRestTransport(MonitoringTransport): + """Base REST backend transport for Monitoring. + + 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 = "cloudsecuritycompliance.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: 'cloudsecuritycompliance.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 _BaseAggregateFrameworkComplianceReport: + 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": "/v1/{name=organizations/*/locations/*/frameworkComplianceReports/*}:aggregate", + }, + { + "method": "get", + "uri": "/v1/{name=folders/*/locations/*/frameworkComplianceReports/*}:aggregate", + }, + { + "method": "get", + "uri": "/v1/{name=projects/*/locations/*/frameworkComplianceReports/*}:aggregate", + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = monitoring.AggregateFrameworkComplianceReportRequest.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( + _BaseMonitoringRestTransport._BaseAggregateFrameworkComplianceReport._get_unset_required_fields( + query_params + ) + ) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseFetchFrameworkComplianceReport: + 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": "/v1/{name=organizations/*/locations/*/frameworkComplianceReports/*}:fetch", + }, + { + "method": "get", + "uri": "/v1/{name=folders/*/locations/*/frameworkComplianceReports/*}:fetch", + }, + { + "method": "get", + "uri": "/v1/{name=projects/*/locations/*/frameworkComplianceReports/*}:fetch", + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = monitoring.FetchFrameworkComplianceReportRequest.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( + _BaseMonitoringRestTransport._BaseFetchFrameworkComplianceReport._get_unset_required_fields( + query_params + ) + ) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseListControlComplianceSummaries: + 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": "/v1/{parent=organizations/*/locations/*/frameworkComplianceReports/*}/controlComplianceSummaries", + }, + { + "method": "get", + "uri": "/v1/{parent=folders/*/locations/*/frameworkComplianceReports/*}/controlComplianceSummaries", + }, + { + "method": "get", + "uri": "/v1/{parent=projects/*/locations/*/frameworkComplianceReports/*}/controlComplianceSummaries", + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = monitoring.ListControlComplianceSummariesRequest.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( + _BaseMonitoringRestTransport._BaseListControlComplianceSummaries._get_unset_required_fields( + query_params + ) + ) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseListFindingSummaries: + 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": "/v1/{parent=organizations/*/locations/*}/findingSummaries", + }, + { + "method": "get", + "uri": "/v1/{parent=folders/*/locations/*}/findingSummaries", + }, + { + "method": "get", + "uri": "/v1/{parent=projects/*/locations/*}/findingSummaries", + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = monitoring.ListFindingSummariesRequest.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( + _BaseMonitoringRestTransport._BaseListFindingSummaries._get_unset_required_fields( + query_params + ) + ) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseListFrameworkComplianceSummaries: + 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": "/v1/{parent=organizations/*/locations/*}/frameworkComplianceSummaries", + }, + { + "method": "get", + "uri": "/v1/{parent=folders/*/locations/*}/frameworkComplianceSummaries", + }, + { + "method": "get", + "uri": "/v1/{parent=projects/*/locations/*}/frameworkComplianceSummaries", + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = monitoring.ListFrameworkComplianceSummariesRequest.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( + _BaseMonitoringRestTransport._BaseListFrameworkComplianceSummaries._get_unset_required_fields( + query_params + ) + ) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseGetLocation: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1/{name=organizations/*/locations/*}", + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + request_kwargs = json_format.MessageToDict(request) + transcoded_request = path_template.transcode(http_options, **request_kwargs) + return transcoded_request + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads(json.dumps(transcoded_request["query_params"])) + return query_params + + class _BaseListLocations: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1/{name=organizations/*}/locations", + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + request_kwargs = json_format.MessageToDict(request) + transcoded_request = path_template.transcode(http_options, **request_kwargs) + return transcoded_request + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads(json.dumps(transcoded_request["query_params"])) + return query_params + + class _BaseCancelOperation: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v1/{name=organizations/*/locations/*/operations/*}:cancel", + "body": "*", + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + request_kwargs = json_format.MessageToDict(request) + transcoded_request = path_template.transcode(http_options, **request_kwargs) + return transcoded_request + + @staticmethod + def _get_request_body_json(transcoded_request): + body = json.dumps(transcoded_request["body"]) + return body + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads(json.dumps(transcoded_request["query_params"])) + return query_params + + class _BaseDeleteOperation: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [ + { + "method": "delete", + "uri": "/v1/{name=organizations/*/locations/*/operations/*}", + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + request_kwargs = json_format.MessageToDict(request) + transcoded_request = path_template.transcode(http_options, **request_kwargs) + return transcoded_request + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads(json.dumps(transcoded_request["query_params"])) + return query_params + + class _BaseGetOperation: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1/{name=organizations/*/locations/*/operations/*}", + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + request_kwargs = json_format.MessageToDict(request) + transcoded_request = path_template.transcode(http_options, **request_kwargs) + return transcoded_request + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads(json.dumps(transcoded_request["query_params"])) + return query_params + + class _BaseListOperations: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v1/{name=organizations/*/locations/*}/operations", + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + request_kwargs = json_format.MessageToDict(request) + transcoded_request = path_template.transcode(http_options, **request_kwargs) + return transcoded_request + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads(json.dumps(transcoded_request["query_params"])) + return query_params + + +__all__ = ("_BaseMonitoringRestTransport",) diff --git a/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/types/__init__.py b/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/types/__init__.py index d7bedb6888fa..52b649a192dc 100644 --- a/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/types/__init__.py +++ b/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/types/__init__.py @@ -101,6 +101,30 @@ TargetResourceConfig, TargetResourceCreationConfig, ) +from .monitoring import ( + AggregatedComplianceReport, + AggregateFrameworkComplianceReportRequest, + AggregateFrameworkComplianceReportResponse, + CloudControlAssessmentDetails, + CloudControlReport, + ControlAssessmentDetails, + ControlComplianceSummary, + EvaluationState, + FetchFrameworkComplianceReportRequest, + FindingClass, + FindingSummary, + FrameworkComplianceReport, + FrameworkComplianceSummary, + ListControlComplianceSummariesRequest, + ListControlComplianceSummariesResponse, + ListFindingSummariesRequest, + ListFindingSummariesResponse, + ListFrameworkComplianceSummariesRequest, + ListFrameworkComplianceSummariesResponse, + ManualCloudControlAssessmentDetails, + SimilarControls, + TargetResourceDetails, +) __all__ = ( "BucketDestination", @@ -181,4 +205,26 @@ "TargetResourceConfig", "TargetResourceCreationConfig", "DeploymentState", + "AggregatedComplianceReport", + "AggregateFrameworkComplianceReportRequest", + "AggregateFrameworkComplianceReportResponse", + "CloudControlAssessmentDetails", + "CloudControlReport", + "ControlAssessmentDetails", + "ControlComplianceSummary", + "FetchFrameworkComplianceReportRequest", + "FindingSummary", + "FrameworkComplianceReport", + "FrameworkComplianceSummary", + "ListControlComplianceSummariesRequest", + "ListControlComplianceSummariesResponse", + "ListFindingSummariesRequest", + "ListFindingSummariesResponse", + "ListFrameworkComplianceSummariesRequest", + "ListFrameworkComplianceSummariesResponse", + "ManualCloudControlAssessmentDetails", + "SimilarControls", + "TargetResourceDetails", + "EvaluationState", + "FindingClass", ) diff --git a/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/types/monitoring.py b/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/types/monitoring.py new file mode 100644 index 000000000000..d5d4d4750a9c --- /dev/null +++ b/packages/google-cloud-cloudsecuritycompliance/google/cloud/cloudsecuritycompliance_v1/types/monitoring.py @@ -0,0 +1,1034 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from __future__ import annotations + +from typing import MutableMapping, MutableSequence + +from google.protobuf import timestamp_pb2 # type: ignore +from google.type import interval_pb2 # type: ignore +import proto # type: ignore + +from google.cloud.cloudsecuritycompliance_v1.types import common + +__protobuf__ = proto.module( + package="google.cloud.cloudsecuritycompliance.v1", + manifest={ + "EvaluationState", + "FindingClass", + "ListFrameworkComplianceSummariesRequest", + "ListFrameworkComplianceSummariesResponse", + "FrameworkComplianceReport", + "FetchFrameworkComplianceReportRequest", + "ListFindingSummariesRequest", + "ListFindingSummariesResponse", + "ListControlComplianceSummariesRequest", + "ListControlComplianceSummariesResponse", + "AggregateFrameworkComplianceReportRequest", + "AggregateFrameworkComplianceReportResponse", + "ControlAssessmentDetails", + "FrameworkComplianceSummary", + "FindingSummary", + "ControlComplianceSummary", + "CloudControlReport", + "ManualCloudControlAssessmentDetails", + "CloudControlAssessmentDetails", + "SimilarControls", + "AggregatedComplianceReport", + "TargetResourceDetails", + }, +) + + +class EvaluationState(proto.Enum): + r"""The evaluation state of the control. + + Values: + EVALUATION_STATE_UNSPECIFIED (0): + Default value. This value is unused. + EVALUATION_STATE_PASSED (1): + The control is passing. + EVALUATION_STATE_FAILED (2): + The control is failing. + EVALUATION_STATE_NOT_ASSESSED (3): + The control is not assessed. + """ + EVALUATION_STATE_UNSPECIFIED = 0 + EVALUATION_STATE_PASSED = 1 + EVALUATION_STATE_FAILED = 2 + EVALUATION_STATE_NOT_ASSESSED = 3 + + +class FindingClass(proto.Enum): + r"""A finding is a record of assessment data like security, risk, + health, or privacy. + + Values: + FINDING_CLASS_UNSPECIFIED (0): + Default value. This value is unused. + THREAT (1): + The activity is unwanted or malicious. + VULNERABILITY (2): + A potential weakness in software that + increases risk to confidentiality, integrity, + and availability. + MISCONFIGURATION (3): + A potential weakness in a cloud resource or + asset configuration that increases risk. + OBSERVATION (4): + A security observation that is for + informational purposes. + SCC_ERROR (5): + An error that prevents Security Command + Center from functioning properly. + POSTURE_VIOLATION (6): + A potential security risk that's due to a + change in the security posture. + TOXIC_COMBINATION (7): + A combination of security issues that + represent a more severe security problem when + taken together. + SENSITIVE_DATA_RISK (8): + A potential security risk to data assets that + contain sensitive data. + CHOKEPOINT (9): + A resource or resource group where high risk + attack paths converge, based on attack path + simulations (APS). + """ + FINDING_CLASS_UNSPECIFIED = 0 + THREAT = 1 + VULNERABILITY = 2 + MISCONFIGURATION = 3 + OBSERVATION = 4 + SCC_ERROR = 5 + POSTURE_VIOLATION = 6 + TOXIC_COMBINATION = 7 + SENSITIVE_DATA_RISK = 8 + CHOKEPOINT = 9 + + +class ListFrameworkComplianceSummariesRequest(proto.Message): + r"""The request message for + [ListFrameworkComplianceSummariesRequest][google.cloud.cloudsecuritycompliance.v1.ListFrameworkComplianceSummariesRequest]. + + Attributes: + parent (str): + Required. The parent scope for the framework + compliance summary. + page_size (int): + Optional. The requested page size. The server + might return fewer items than requested. If + unspecified, the server picks an appropriate + default. + page_token (str): + Optional. A token that identifies the page of + results that the server should return. + filter (str): + Optional. The filtering results. + """ + + 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, + ) + + +class ListFrameworkComplianceSummariesResponse(proto.Message): + r"""The response message for + [ListFrameworkComplianceSummariesResponse][google.cloud.cloudsecuritycompliance.v1.ListFrameworkComplianceSummariesResponse]. + + Attributes: + framework_compliance_summaries (MutableSequence[google.cloud.cloudsecuritycompliance_v1.types.FrameworkComplianceSummary]): + The list of framework compliance summaries. + next_page_token (str): + Output only. The token to retrieve the next + page of results. + """ + + @property + def raw_page(self): + return self + + framework_compliance_summaries: MutableSequence[ + "FrameworkComplianceSummary" + ] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message="FrameworkComplianceSummary", + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + + +class FrameworkComplianceReport(proto.Message): + r"""The response message for [GetFrameworkComplianceReport][]. + + Attributes: + framework (str): + The name of the framework. + framework_description (str): + The description of the framework. + update_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The last updated time of the + report. + control_assessment_details (google.cloud.cloudsecuritycompliance_v1.types.ControlAssessmentDetails): + The control assessment details of the + framework. + framework_type (google.cloud.cloudsecuritycompliance_v1.types.Framework.FrameworkType): + The type of framework. + supported_cloud_providers (MutableSequence[google.cloud.cloudsecuritycompliance_v1.types.CloudProvider]): + The list of cloud providers supported by the + framework. + framework_categories (MutableSequence[google.cloud.cloudsecuritycompliance_v1.types.FrameworkCategory]): + The list of framework categories supported. + framework_display_name (str): + Optional. The display name for the framework. + name (str): + Identifier. The name of the framework + compliance report. + major_revision_id (int): + The latest major revision ID of the + framework. + minor_revision_id (int): + The latest minor revision ID of the latest + major revision of the framework. + target_resource_details (MutableSequence[google.cloud.cloudsecuritycompliance_v1.types.TargetResourceDetails]): + The target resource details of the framework. + """ + + framework: str = proto.Field( + proto.STRING, + number=1, + ) + framework_description: str = proto.Field( + proto.STRING, + number=2, + ) + update_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=3, + message=timestamp_pb2.Timestamp, + ) + control_assessment_details: "ControlAssessmentDetails" = proto.Field( + proto.MESSAGE, + number=4, + message="ControlAssessmentDetails", + ) + framework_type: common.Framework.FrameworkType = proto.Field( + proto.ENUM, + number=5, + enum=common.Framework.FrameworkType, + ) + supported_cloud_providers: MutableSequence[ + common.CloudProvider + ] = proto.RepeatedField( + proto.ENUM, + number=6, + enum=common.CloudProvider, + ) + framework_categories: MutableSequence[ + common.FrameworkCategory + ] = proto.RepeatedField( + proto.ENUM, + number=7, + enum=common.FrameworkCategory, + ) + framework_display_name: str = proto.Field( + proto.STRING, + number=8, + ) + name: str = proto.Field( + proto.STRING, + number=9, + ) + major_revision_id: int = proto.Field( + proto.INT64, + number=10, + ) + minor_revision_id: int = proto.Field( + proto.INT64, + number=11, + ) + target_resource_details: MutableSequence[ + "TargetResourceDetails" + ] = proto.RepeatedField( + proto.MESSAGE, + number=12, + message="TargetResourceDetails", + ) + + +class FetchFrameworkComplianceReportRequest(proto.Message): + r"""The request message for [FetchFrameworkComplianceReport][]. + + Attributes: + name (str): + Required. The name of the framework + compliance report to retrieve. + end_time (google.protobuf.timestamp_pb2.Timestamp): + Optional. The end time of the report. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + end_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=2, + message=timestamp_pb2.Timestamp, + ) + + +class ListFindingSummariesRequest(proto.Message): + r"""The request message for [ListFindingSummaries][]. + + Attributes: + parent (str): + Required. The parent scope for the framework + overview page. + page_size (int): + Optional. The requested page size. The server + might return fewer items than requested. If + unspecified, the server picks an appropriate + default. + page_token (str): + Optional. A token that identifies the page of + results that the server should return. + filter (str): + Optional. The filtering results. + end_time (google.protobuf.timestamp_pb2.Timestamp): + Optional. The end time of the finding + summary. + """ + + 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, + ) + end_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=5, + message=timestamp_pb2.Timestamp, + ) + + +class ListFindingSummariesResponse(proto.Message): + r"""The response message for [ListFindingSummaries][]. + + Attributes: + finding_summaries (MutableSequence[google.cloud.cloudsecuritycompliance_v1.types.FindingSummary]): + List of finding summary by category. + next_page_token (str): + Output only. The token to retrieve the next + page of results. + """ + + @property + def raw_page(self): + return self + + finding_summaries: MutableSequence["FindingSummary"] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message="FindingSummary", + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + + +class ListControlComplianceSummariesRequest(proto.Message): + r"""The request message for [ListControlComplianceSummaries][]. + + Attributes: + parent (str): + Required. The parent scope for the framework + overview page. + end_time (google.protobuf.timestamp_pb2.Timestamp): + Optional. The end time of the control + compliance summary. + page_size (int): + Optional. The requested page size. The server + might return fewer items than requested. If + unspecified, the server picks an appropriate + default. + page_token (str): + Optional. A token that identifies the page of + results that the server should return. + filter (str): + Optional. The filtering results. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + end_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=2, + message=timestamp_pb2.Timestamp, + ) + page_size: int = proto.Field( + proto.INT32, + number=3, + ) + page_token: str = proto.Field( + proto.STRING, + number=4, + ) + filter: str = proto.Field( + proto.STRING, + number=5, + ) + + +class ListControlComplianceSummariesResponse(proto.Message): + r"""The response message for [ListControlComplianceSummaries][]. + + Attributes: + control_compliance_summaries (MutableSequence[google.cloud.cloudsecuritycompliance_v1.types.ControlComplianceSummary]): + The list of control compliance details. + next_page_token (str): + Output only. The token to retrieve the next + page of results. + """ + + @property + def raw_page(self): + return self + + control_compliance_summaries: MutableSequence[ + "ControlComplianceSummary" + ] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message="ControlComplianceSummary", + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + + +class AggregateFrameworkComplianceReportRequest(proto.Message): + r"""The request message for [AggregateFrameworkComplianceReport][]. + + Attributes: + name (str): + Required. The name of the aggregated compliance report over + time to retrieve. + + The supported format is: + ``organizations/{organization_id}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}`` + interval (google.type.interval_pb2.Interval): + Optional. The start and end time range for + the aggregated compliance report. + filter (str): + Optional. The filtering results. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + interval: interval_pb2.Interval = proto.Field( + proto.MESSAGE, + number=2, + message=interval_pb2.Interval, + ) + filter: str = proto.Field( + proto.STRING, + number=3, + ) + + +class AggregateFrameworkComplianceReportResponse(proto.Message): + r"""The response message for [AggregateFrameworkComplianceReport][]. + + Attributes: + aggregated_compliance_reports (MutableSequence[google.cloud.cloudsecuritycompliance_v1.types.AggregatedComplianceReport]): + The list of aggregated compliance reports. + """ + + aggregated_compliance_reports: MutableSequence[ + "AggregatedComplianceReport" + ] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message="AggregatedComplianceReport", + ) + + +class ControlAssessmentDetails(proto.Message): + r"""The details for a control assessment. + + Attributes: + passing_controls (int): + The number of controls that are passing or + not assessed. + failing_controls (int): + The number of controls that are failing. + assessed_passing_controls (int): + The number of controls that were assessed and + are passing. + not_assessed_controls (int): + The number of controls that aren't assessed + because they require manual review. + """ + + passing_controls: int = proto.Field( + proto.INT32, + number=1, + ) + failing_controls: int = proto.Field( + proto.INT32, + number=2, + ) + assessed_passing_controls: int = proto.Field( + proto.INT32, + number=3, + ) + not_assessed_controls: int = proto.Field( + proto.INT32, + number=4, + ) + + +class FrameworkComplianceSummary(proto.Message): + r"""The details for a framework compliance summary. + + Attributes: + framework (str): + The name of the framework. + control_assessment_details (google.cloud.cloudsecuritycompliance_v1.types.ControlAssessmentDetails): + The control assessment details of the + framework. + framework_type (google.cloud.cloudsecuritycompliance_v1.types.Framework.FrameworkType): + The type of framework. + supported_cloud_providers (MutableSequence[google.cloud.cloudsecuritycompliance_v1.types.CloudProvider]): + The list of cloud providers supported by the + framework. + framework_categories (MutableSequence[google.cloud.cloudsecuritycompliance_v1.types.FrameworkCategory]): + The list of framework categories supported by + the framework. + framework_display_name (str): + Optional. The display name for the framework. + name (str): + Identifier. The name of the framework + compliance summary. + major_revision_id (int): + The major revision ID of the framework. + minor_revision_id (int): + The minor revision ID of the framework. + target_resource_details (MutableSequence[google.cloud.cloudsecuritycompliance_v1.types.TargetResourceDetails]): + The target resource details for the + framework. + """ + + framework: str = proto.Field( + proto.STRING, + number=1, + ) + control_assessment_details: "ControlAssessmentDetails" = proto.Field( + proto.MESSAGE, + number=2, + message="ControlAssessmentDetails", + ) + framework_type: common.Framework.FrameworkType = proto.Field( + proto.ENUM, + number=3, + enum=common.Framework.FrameworkType, + ) + supported_cloud_providers: MutableSequence[ + common.CloudProvider + ] = proto.RepeatedField( + proto.ENUM, + number=4, + enum=common.CloudProvider, + ) + framework_categories: MutableSequence[ + common.FrameworkCategory + ] = proto.RepeatedField( + proto.ENUM, + number=5, + enum=common.FrameworkCategory, + ) + framework_display_name: str = proto.Field( + proto.STRING, + number=6, + ) + name: str = proto.Field( + proto.STRING, + number=7, + ) + major_revision_id: int = proto.Field( + proto.INT64, + number=8, + ) + minor_revision_id: int = proto.Field( + proto.INT64, + number=9, + ) + target_resource_details: MutableSequence[ + "TargetResourceDetails" + ] = proto.RepeatedField( + proto.MESSAGE, + number=10, + message="TargetResourceDetails", + ) + + +class FindingSummary(proto.Message): + r"""The details for a finding. + + Attributes: + finding_category (str): + The category of the finding. + finding_class (google.cloud.cloudsecuritycompliance_v1.types.FindingClass): + The class of the finding. + severity (google.cloud.cloudsecuritycompliance_v1.types.Severity): + The severity of the finding. + finding_count (int): + The count of the finding. + update_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The last updated time of the + finding. + related_frameworks (MutableSequence[str]): + Optional. The list of compliance frameworks + that the finding belongs to. + name (str): + Identifier. The name of the finding summary. + """ + + finding_category: str = proto.Field( + proto.STRING, + number=1, + ) + finding_class: "FindingClass" = proto.Field( + proto.ENUM, + number=2, + enum="FindingClass", + ) + severity: common.Severity = proto.Field( + proto.ENUM, + number=3, + enum=common.Severity, + ) + finding_count: int = proto.Field( + proto.INT64, + number=4, + ) + update_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=5, + message=timestamp_pb2.Timestamp, + ) + related_frameworks: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=6, + ) + name: str = proto.Field( + proto.STRING, + number=7, + ) + + +class ControlComplianceSummary(proto.Message): + r"""The details for control compliance. + + Attributes: + control (str): + The name of the control. + display_name (str): + The display name of the control. + description (str): + The description of the control. + overall_evaluation_state (google.cloud.cloudsecuritycompliance_v1.types.EvaluationState): + Output only. The overall evaluation status of + the control. + total_findings_count (int): + The total number of findings for the control. + compliance_frameworks (MutableSequence[str]): + The list of compliance frameworks that the + control belongs to. + similar_controls (MutableSequence[google.cloud.cloudsecuritycompliance_v1.types.SimilarControls]): + The list of similar controls. + cloud_control_reports (MutableSequence[google.cloud.cloudsecuritycompliance_v1.types.CloudControlReport]): + The list of cloud control reports. + control_responsibility_type (google.cloud.cloudsecuritycompliance_v1.types.RegulatoryControlResponsibilityType): + The responsibility type for the control. + is_fake_control (bool): + Whether the control is a fake control. Fake + controls are created and mapped to cloud + controls that don't belong to a control group. + name (str): + Identifier. The name of the control + compliance summary. + """ + + control: str = proto.Field( + proto.STRING, + number=1, + ) + display_name: str = proto.Field( + proto.STRING, + number=2, + ) + description: str = proto.Field( + proto.STRING, + number=3, + ) + overall_evaluation_state: "EvaluationState" = proto.Field( + proto.ENUM, + number=4, + enum="EvaluationState", + ) + total_findings_count: int = proto.Field( + proto.INT32, + number=5, + ) + compliance_frameworks: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=6, + ) + similar_controls: MutableSequence["SimilarControls"] = proto.RepeatedField( + proto.MESSAGE, + number=7, + message="SimilarControls", + ) + cloud_control_reports: MutableSequence["CloudControlReport"] = proto.RepeatedField( + proto.MESSAGE, + number=8, + message="CloudControlReport", + ) + control_responsibility_type: common.RegulatoryControlResponsibilityType = ( + proto.Field( + proto.ENUM, + number=9, + enum=common.RegulatoryControlResponsibilityType, + ) + ) + is_fake_control: bool = proto.Field( + proto.BOOL, + number=10, + ) + name: str = proto.Field( + proto.STRING, + number=11, + ) + + +class CloudControlReport(proto.Message): + r"""The cloud control report. + + This message has `oneof`_ fields (mutually exclusive fields). + For each oneof, at most one member field can be set at the same time. + Setting any member of the oneof automatically clears all other + members. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + manual_cloud_control_assessment_details (google.cloud.cloudsecuritycompliance_v1.types.ManualCloudControlAssessmentDetails): + The details of a manual cloud control + assessment. + + This field is a member of `oneof`_ ``assessment_details``. + cloud_control_assessment_details (google.cloud.cloudsecuritycompliance_v1.types.CloudControlAssessmentDetails): + The details of a cloud control assessment. + + This field is a member of `oneof`_ ``assessment_details``. + cloud_control (str): + The name of the cloud control. + display_name (str): + The display name of the cloud control. + description (str): + The description of the cloud control. + categories (MutableSequence[str]): + The list of categories for the cloud control. + similar_controls (MutableSequence[google.cloud.cloudsecuritycompliance_v1.types.SimilarControls]): + The list of similar controls. + cloud_control_type (google.cloud.cloudsecuritycompliance_v1.types.CloudControl.Type): + The type of the cloud control. + finding_category (str): + The category of the finding. + rules (MutableSequence[google.cloud.cloudsecuritycompliance_v1.types.Rule]): + The list of rules that correspond to the + cloud control. + finding_severity (google.cloud.cloudsecuritycompliance_v1.types.Severity): + The severity of the finding. + enforcement_mode (google.cloud.cloudsecuritycompliance_v1.types.EnforcementMode): + The enforcement mode of the cloud control. + cloud_control_deployment (str): + The name of the cloud control deployment. + major_revision_id (int): + The major revision ID of the cloud control. + minor_revision_id (int): + The minor revision ID of the cloud control. + framework_major_revision_ids (MutableSequence[int]): + The major revision IDs of the frameworks that + the cloud control belongs to. + """ + + manual_cloud_control_assessment_details: "ManualCloudControlAssessmentDetails" = ( + proto.Field( + proto.MESSAGE, + number=13, + oneof="assessment_details", + message="ManualCloudControlAssessmentDetails", + ) + ) + cloud_control_assessment_details: "CloudControlAssessmentDetails" = proto.Field( + proto.MESSAGE, + number=14, + oneof="assessment_details", + message="CloudControlAssessmentDetails", + ) + cloud_control: str = proto.Field( + proto.STRING, + number=1, + ) + display_name: str = proto.Field( + proto.STRING, + number=2, + ) + description: str = proto.Field( + proto.STRING, + number=3, + ) + categories: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=6, + ) + similar_controls: MutableSequence["SimilarControls"] = proto.RepeatedField( + proto.MESSAGE, + number=9, + message="SimilarControls", + ) + cloud_control_type: common.CloudControl.Type = proto.Field( + proto.ENUM, + number=10, + enum=common.CloudControl.Type, + ) + finding_category: str = proto.Field( + proto.STRING, + number=11, + ) + rules: MutableSequence[common.Rule] = proto.RepeatedField( + proto.MESSAGE, + number=12, + message=common.Rule, + ) + finding_severity: common.Severity = proto.Field( + proto.ENUM, + number=15, + enum=common.Severity, + ) + enforcement_mode: common.EnforcementMode = proto.Field( + proto.ENUM, + number=16, + enum=common.EnforcementMode, + ) + cloud_control_deployment: str = proto.Field( + proto.STRING, + number=17, + ) + major_revision_id: int = proto.Field( + proto.INT64, + number=18, + ) + minor_revision_id: int = proto.Field( + proto.INT64, + number=19, + ) + framework_major_revision_ids: MutableSequence[int] = proto.RepeatedField( + proto.INT64, + number=20, + ) + + +class ManualCloudControlAssessmentDetails(proto.Message): + r"""The details for a manual cloud control assessment. + + Attributes: + manual_cloud_control_guide (MutableSequence[str]): + The guide for assessing a cloud control + manually. + """ + + manual_cloud_control_guide: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=1, + ) + + +class CloudControlAssessmentDetails(proto.Message): + r"""The cloud control assessment details for non-manual cloud + controls. + + Attributes: + findings_count (int): + The number of findings for the cloud control. + evaluation_state (google.cloud.cloudsecuritycompliance_v1.types.EvaluationState): + Output only. The evaluation status of the + cloud control. + """ + + findings_count: int = proto.Field( + proto.INT32, + number=1, + ) + evaluation_state: "EvaluationState" = proto.Field( + proto.ENUM, + number=2, + enum="EvaluationState", + ) + + +class SimilarControls(proto.Message): + r"""The similar controls. + + Attributes: + framework (str): + The name of the framework. + control_id (str): + The ID of the control. + """ + + framework: str = proto.Field( + proto.STRING, + number=1, + ) + control_id: str = proto.Field( + proto.STRING, + number=2, + ) + + +class AggregatedComplianceReport(proto.Message): + r"""The aggregated compliance report. + + Attributes: + control_assessment_details (google.cloud.cloudsecuritycompliance_v1.types.ControlAssessmentDetails): + The control assessment details of the + framework. + report_time (google.protobuf.timestamp_pb2.Timestamp): + The report time of the aggregated compliance + report. + """ + + control_assessment_details: "ControlAssessmentDetails" = proto.Field( + proto.MESSAGE, + number=1, + message="ControlAssessmentDetails", + ) + report_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=2, + message=timestamp_pb2.Timestamp, + ) + + +class TargetResourceDetails(proto.Message): + r"""The details for a target resource. + + Attributes: + framework_deployment (str): + The framework deployment name for the target resource. + + For example, + ``organizations/{organization_id}/locations/{location}/frameworkDeployments/{framework_deployment_id}`` + target_resource_display_name (str): + The display name of the target resource. For example, + ``google.com``, ``staging-project``, or + ``development-folder``. + target_resource (str): + The target resource. For example, + ``organizations/1234567890``, ``projects/1234567890``, or + ``folders/1234567890``. + create_time (google.protobuf.timestamp_pb2.Timestamp): + The create time of the target resource. + update_time (google.protobuf.timestamp_pb2.Timestamp): + The update time of the target resource. + major_revision_id (int): + The major revision ID of the framework for + the target resource. + minor_revision_id (int): + The minor revision ID of the framework for + the target resource. + """ + + framework_deployment: str = proto.Field( + proto.STRING, + number=1, + ) + target_resource_display_name: str = proto.Field( + proto.STRING, + number=2, + ) + target_resource: str = proto.Field( + proto.STRING, + number=3, + ) + create_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=4, + message=timestamp_pb2.Timestamp, + ) + update_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=5, + message=timestamp_pb2.Timestamp, + ) + major_revision_id: int = proto.Field( + proto.INT64, + number=6, + ) + minor_revision_id: int = proto.Field( + proto.INT64, + number=7, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/packages/google-cloud-cloudsecuritycompliance/samples/generated_samples/cloudsecuritycompliance_v1_generated_monitoring_aggregate_framework_compliance_report_async.py b/packages/google-cloud-cloudsecuritycompliance/samples/generated_samples/cloudsecuritycompliance_v1_generated_monitoring_aggregate_framework_compliance_report_async.py new file mode 100644 index 000000000000..75d3cdcec48c --- /dev/null +++ b/packages/google-cloud-cloudsecuritycompliance/samples/generated_samples/cloudsecuritycompliance_v1_generated_monitoring_aggregate_framework_compliance_report_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for AggregateFrameworkComplianceReport +# 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-cloudsecuritycompliance + + +# [START cloudsecuritycompliance_v1_generated_Monitoring_AggregateFrameworkComplianceReport_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 cloudsecuritycompliance_v1 + + +async def sample_aggregate_framework_compliance_report(): + # Create a client + client = cloudsecuritycompliance_v1.MonitoringAsyncClient() + + # Initialize request argument(s) + request = cloudsecuritycompliance_v1.AggregateFrameworkComplianceReportRequest( + name="name_value", + ) + + # Make the request + response = await client.aggregate_framework_compliance_report(request=request) + + # Handle the response + print(response) + + +# [END cloudsecuritycompliance_v1_generated_Monitoring_AggregateFrameworkComplianceReport_async] diff --git a/packages/google-cloud-cloudsecuritycompliance/samples/generated_samples/cloudsecuritycompliance_v1_generated_monitoring_aggregate_framework_compliance_report_sync.py b/packages/google-cloud-cloudsecuritycompliance/samples/generated_samples/cloudsecuritycompliance_v1_generated_monitoring_aggregate_framework_compliance_report_sync.py new file mode 100644 index 000000000000..85809da6115e --- /dev/null +++ b/packages/google-cloud-cloudsecuritycompliance/samples/generated_samples/cloudsecuritycompliance_v1_generated_monitoring_aggregate_framework_compliance_report_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for AggregateFrameworkComplianceReport +# 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-cloudsecuritycompliance + + +# [START cloudsecuritycompliance_v1_generated_Monitoring_AggregateFrameworkComplianceReport_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 cloudsecuritycompliance_v1 + + +def sample_aggregate_framework_compliance_report(): + # Create a client + client = cloudsecuritycompliance_v1.MonitoringClient() + + # Initialize request argument(s) + request = cloudsecuritycompliance_v1.AggregateFrameworkComplianceReportRequest( + name="name_value", + ) + + # Make the request + response = client.aggregate_framework_compliance_report(request=request) + + # Handle the response + print(response) + + +# [END cloudsecuritycompliance_v1_generated_Monitoring_AggregateFrameworkComplianceReport_sync] diff --git a/packages/google-cloud-cloudsecuritycompliance/samples/generated_samples/cloudsecuritycompliance_v1_generated_monitoring_fetch_framework_compliance_report_async.py b/packages/google-cloud-cloudsecuritycompliance/samples/generated_samples/cloudsecuritycompliance_v1_generated_monitoring_fetch_framework_compliance_report_async.py new file mode 100644 index 000000000000..99c42b9a04ed --- /dev/null +++ b/packages/google-cloud-cloudsecuritycompliance/samples/generated_samples/cloudsecuritycompliance_v1_generated_monitoring_fetch_framework_compliance_report_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for FetchFrameworkComplianceReport +# 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-cloudsecuritycompliance + + +# [START cloudsecuritycompliance_v1_generated_Monitoring_FetchFrameworkComplianceReport_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 cloudsecuritycompliance_v1 + + +async def sample_fetch_framework_compliance_report(): + # Create a client + client = cloudsecuritycompliance_v1.MonitoringAsyncClient() + + # Initialize request argument(s) + request = cloudsecuritycompliance_v1.FetchFrameworkComplianceReportRequest( + name="name_value", + ) + + # Make the request + response = await client.fetch_framework_compliance_report(request=request) + + # Handle the response + print(response) + + +# [END cloudsecuritycompliance_v1_generated_Monitoring_FetchFrameworkComplianceReport_async] diff --git a/packages/google-cloud-cloudsecuritycompliance/samples/generated_samples/cloudsecuritycompliance_v1_generated_monitoring_fetch_framework_compliance_report_sync.py b/packages/google-cloud-cloudsecuritycompliance/samples/generated_samples/cloudsecuritycompliance_v1_generated_monitoring_fetch_framework_compliance_report_sync.py new file mode 100644 index 000000000000..87ed6dba9cc5 --- /dev/null +++ b/packages/google-cloud-cloudsecuritycompliance/samples/generated_samples/cloudsecuritycompliance_v1_generated_monitoring_fetch_framework_compliance_report_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for FetchFrameworkComplianceReport +# 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-cloudsecuritycompliance + + +# [START cloudsecuritycompliance_v1_generated_Monitoring_FetchFrameworkComplianceReport_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 cloudsecuritycompliance_v1 + + +def sample_fetch_framework_compliance_report(): + # Create a client + client = cloudsecuritycompliance_v1.MonitoringClient() + + # Initialize request argument(s) + request = cloudsecuritycompliance_v1.FetchFrameworkComplianceReportRequest( + name="name_value", + ) + + # Make the request + response = client.fetch_framework_compliance_report(request=request) + + # Handle the response + print(response) + + +# [END cloudsecuritycompliance_v1_generated_Monitoring_FetchFrameworkComplianceReport_sync] diff --git a/packages/google-cloud-cloudsecuritycompliance/samples/generated_samples/cloudsecuritycompliance_v1_generated_monitoring_list_control_compliance_summaries_async.py b/packages/google-cloud-cloudsecuritycompliance/samples/generated_samples/cloudsecuritycompliance_v1_generated_monitoring_list_control_compliance_summaries_async.py new file mode 100644 index 000000000000..b71d72b18118 --- /dev/null +++ b/packages/google-cloud-cloudsecuritycompliance/samples/generated_samples/cloudsecuritycompliance_v1_generated_monitoring_list_control_compliance_summaries_async.py @@ -0,0 +1,54 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListControlComplianceSummaries +# 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-cloudsecuritycompliance + + +# [START cloudsecuritycompliance_v1_generated_Monitoring_ListControlComplianceSummaries_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 cloudsecuritycompliance_v1 + + +async def sample_list_control_compliance_summaries(): + # Create a client + client = cloudsecuritycompliance_v1.MonitoringAsyncClient() + + # Initialize request argument(s) + request = cloudsecuritycompliance_v1.ListControlComplianceSummariesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_control_compliance_summaries(request=request) + + # Handle the response + async for response in page_result: + print(response) + + +# [END cloudsecuritycompliance_v1_generated_Monitoring_ListControlComplianceSummaries_async] diff --git a/packages/google-cloud-cloudsecuritycompliance/samples/generated_samples/cloudsecuritycompliance_v1_generated_monitoring_list_control_compliance_summaries_sync.py b/packages/google-cloud-cloudsecuritycompliance/samples/generated_samples/cloudsecuritycompliance_v1_generated_monitoring_list_control_compliance_summaries_sync.py new file mode 100644 index 000000000000..04a10778251c --- /dev/null +++ b/packages/google-cloud-cloudsecuritycompliance/samples/generated_samples/cloudsecuritycompliance_v1_generated_monitoring_list_control_compliance_summaries_sync.py @@ -0,0 +1,54 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListControlComplianceSummaries +# 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-cloudsecuritycompliance + + +# [START cloudsecuritycompliance_v1_generated_Monitoring_ListControlComplianceSummaries_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 cloudsecuritycompliance_v1 + + +def sample_list_control_compliance_summaries(): + # Create a client + client = cloudsecuritycompliance_v1.MonitoringClient() + + # Initialize request argument(s) + request = cloudsecuritycompliance_v1.ListControlComplianceSummariesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_control_compliance_summaries(request=request) + + # Handle the response + for response in page_result: + print(response) + + +# [END cloudsecuritycompliance_v1_generated_Monitoring_ListControlComplianceSummaries_sync] diff --git a/packages/google-cloud-cloudsecuritycompliance/samples/generated_samples/cloudsecuritycompliance_v1_generated_monitoring_list_finding_summaries_async.py b/packages/google-cloud-cloudsecuritycompliance/samples/generated_samples/cloudsecuritycompliance_v1_generated_monitoring_list_finding_summaries_async.py new file mode 100644 index 000000000000..4e10aad8c85b --- /dev/null +++ b/packages/google-cloud-cloudsecuritycompliance/samples/generated_samples/cloudsecuritycompliance_v1_generated_monitoring_list_finding_summaries_async.py @@ -0,0 +1,54 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListFindingSummaries +# 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-cloudsecuritycompliance + + +# [START cloudsecuritycompliance_v1_generated_Monitoring_ListFindingSummaries_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 cloudsecuritycompliance_v1 + + +async def sample_list_finding_summaries(): + # Create a client + client = cloudsecuritycompliance_v1.MonitoringAsyncClient() + + # Initialize request argument(s) + request = cloudsecuritycompliance_v1.ListFindingSummariesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_finding_summaries(request=request) + + # Handle the response + async for response in page_result: + print(response) + + +# [END cloudsecuritycompliance_v1_generated_Monitoring_ListFindingSummaries_async] diff --git a/packages/google-cloud-cloudsecuritycompliance/samples/generated_samples/cloudsecuritycompliance_v1_generated_monitoring_list_finding_summaries_sync.py b/packages/google-cloud-cloudsecuritycompliance/samples/generated_samples/cloudsecuritycompliance_v1_generated_monitoring_list_finding_summaries_sync.py new file mode 100644 index 000000000000..7171c7f35929 --- /dev/null +++ b/packages/google-cloud-cloudsecuritycompliance/samples/generated_samples/cloudsecuritycompliance_v1_generated_monitoring_list_finding_summaries_sync.py @@ -0,0 +1,54 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListFindingSummaries +# 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-cloudsecuritycompliance + + +# [START cloudsecuritycompliance_v1_generated_Monitoring_ListFindingSummaries_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 cloudsecuritycompliance_v1 + + +def sample_list_finding_summaries(): + # Create a client + client = cloudsecuritycompliance_v1.MonitoringClient() + + # Initialize request argument(s) + request = cloudsecuritycompliance_v1.ListFindingSummariesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_finding_summaries(request=request) + + # Handle the response + for response in page_result: + print(response) + + +# [END cloudsecuritycompliance_v1_generated_Monitoring_ListFindingSummaries_sync] diff --git a/packages/google-cloud-cloudsecuritycompliance/samples/generated_samples/cloudsecuritycompliance_v1_generated_monitoring_list_framework_compliance_summaries_async.py b/packages/google-cloud-cloudsecuritycompliance/samples/generated_samples/cloudsecuritycompliance_v1_generated_monitoring_list_framework_compliance_summaries_async.py new file mode 100644 index 000000000000..961d7d163740 --- /dev/null +++ b/packages/google-cloud-cloudsecuritycompliance/samples/generated_samples/cloudsecuritycompliance_v1_generated_monitoring_list_framework_compliance_summaries_async.py @@ -0,0 +1,54 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListFrameworkComplianceSummaries +# 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-cloudsecuritycompliance + + +# [START cloudsecuritycompliance_v1_generated_Monitoring_ListFrameworkComplianceSummaries_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 cloudsecuritycompliance_v1 + + +async def sample_list_framework_compliance_summaries(): + # Create a client + client = cloudsecuritycompliance_v1.MonitoringAsyncClient() + + # Initialize request argument(s) + request = cloudsecuritycompliance_v1.ListFrameworkComplianceSummariesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_framework_compliance_summaries(request=request) + + # Handle the response + async for response in page_result: + print(response) + + +# [END cloudsecuritycompliance_v1_generated_Monitoring_ListFrameworkComplianceSummaries_async] diff --git a/packages/google-cloud-cloudsecuritycompliance/samples/generated_samples/cloudsecuritycompliance_v1_generated_monitoring_list_framework_compliance_summaries_sync.py b/packages/google-cloud-cloudsecuritycompliance/samples/generated_samples/cloudsecuritycompliance_v1_generated_monitoring_list_framework_compliance_summaries_sync.py new file mode 100644 index 000000000000..089f739058ac --- /dev/null +++ b/packages/google-cloud-cloudsecuritycompliance/samples/generated_samples/cloudsecuritycompliance_v1_generated_monitoring_list_framework_compliance_summaries_sync.py @@ -0,0 +1,54 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListFrameworkComplianceSummaries +# 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-cloudsecuritycompliance + + +# [START cloudsecuritycompliance_v1_generated_Monitoring_ListFrameworkComplianceSummaries_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 cloudsecuritycompliance_v1 + + +def sample_list_framework_compliance_summaries(): + # Create a client + client = cloudsecuritycompliance_v1.MonitoringClient() + + # Initialize request argument(s) + request = cloudsecuritycompliance_v1.ListFrameworkComplianceSummariesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_framework_compliance_summaries(request=request) + + # Handle the response + for response in page_result: + print(response) + + +# [END cloudsecuritycompliance_v1_generated_Monitoring_ListFrameworkComplianceSummaries_sync] diff --git a/packages/google-cloud-cloudsecuritycompliance/samples/generated_samples/snippet_metadata_google.cloud.cloudsecuritycompliance.v1.json b/packages/google-cloud-cloudsecuritycompliance/samples/generated_samples/snippet_metadata_google.cloud.cloudsecuritycompliance.v1.json index 4a4fcab781bf..523bfe341d28 100644 --- a/packages/google-cloud-cloudsecuritycompliance/samples/generated_samples/snippet_metadata_google.cloud.cloudsecuritycompliance.v1.json +++ b/packages/google-cloud-cloudsecuritycompliance/samples/generated_samples/snippet_metadata_google.cloud.cloudsecuritycompliance.v1.json @@ -3644,6 +3644,811 @@ } ], "title": "cloudsecuritycompliance_v1_generated_deployment_list_framework_deployments_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.cloudsecuritycompliance_v1.MonitoringAsyncClient", + "shortName": "MonitoringAsyncClient" + }, + "fullName": "google.cloud.cloudsecuritycompliance_v1.MonitoringAsyncClient.aggregate_framework_compliance_report", + "method": { + "fullName": "google.cloud.cloudsecuritycompliance.v1.Monitoring.AggregateFrameworkComplianceReport", + "service": { + "fullName": "google.cloud.cloudsecuritycompliance.v1.Monitoring", + "shortName": "Monitoring" + }, + "shortName": "AggregateFrameworkComplianceReport" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.cloudsecuritycompliance_v1.types.AggregateFrameworkComplianceReportRequest" + }, + { + "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.cloudsecuritycompliance_v1.types.AggregateFrameworkComplianceReportResponse", + "shortName": "aggregate_framework_compliance_report" + }, + "description": "Sample for AggregateFrameworkComplianceReport", + "file": "cloudsecuritycompliance_v1_generated_monitoring_aggregate_framework_compliance_report_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudsecuritycompliance_v1_generated_Monitoring_AggregateFrameworkComplianceReport_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": "cloudsecuritycompliance_v1_generated_monitoring_aggregate_framework_compliance_report_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.cloudsecuritycompliance_v1.MonitoringClient", + "shortName": "MonitoringClient" + }, + "fullName": "google.cloud.cloudsecuritycompliance_v1.MonitoringClient.aggregate_framework_compliance_report", + "method": { + "fullName": "google.cloud.cloudsecuritycompliance.v1.Monitoring.AggregateFrameworkComplianceReport", + "service": { + "fullName": "google.cloud.cloudsecuritycompliance.v1.Monitoring", + "shortName": "Monitoring" + }, + "shortName": "AggregateFrameworkComplianceReport" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.cloudsecuritycompliance_v1.types.AggregateFrameworkComplianceReportRequest" + }, + { + "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.cloudsecuritycompliance_v1.types.AggregateFrameworkComplianceReportResponse", + "shortName": "aggregate_framework_compliance_report" + }, + "description": "Sample for AggregateFrameworkComplianceReport", + "file": "cloudsecuritycompliance_v1_generated_monitoring_aggregate_framework_compliance_report_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudsecuritycompliance_v1_generated_Monitoring_AggregateFrameworkComplianceReport_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": "cloudsecuritycompliance_v1_generated_monitoring_aggregate_framework_compliance_report_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.cloudsecuritycompliance_v1.MonitoringAsyncClient", + "shortName": "MonitoringAsyncClient" + }, + "fullName": "google.cloud.cloudsecuritycompliance_v1.MonitoringAsyncClient.fetch_framework_compliance_report", + "method": { + "fullName": "google.cloud.cloudsecuritycompliance.v1.Monitoring.FetchFrameworkComplianceReport", + "service": { + "fullName": "google.cloud.cloudsecuritycompliance.v1.Monitoring", + "shortName": "Monitoring" + }, + "shortName": "FetchFrameworkComplianceReport" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.cloudsecuritycompliance_v1.types.FetchFrameworkComplianceReportRequest" + }, + { + "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.cloudsecuritycompliance_v1.types.FrameworkComplianceReport", + "shortName": "fetch_framework_compliance_report" + }, + "description": "Sample for FetchFrameworkComplianceReport", + "file": "cloudsecuritycompliance_v1_generated_monitoring_fetch_framework_compliance_report_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudsecuritycompliance_v1_generated_Monitoring_FetchFrameworkComplianceReport_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": "cloudsecuritycompliance_v1_generated_monitoring_fetch_framework_compliance_report_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.cloudsecuritycompliance_v1.MonitoringClient", + "shortName": "MonitoringClient" + }, + "fullName": "google.cloud.cloudsecuritycompliance_v1.MonitoringClient.fetch_framework_compliance_report", + "method": { + "fullName": "google.cloud.cloudsecuritycompliance.v1.Monitoring.FetchFrameworkComplianceReport", + "service": { + "fullName": "google.cloud.cloudsecuritycompliance.v1.Monitoring", + "shortName": "Monitoring" + }, + "shortName": "FetchFrameworkComplianceReport" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.cloudsecuritycompliance_v1.types.FetchFrameworkComplianceReportRequest" + }, + { + "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.cloudsecuritycompliance_v1.types.FrameworkComplianceReport", + "shortName": "fetch_framework_compliance_report" + }, + "description": "Sample for FetchFrameworkComplianceReport", + "file": "cloudsecuritycompliance_v1_generated_monitoring_fetch_framework_compliance_report_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudsecuritycompliance_v1_generated_Monitoring_FetchFrameworkComplianceReport_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": "cloudsecuritycompliance_v1_generated_monitoring_fetch_framework_compliance_report_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.cloudsecuritycompliance_v1.MonitoringAsyncClient", + "shortName": "MonitoringAsyncClient" + }, + "fullName": "google.cloud.cloudsecuritycompliance_v1.MonitoringAsyncClient.list_control_compliance_summaries", + "method": { + "fullName": "google.cloud.cloudsecuritycompliance.v1.Monitoring.ListControlComplianceSummaries", + "service": { + "fullName": "google.cloud.cloudsecuritycompliance.v1.Monitoring", + "shortName": "Monitoring" + }, + "shortName": "ListControlComplianceSummaries" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.cloudsecuritycompliance_v1.types.ListControlComplianceSummariesRequest" + }, + { + "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.cloudsecuritycompliance_v1.services.monitoring.pagers.ListControlComplianceSummariesAsyncPager", + "shortName": "list_control_compliance_summaries" + }, + "description": "Sample for ListControlComplianceSummaries", + "file": "cloudsecuritycompliance_v1_generated_monitoring_list_control_compliance_summaries_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudsecuritycompliance_v1_generated_Monitoring_ListControlComplianceSummaries_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": "cloudsecuritycompliance_v1_generated_monitoring_list_control_compliance_summaries_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.cloudsecuritycompliance_v1.MonitoringClient", + "shortName": "MonitoringClient" + }, + "fullName": "google.cloud.cloudsecuritycompliance_v1.MonitoringClient.list_control_compliance_summaries", + "method": { + "fullName": "google.cloud.cloudsecuritycompliance.v1.Monitoring.ListControlComplianceSummaries", + "service": { + "fullName": "google.cloud.cloudsecuritycompliance.v1.Monitoring", + "shortName": "Monitoring" + }, + "shortName": "ListControlComplianceSummaries" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.cloudsecuritycompliance_v1.types.ListControlComplianceSummariesRequest" + }, + { + "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.cloudsecuritycompliance_v1.services.monitoring.pagers.ListControlComplianceSummariesPager", + "shortName": "list_control_compliance_summaries" + }, + "description": "Sample for ListControlComplianceSummaries", + "file": "cloudsecuritycompliance_v1_generated_monitoring_list_control_compliance_summaries_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudsecuritycompliance_v1_generated_Monitoring_ListControlComplianceSummaries_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": "cloudsecuritycompliance_v1_generated_monitoring_list_control_compliance_summaries_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.cloudsecuritycompliance_v1.MonitoringAsyncClient", + "shortName": "MonitoringAsyncClient" + }, + "fullName": "google.cloud.cloudsecuritycompliance_v1.MonitoringAsyncClient.list_finding_summaries", + "method": { + "fullName": "google.cloud.cloudsecuritycompliance.v1.Monitoring.ListFindingSummaries", + "service": { + "fullName": "google.cloud.cloudsecuritycompliance.v1.Monitoring", + "shortName": "Monitoring" + }, + "shortName": "ListFindingSummaries" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.cloudsecuritycompliance_v1.types.ListFindingSummariesRequest" + }, + { + "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.cloudsecuritycompliance_v1.services.monitoring.pagers.ListFindingSummariesAsyncPager", + "shortName": "list_finding_summaries" + }, + "description": "Sample for ListFindingSummaries", + "file": "cloudsecuritycompliance_v1_generated_monitoring_list_finding_summaries_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudsecuritycompliance_v1_generated_Monitoring_ListFindingSummaries_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": "cloudsecuritycompliance_v1_generated_monitoring_list_finding_summaries_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.cloudsecuritycompliance_v1.MonitoringClient", + "shortName": "MonitoringClient" + }, + "fullName": "google.cloud.cloudsecuritycompliance_v1.MonitoringClient.list_finding_summaries", + "method": { + "fullName": "google.cloud.cloudsecuritycompliance.v1.Monitoring.ListFindingSummaries", + "service": { + "fullName": "google.cloud.cloudsecuritycompliance.v1.Monitoring", + "shortName": "Monitoring" + }, + "shortName": "ListFindingSummaries" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.cloudsecuritycompliance_v1.types.ListFindingSummariesRequest" + }, + { + "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.cloudsecuritycompliance_v1.services.monitoring.pagers.ListFindingSummariesPager", + "shortName": "list_finding_summaries" + }, + "description": "Sample for ListFindingSummaries", + "file": "cloudsecuritycompliance_v1_generated_monitoring_list_finding_summaries_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudsecuritycompliance_v1_generated_Monitoring_ListFindingSummaries_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": "cloudsecuritycompliance_v1_generated_monitoring_list_finding_summaries_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.cloudsecuritycompliance_v1.MonitoringAsyncClient", + "shortName": "MonitoringAsyncClient" + }, + "fullName": "google.cloud.cloudsecuritycompliance_v1.MonitoringAsyncClient.list_framework_compliance_summaries", + "method": { + "fullName": "google.cloud.cloudsecuritycompliance.v1.Monitoring.ListFrameworkComplianceSummaries", + "service": { + "fullName": "google.cloud.cloudsecuritycompliance.v1.Monitoring", + "shortName": "Monitoring" + }, + "shortName": "ListFrameworkComplianceSummaries" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.cloudsecuritycompliance_v1.types.ListFrameworkComplianceSummariesRequest" + }, + { + "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.cloudsecuritycompliance_v1.services.monitoring.pagers.ListFrameworkComplianceSummariesAsyncPager", + "shortName": "list_framework_compliance_summaries" + }, + "description": "Sample for ListFrameworkComplianceSummaries", + "file": "cloudsecuritycompliance_v1_generated_monitoring_list_framework_compliance_summaries_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudsecuritycompliance_v1_generated_Monitoring_ListFrameworkComplianceSummaries_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": "cloudsecuritycompliance_v1_generated_monitoring_list_framework_compliance_summaries_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.cloudsecuritycompliance_v1.MonitoringClient", + "shortName": "MonitoringClient" + }, + "fullName": "google.cloud.cloudsecuritycompliance_v1.MonitoringClient.list_framework_compliance_summaries", + "method": { + "fullName": "google.cloud.cloudsecuritycompliance.v1.Monitoring.ListFrameworkComplianceSummaries", + "service": { + "fullName": "google.cloud.cloudsecuritycompliance.v1.Monitoring", + "shortName": "Monitoring" + }, + "shortName": "ListFrameworkComplianceSummaries" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.cloudsecuritycompliance_v1.types.ListFrameworkComplianceSummariesRequest" + }, + { + "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.cloudsecuritycompliance_v1.services.monitoring.pagers.ListFrameworkComplianceSummariesPager", + "shortName": "list_framework_compliance_summaries" + }, + "description": "Sample for ListFrameworkComplianceSummaries", + "file": "cloudsecuritycompliance_v1_generated_monitoring_list_framework_compliance_summaries_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "cloudsecuritycompliance_v1_generated_Monitoring_ListFrameworkComplianceSummaries_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": "cloudsecuritycompliance_v1_generated_monitoring_list_framework_compliance_summaries_sync.py" } ] } diff --git a/packages/google-cloud-cloudsecuritycompliance/scripts/fixup_cloudsecuritycompliance_v1_keywords.py b/packages/google-cloud-cloudsecuritycompliance/scripts/fixup_cloudsecuritycompliance_v1_keywords.py index 92224c429cf7..e05ac1677e0f 100644 --- a/packages/google-cloud-cloudsecuritycompliance/scripts/fixup_cloudsecuritycompliance_v1_keywords.py +++ b/packages/google-cloud-cloudsecuritycompliance/scripts/fixup_cloudsecuritycompliance_v1_keywords.py @@ -39,6 +39,7 @@ def partition( class cloudsecuritycomplianceCallTransformer(cst.CSTTransformer): CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { + 'aggregate_framework_compliance_report': ('name', 'interval', 'filter', ), 'calculate_effective_cm_enrollment': ('name', ), 'create_cloud_control': ('parent', 'cloud_control_id', 'cloud_control', ), 'create_framework': ('parent', 'framework_id', 'framework', ), @@ -47,6 +48,7 @@ class cloudsecuritycomplianceCallTransformer(cst.CSTTransformer): 'delete_cloud_control': ('name', ), 'delete_framework': ('name', ), 'delete_framework_deployment': ('name', 'etag', ), + 'fetch_framework_compliance_report': ('name', 'end_time', ), 'generate_framework_audit_scope_report': ('scope', 'report_format', 'compliance_framework', ), 'get_cloud_control': ('name', 'major_revision_id', ), 'get_cloud_control_deployment': ('name', ), @@ -55,7 +57,10 @@ class cloudsecuritycomplianceCallTransformer(cst.CSTTransformer): 'get_framework_deployment': ('name', ), 'list_cloud_control_deployments': ('parent', 'page_size', 'page_token', 'filter', 'order_by', ), 'list_cloud_controls': ('parent', 'page_size', 'page_token', ), + 'list_control_compliance_summaries': ('parent', 'end_time', 'page_size', 'page_token', 'filter', ), + 'list_finding_summaries': ('parent', 'page_size', 'page_token', 'filter', 'end_time', ), 'list_framework_audits': ('parent', 'page_size', 'page_token', 'filter', ), + 'list_framework_compliance_summaries': ('parent', 'page_size', 'page_token', 'filter', ), 'list_framework_deployments': ('parent', 'page_size', 'page_token', 'filter', 'order_by', ), 'list_frameworks': ('parent', 'page_size', 'page_token', ), 'update_cloud_control': ('cloud_control', 'update_mask', ), diff --git a/packages/google-cloud-cloudsecuritycompliance/tests/unit/gapic/cloudsecuritycompliance_v1/test_monitoring.py b/packages/google-cloud-cloudsecuritycompliance/tests/unit/gapic/cloudsecuritycompliance_v1/test_monitoring.py new file mode 100644 index 000000000000..c11d42c0d618 --- /dev/null +++ b/packages/google-cloud-cloudsecuritycompliance/tests/unit/gapic/cloudsecuritycompliance_v1/test_monitoring.py @@ -0,0 +1,7873 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import 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.cloud.location import locations_pb2 +from google.longrunning import operations_pb2 # type: ignore +from google.oauth2 import service_account +from google.protobuf import timestamp_pb2 # type: ignore +from google.type import interval_pb2 # type: ignore + +from google.cloud.cloudsecuritycompliance_v1.services.monitoring import ( + MonitoringAsyncClient, + MonitoringClient, + pagers, + transports, +) +from google.cloud.cloudsecuritycompliance_v1.types import common, monitoring + +CRED_INFO_JSON = { + "credential_source": "/path/to/file", + "credential_type": "service account credentials", + "principal": "service-account@example.com", +} +CRED_INFO_STRING = json.dumps(CRED_INFO_JSON) + + +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 MonitoringClient._get_default_mtls_endpoint(None) is None + assert ( + MonitoringClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint + ) + assert ( + MonitoringClient._get_default_mtls_endpoint(api_mtls_endpoint) + == api_mtls_endpoint + ) + assert ( + MonitoringClient._get_default_mtls_endpoint(sandbox_endpoint) + == sandbox_mtls_endpoint + ) + assert ( + MonitoringClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) + == sandbox_mtls_endpoint + ) + assert MonitoringClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi + + +def test__read_environment_variables(): + assert MonitoringClient._read_environment_variables() == (False, "auto", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + assert MonitoringClient._read_environment_variables() == (True, "auto", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): + assert MonitoringClient._read_environment_variables() == (False, "auto", None) + + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"} + ): + with pytest.raises(ValueError) as excinfo: + MonitoringClient._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 MonitoringClient._read_environment_variables() == (False, "never", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + assert MonitoringClient._read_environment_variables() == (False, "always", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}): + assert MonitoringClient._read_environment_variables() == (False, "auto", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError) as excinfo: + MonitoringClient._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 MonitoringClient._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 MonitoringClient._get_client_cert_source(None, False) is None + assert ( + MonitoringClient._get_client_cert_source(mock_provided_cert_source, False) + is None + ) + assert ( + MonitoringClient._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 ( + MonitoringClient._get_client_cert_source(None, True) + is mock_default_cert_source + ) + assert ( + MonitoringClient._get_client_cert_source( + mock_provided_cert_source, "true" + ) + is mock_provided_cert_source + ) + + +@mock.patch.object( + MonitoringClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(MonitoringClient), +) +@mock.patch.object( + MonitoringAsyncClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(MonitoringAsyncClient), +) +def test__get_api_endpoint(): + api_override = "foo.com" + mock_client_cert_source = mock.Mock() + default_universe = MonitoringClient._DEFAULT_UNIVERSE + default_endpoint = MonitoringClient._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=default_universe + ) + mock_universe = "bar.com" + mock_endpoint = MonitoringClient._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=mock_universe + ) + + assert ( + MonitoringClient._get_api_endpoint( + api_override, mock_client_cert_source, default_universe, "always" + ) + == api_override + ) + assert ( + MonitoringClient._get_api_endpoint( + None, mock_client_cert_source, default_universe, "auto" + ) + == MonitoringClient.DEFAULT_MTLS_ENDPOINT + ) + assert ( + MonitoringClient._get_api_endpoint(None, None, default_universe, "auto") + == default_endpoint + ) + assert ( + MonitoringClient._get_api_endpoint(None, None, default_universe, "always") + == MonitoringClient.DEFAULT_MTLS_ENDPOINT + ) + assert ( + MonitoringClient._get_api_endpoint( + None, mock_client_cert_source, default_universe, "always" + ) + == MonitoringClient.DEFAULT_MTLS_ENDPOINT + ) + assert ( + MonitoringClient._get_api_endpoint(None, None, mock_universe, "never") + == mock_endpoint + ) + assert ( + MonitoringClient._get_api_endpoint(None, None, default_universe, "never") + == default_endpoint + ) + + with pytest.raises(MutualTLSChannelError) as excinfo: + MonitoringClient._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 ( + MonitoringClient._get_universe_domain( + client_universe_domain, universe_domain_env + ) + == client_universe_domain + ) + assert ( + MonitoringClient._get_universe_domain(None, universe_domain_env) + == universe_domain_env + ) + assert ( + MonitoringClient._get_universe_domain(None, None) + == MonitoringClient._DEFAULT_UNIVERSE + ) + + with pytest.raises(ValueError) as excinfo: + MonitoringClient._get_universe_domain("", None) + assert str(excinfo.value) == "Universe Domain cannot be an empty string." + + +@pytest.mark.parametrize( + "error_code,cred_info_json,show_cred_info", + [ + (401, CRED_INFO_JSON, True), + (403, CRED_INFO_JSON, True), + (404, CRED_INFO_JSON, True), + (500, CRED_INFO_JSON, False), + (401, None, False), + (403, None, False), + (404, None, False), + (500, None, False), + ], +) +def test__add_cred_info_for_auth_errors(error_code, cred_info_json, show_cred_info): + cred = mock.Mock(["get_cred_info"]) + cred.get_cred_info = mock.Mock(return_value=cred_info_json) + client = MonitoringClient(credentials=cred) + client._transport._credentials = cred + + error = core_exceptions.GoogleAPICallError("message", details=["foo"]) + error.code = error_code + + client._add_cred_info_for_auth_errors(error) + if show_cred_info: + assert error.details == ["foo", CRED_INFO_STRING] + else: + assert error.details == ["foo"] + + +@pytest.mark.parametrize("error_code", [401, 403, 404, 500]) +def test__add_cred_info_for_auth_errors_no_get_cred_info(error_code): + cred = mock.Mock([]) + assert not hasattr(cred, "get_cred_info") + client = MonitoringClient(credentials=cred) + client._transport._credentials = cred + + error = core_exceptions.GoogleAPICallError("message", details=[]) + error.code = error_code + + client._add_cred_info_for_auth_errors(error) + assert error.details == [] + + +@pytest.mark.parametrize( + "client_class,transport_name", + [ + (MonitoringClient, "grpc"), + (MonitoringAsyncClient, "grpc_asyncio"), + (MonitoringClient, "rest"), + ], +) +def test_monitoring_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 == ( + "cloudsecuritycompliance.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://cloudsecuritycompliance.googleapis.com" + ) + + +@pytest.mark.parametrize( + "transport_class,transport_name", + [ + (transports.MonitoringGrpcTransport, "grpc"), + (transports.MonitoringGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.MonitoringRestTransport, "rest"), + ], +) +def test_monitoring_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", + [ + (MonitoringClient, "grpc"), + (MonitoringAsyncClient, "grpc_asyncio"), + (MonitoringClient, "rest"), + ], +) +def test_monitoring_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 == ( + "cloudsecuritycompliance.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://cloudsecuritycompliance.googleapis.com" + ) + + +def test_monitoring_client_get_transport_class(): + transport = MonitoringClient.get_transport_class() + available_transports = [ + transports.MonitoringGrpcTransport, + transports.MonitoringRestTransport, + ] + assert transport in available_transports + + transport = MonitoringClient.get_transport_class("grpc") + assert transport == transports.MonitoringGrpcTransport + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name", + [ + (MonitoringClient, transports.MonitoringGrpcTransport, "grpc"), + ( + MonitoringAsyncClient, + transports.MonitoringGrpcAsyncIOTransport, + "grpc_asyncio", + ), + (MonitoringClient, transports.MonitoringRestTransport, "rest"), + ], +) +@mock.patch.object( + MonitoringClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(MonitoringClient), +) +@mock.patch.object( + MonitoringAsyncClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(MonitoringAsyncClient), +) +def test_monitoring_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(MonitoringClient, "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(MonitoringClient, "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", + [ + (MonitoringClient, transports.MonitoringGrpcTransport, "grpc", "true"), + ( + MonitoringAsyncClient, + transports.MonitoringGrpcAsyncIOTransport, + "grpc_asyncio", + "true", + ), + (MonitoringClient, transports.MonitoringGrpcTransport, "grpc", "false"), + ( + MonitoringAsyncClient, + transports.MonitoringGrpcAsyncIOTransport, + "grpc_asyncio", + "false", + ), + (MonitoringClient, transports.MonitoringRestTransport, "rest", "true"), + (MonitoringClient, transports.MonitoringRestTransport, "rest", "false"), + ], +) +@mock.patch.object( + MonitoringClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(MonitoringClient), +) +@mock.patch.object( + MonitoringAsyncClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(MonitoringAsyncClient), +) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_monitoring_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", [MonitoringClient, MonitoringAsyncClient]) +@mock.patch.object( + MonitoringClient, "DEFAULT_ENDPOINT", modify_default_endpoint(MonitoringClient) +) +@mock.patch.object( + MonitoringAsyncClient, + "DEFAULT_ENDPOINT", + modify_default_endpoint(MonitoringAsyncClient), +) +def test_monitoring_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", [MonitoringClient, MonitoringAsyncClient]) +@mock.patch.object( + MonitoringClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(MonitoringClient), +) +@mock.patch.object( + MonitoringAsyncClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(MonitoringAsyncClient), +) +def test_monitoring_client_client_api_endpoint(client_class): + mock_client_cert_source = client_cert_source_callback + api_override = "foo.com" + default_universe = MonitoringClient._DEFAULT_UNIVERSE + default_endpoint = MonitoringClient._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=default_universe + ) + mock_universe = "bar.com" + mock_endpoint = MonitoringClient._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", + [ + (MonitoringClient, transports.MonitoringGrpcTransport, "grpc"), + ( + MonitoringAsyncClient, + transports.MonitoringGrpcAsyncIOTransport, + "grpc_asyncio", + ), + (MonitoringClient, transports.MonitoringRestTransport, "rest"), + ], +) +def test_monitoring_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", + [ + (MonitoringClient, transports.MonitoringGrpcTransport, "grpc", grpc_helpers), + ( + MonitoringAsyncClient, + transports.MonitoringGrpcAsyncIOTransport, + "grpc_asyncio", + grpc_helpers_async, + ), + (MonitoringClient, transports.MonitoringRestTransport, "rest", None), + ], +) +def test_monitoring_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_monitoring_client_client_options_from_dict(): + with mock.patch( + "google.cloud.cloudsecuritycompliance_v1.services.monitoring.transports.MonitoringGrpcTransport.__init__" + ) as grpc_transport: + grpc_transport.return_value = None + client = MonitoringClient(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", + [ + (MonitoringClient, transports.MonitoringGrpcTransport, "grpc", grpc_helpers), + ( + MonitoringAsyncClient, + transports.MonitoringGrpcAsyncIOTransport, + "grpc_asyncio", + grpc_helpers_async, + ), + ], +) +def test_monitoring_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( + "cloudsecuritycompliance.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="cloudsecuritycompliance.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize( + "request_type", + [ + monitoring.ListFrameworkComplianceSummariesRequest, + dict, + ], +) +def test_list_framework_compliance_summaries(request_type, transport: str = "grpc"): + client = MonitoringClient( + 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_framework_compliance_summaries), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = monitoring.ListFrameworkComplianceSummariesResponse( + next_page_token="next_page_token_value", + ) + response = client.list_framework_compliance_summaries(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = monitoring.ListFrameworkComplianceSummariesRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListFrameworkComplianceSummariesPager) + assert response.next_page_token == "next_page_token_value" + + +def test_list_framework_compliance_summaries_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 = MonitoringClient( + 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 = monitoring.ListFrameworkComplianceSummariesRequest( + parent="parent_value", + page_token="page_token_value", + filter="filter_value", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_framework_compliance_summaries), "__call__" + ) as call: + call.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client.list_framework_compliance_summaries(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == monitoring.ListFrameworkComplianceSummariesRequest( + parent="parent_value", + page_token="page_token_value", + filter="filter_value", + ) + + +def test_list_framework_compliance_summaries_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 = MonitoringClient( + 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_framework_compliance_summaries + 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_framework_compliance_summaries + ] = mock_rpc + request = {} + client.list_framework_compliance_summaries(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.list_framework_compliance_summaries(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_framework_compliance_summaries_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 = MonitoringAsyncClient( + 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_framework_compliance_summaries + 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_framework_compliance_summaries + ] = mock_rpc + + request = {} + await client.list_framework_compliance_summaries(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.list_framework_compliance_summaries(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_framework_compliance_summaries_async( + transport: str = "grpc_asyncio", + request_type=monitoring.ListFrameworkComplianceSummariesRequest, +): + client = MonitoringAsyncClient( + 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_framework_compliance_summaries), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + monitoring.ListFrameworkComplianceSummariesResponse( + next_page_token="next_page_token_value", + ) + ) + response = await client.list_framework_compliance_summaries(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = monitoring.ListFrameworkComplianceSummariesRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListFrameworkComplianceSummariesAsyncPager) + assert response.next_page_token == "next_page_token_value" + + +@pytest.mark.asyncio +async def test_list_framework_compliance_summaries_async_from_dict(): + await test_list_framework_compliance_summaries_async(request_type=dict) + + +def test_list_framework_compliance_summaries_field_headers(): + client = MonitoringClient( + 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 = monitoring.ListFrameworkComplianceSummariesRequest() + + request.parent = "parent_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_framework_compliance_summaries), "__call__" + ) as call: + call.return_value = monitoring.ListFrameworkComplianceSummariesResponse() + client.list_framework_compliance_summaries(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_framework_compliance_summaries_field_headers_async(): + client = MonitoringAsyncClient( + 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 = monitoring.ListFrameworkComplianceSummariesRequest() + + request.parent = "parent_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_framework_compliance_summaries), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + monitoring.ListFrameworkComplianceSummariesResponse() + ) + await client.list_framework_compliance_summaries(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_framework_compliance_summaries_flattened(): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_framework_compliance_summaries), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = monitoring.ListFrameworkComplianceSummariesResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_framework_compliance_summaries( + 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_framework_compliance_summaries_flattened_error(): + client = MonitoringClient( + 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_framework_compliance_summaries( + monitoring.ListFrameworkComplianceSummariesRequest(), + parent="parent_value", + ) + + +@pytest.mark.asyncio +async def test_list_framework_compliance_summaries_flattened_async(): + client = MonitoringAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_framework_compliance_summaries), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = monitoring.ListFrameworkComplianceSummariesResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + monitoring.ListFrameworkComplianceSummariesResponse() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_framework_compliance_summaries( + 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_framework_compliance_summaries_flattened_error_async(): + client = MonitoringAsyncClient( + 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_framework_compliance_summaries( + monitoring.ListFrameworkComplianceSummariesRequest(), + parent="parent_value", + ) + + +def test_list_framework_compliance_summaries_pager(transport_name: str = "grpc"): + client = MonitoringClient( + 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_framework_compliance_summaries), "__call__" + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + monitoring.ListFrameworkComplianceSummariesResponse( + framework_compliance_summaries=[ + monitoring.FrameworkComplianceSummary(), + monitoring.FrameworkComplianceSummary(), + monitoring.FrameworkComplianceSummary(), + ], + next_page_token="abc", + ), + monitoring.ListFrameworkComplianceSummariesResponse( + framework_compliance_summaries=[], + next_page_token="def", + ), + monitoring.ListFrameworkComplianceSummariesResponse( + framework_compliance_summaries=[ + monitoring.FrameworkComplianceSummary(), + ], + next_page_token="ghi", + ), + monitoring.ListFrameworkComplianceSummariesResponse( + framework_compliance_summaries=[ + monitoring.FrameworkComplianceSummary(), + monitoring.FrameworkComplianceSummary(), + ], + ), + RuntimeError, + ) + + expected_metadata = () + retry = retries.Retry() + timeout = 5 + expected_metadata = tuple(expected_metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", ""),)), + ) + pager = client.list_framework_compliance_summaries( + 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, monitoring.FrameworkComplianceSummary) for i in results + ) + + +def test_list_framework_compliance_summaries_pages(transport_name: str = "grpc"): + client = MonitoringClient( + 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_framework_compliance_summaries), "__call__" + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + monitoring.ListFrameworkComplianceSummariesResponse( + framework_compliance_summaries=[ + monitoring.FrameworkComplianceSummary(), + monitoring.FrameworkComplianceSummary(), + monitoring.FrameworkComplianceSummary(), + ], + next_page_token="abc", + ), + monitoring.ListFrameworkComplianceSummariesResponse( + framework_compliance_summaries=[], + next_page_token="def", + ), + monitoring.ListFrameworkComplianceSummariesResponse( + framework_compliance_summaries=[ + monitoring.FrameworkComplianceSummary(), + ], + next_page_token="ghi", + ), + monitoring.ListFrameworkComplianceSummariesResponse( + framework_compliance_summaries=[ + monitoring.FrameworkComplianceSummary(), + monitoring.FrameworkComplianceSummary(), + ], + ), + RuntimeError, + ) + pages = list(client.list_framework_compliance_summaries(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_framework_compliance_summaries_async_pager(): + client = MonitoringAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_framework_compliance_summaries), + "__call__", + new_callable=mock.AsyncMock, + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + monitoring.ListFrameworkComplianceSummariesResponse( + framework_compliance_summaries=[ + monitoring.FrameworkComplianceSummary(), + monitoring.FrameworkComplianceSummary(), + monitoring.FrameworkComplianceSummary(), + ], + next_page_token="abc", + ), + monitoring.ListFrameworkComplianceSummariesResponse( + framework_compliance_summaries=[], + next_page_token="def", + ), + monitoring.ListFrameworkComplianceSummariesResponse( + framework_compliance_summaries=[ + monitoring.FrameworkComplianceSummary(), + ], + next_page_token="ghi", + ), + monitoring.ListFrameworkComplianceSummariesResponse( + framework_compliance_summaries=[ + monitoring.FrameworkComplianceSummary(), + monitoring.FrameworkComplianceSummary(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_framework_compliance_summaries( + 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, monitoring.FrameworkComplianceSummary) for i in responses + ) + + +@pytest.mark.asyncio +async def test_list_framework_compliance_summaries_async_pages(): + client = MonitoringAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_framework_compliance_summaries), + "__call__", + new_callable=mock.AsyncMock, + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + monitoring.ListFrameworkComplianceSummariesResponse( + framework_compliance_summaries=[ + monitoring.FrameworkComplianceSummary(), + monitoring.FrameworkComplianceSummary(), + monitoring.FrameworkComplianceSummary(), + ], + next_page_token="abc", + ), + monitoring.ListFrameworkComplianceSummariesResponse( + framework_compliance_summaries=[], + next_page_token="def", + ), + monitoring.ListFrameworkComplianceSummariesResponse( + framework_compliance_summaries=[ + monitoring.FrameworkComplianceSummary(), + ], + next_page_token="ghi", + ), + monitoring.ListFrameworkComplianceSummariesResponse( + framework_compliance_summaries=[ + monitoring.FrameworkComplianceSummary(), + monitoring.FrameworkComplianceSummary(), + ], + ), + 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_framework_compliance_summaries(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", + [ + monitoring.ListFindingSummariesRequest, + dict, + ], +) +def test_list_finding_summaries(request_type, transport: str = "grpc"): + client = MonitoringClient( + 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_finding_summaries), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = monitoring.ListFindingSummariesResponse( + next_page_token="next_page_token_value", + ) + response = client.list_finding_summaries(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = monitoring.ListFindingSummariesRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListFindingSummariesPager) + assert response.next_page_token == "next_page_token_value" + + +def test_list_finding_summaries_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 = MonitoringClient( + 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 = monitoring.ListFindingSummariesRequest( + parent="parent_value", + page_token="page_token_value", + filter="filter_value", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_finding_summaries), "__call__" + ) as call: + call.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client.list_finding_summaries(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == monitoring.ListFindingSummariesRequest( + parent="parent_value", + page_token="page_token_value", + filter="filter_value", + ) + + +def test_list_finding_summaries_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 = MonitoringClient( + 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_finding_summaries + 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_finding_summaries + ] = mock_rpc + request = {} + client.list_finding_summaries(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.list_finding_summaries(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_finding_summaries_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 = MonitoringAsyncClient( + 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_finding_summaries + 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_finding_summaries + ] = mock_rpc + + request = {} + await client.list_finding_summaries(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.list_finding_summaries(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_finding_summaries_async( + transport: str = "grpc_asyncio", request_type=monitoring.ListFindingSummariesRequest +): + client = MonitoringAsyncClient( + 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_finding_summaries), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + monitoring.ListFindingSummariesResponse( + next_page_token="next_page_token_value", + ) + ) + response = await client.list_finding_summaries(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = monitoring.ListFindingSummariesRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListFindingSummariesAsyncPager) + assert response.next_page_token == "next_page_token_value" + + +@pytest.mark.asyncio +async def test_list_finding_summaries_async_from_dict(): + await test_list_finding_summaries_async(request_type=dict) + + +def test_list_finding_summaries_field_headers(): + client = MonitoringClient( + 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 = monitoring.ListFindingSummariesRequest() + + request.parent = "parent_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_finding_summaries), "__call__" + ) as call: + call.return_value = monitoring.ListFindingSummariesResponse() + client.list_finding_summaries(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_finding_summaries_field_headers_async(): + client = MonitoringAsyncClient( + 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 = monitoring.ListFindingSummariesRequest() + + request.parent = "parent_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_finding_summaries), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + monitoring.ListFindingSummariesResponse() + ) + await client.list_finding_summaries(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_finding_summaries_flattened(): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_finding_summaries), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = monitoring.ListFindingSummariesResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_finding_summaries( + 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_finding_summaries_flattened_error(): + client = MonitoringClient( + 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_finding_summaries( + monitoring.ListFindingSummariesRequest(), + parent="parent_value", + ) + + +@pytest.mark.asyncio +async def test_list_finding_summaries_flattened_async(): + client = MonitoringAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_finding_summaries), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = monitoring.ListFindingSummariesResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + monitoring.ListFindingSummariesResponse() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_finding_summaries( + 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_finding_summaries_flattened_error_async(): + client = MonitoringAsyncClient( + 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_finding_summaries( + monitoring.ListFindingSummariesRequest(), + parent="parent_value", + ) + + +def test_list_finding_summaries_pager(transport_name: str = "grpc"): + client = MonitoringClient( + 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_finding_summaries), "__call__" + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + monitoring.ListFindingSummariesResponse( + finding_summaries=[ + monitoring.FindingSummary(), + monitoring.FindingSummary(), + monitoring.FindingSummary(), + ], + next_page_token="abc", + ), + monitoring.ListFindingSummariesResponse( + finding_summaries=[], + next_page_token="def", + ), + monitoring.ListFindingSummariesResponse( + finding_summaries=[ + monitoring.FindingSummary(), + ], + next_page_token="ghi", + ), + monitoring.ListFindingSummariesResponse( + finding_summaries=[ + monitoring.FindingSummary(), + monitoring.FindingSummary(), + ], + ), + RuntimeError, + ) + + expected_metadata = () + retry = retries.Retry() + timeout = 5 + expected_metadata = tuple(expected_metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", ""),)), + ) + pager = client.list_finding_summaries(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, monitoring.FindingSummary) for i in results) + + +def test_list_finding_summaries_pages(transport_name: str = "grpc"): + client = MonitoringClient( + 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_finding_summaries), "__call__" + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + monitoring.ListFindingSummariesResponse( + finding_summaries=[ + monitoring.FindingSummary(), + monitoring.FindingSummary(), + monitoring.FindingSummary(), + ], + next_page_token="abc", + ), + monitoring.ListFindingSummariesResponse( + finding_summaries=[], + next_page_token="def", + ), + monitoring.ListFindingSummariesResponse( + finding_summaries=[ + monitoring.FindingSummary(), + ], + next_page_token="ghi", + ), + monitoring.ListFindingSummariesResponse( + finding_summaries=[ + monitoring.FindingSummary(), + monitoring.FindingSummary(), + ], + ), + RuntimeError, + ) + pages = list(client.list_finding_summaries(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_finding_summaries_async_pager(): + client = MonitoringAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_finding_summaries), + "__call__", + new_callable=mock.AsyncMock, + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + monitoring.ListFindingSummariesResponse( + finding_summaries=[ + monitoring.FindingSummary(), + monitoring.FindingSummary(), + monitoring.FindingSummary(), + ], + next_page_token="abc", + ), + monitoring.ListFindingSummariesResponse( + finding_summaries=[], + next_page_token="def", + ), + monitoring.ListFindingSummariesResponse( + finding_summaries=[ + monitoring.FindingSummary(), + ], + next_page_token="ghi", + ), + monitoring.ListFindingSummariesResponse( + finding_summaries=[ + monitoring.FindingSummary(), + monitoring.FindingSummary(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_finding_summaries( + 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, monitoring.FindingSummary) for i in responses) + + +@pytest.mark.asyncio +async def test_list_finding_summaries_async_pages(): + client = MonitoringAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_finding_summaries), + "__call__", + new_callable=mock.AsyncMock, + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + monitoring.ListFindingSummariesResponse( + finding_summaries=[ + monitoring.FindingSummary(), + monitoring.FindingSummary(), + monitoring.FindingSummary(), + ], + next_page_token="abc", + ), + monitoring.ListFindingSummariesResponse( + finding_summaries=[], + next_page_token="def", + ), + monitoring.ListFindingSummariesResponse( + finding_summaries=[ + monitoring.FindingSummary(), + ], + next_page_token="ghi", + ), + monitoring.ListFindingSummariesResponse( + finding_summaries=[ + monitoring.FindingSummary(), + monitoring.FindingSummary(), + ], + ), + 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_finding_summaries(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", + [ + monitoring.FetchFrameworkComplianceReportRequest, + dict, + ], +) +def test_fetch_framework_compliance_report(request_type, transport: str = "grpc"): + client = MonitoringClient( + 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.fetch_framework_compliance_report), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = monitoring.FrameworkComplianceReport( + framework="framework_value", + framework_description="framework_description_value", + framework_type=common.Framework.FrameworkType.BUILT_IN, + supported_cloud_providers=[common.CloudProvider.AWS], + framework_categories=[common.FrameworkCategory.INDUSTRY_DEFINED_STANDARD], + framework_display_name="framework_display_name_value", + name="name_value", + major_revision_id=1811, + minor_revision_id=1823, + ) + response = client.fetch_framework_compliance_report(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = monitoring.FetchFrameworkComplianceReportRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, monitoring.FrameworkComplianceReport) + assert response.framework == "framework_value" + assert response.framework_description == "framework_description_value" + assert response.framework_type == common.Framework.FrameworkType.BUILT_IN + assert response.supported_cloud_providers == [common.CloudProvider.AWS] + assert response.framework_categories == [ + common.FrameworkCategory.INDUSTRY_DEFINED_STANDARD + ] + assert response.framework_display_name == "framework_display_name_value" + assert response.name == "name_value" + assert response.major_revision_id == 1811 + assert response.minor_revision_id == 1823 + + +def test_fetch_framework_compliance_report_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 = MonitoringClient( + 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 = monitoring.FetchFrameworkComplianceReportRequest( + name="name_value", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.fetch_framework_compliance_report), "__call__" + ) as call: + call.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client.fetch_framework_compliance_report(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == monitoring.FetchFrameworkComplianceReportRequest( + name="name_value", + ) + + +def test_fetch_framework_compliance_report_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 = MonitoringClient( + 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.fetch_framework_compliance_report + 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.fetch_framework_compliance_report + ] = mock_rpc + request = {} + client.fetch_framework_compliance_report(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.fetch_framework_compliance_report(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_fetch_framework_compliance_report_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 = MonitoringAsyncClient( + 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.fetch_framework_compliance_report + 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.fetch_framework_compliance_report + ] = mock_rpc + + request = {} + await client.fetch_framework_compliance_report(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.fetch_framework_compliance_report(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_fetch_framework_compliance_report_async( + transport: str = "grpc_asyncio", + request_type=monitoring.FetchFrameworkComplianceReportRequest, +): + client = MonitoringAsyncClient( + 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.fetch_framework_compliance_report), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + monitoring.FrameworkComplianceReport( + framework="framework_value", + framework_description="framework_description_value", + framework_type=common.Framework.FrameworkType.BUILT_IN, + supported_cloud_providers=[common.CloudProvider.AWS], + framework_categories=[ + common.FrameworkCategory.INDUSTRY_DEFINED_STANDARD + ], + framework_display_name="framework_display_name_value", + name="name_value", + major_revision_id=1811, + minor_revision_id=1823, + ) + ) + response = await client.fetch_framework_compliance_report(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = monitoring.FetchFrameworkComplianceReportRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, monitoring.FrameworkComplianceReport) + assert response.framework == "framework_value" + assert response.framework_description == "framework_description_value" + assert response.framework_type == common.Framework.FrameworkType.BUILT_IN + assert response.supported_cloud_providers == [common.CloudProvider.AWS] + assert response.framework_categories == [ + common.FrameworkCategory.INDUSTRY_DEFINED_STANDARD + ] + assert response.framework_display_name == "framework_display_name_value" + assert response.name == "name_value" + assert response.major_revision_id == 1811 + assert response.minor_revision_id == 1823 + + +@pytest.mark.asyncio +async def test_fetch_framework_compliance_report_async_from_dict(): + await test_fetch_framework_compliance_report_async(request_type=dict) + + +def test_fetch_framework_compliance_report_field_headers(): + client = MonitoringClient( + 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 = monitoring.FetchFrameworkComplianceReportRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.fetch_framework_compliance_report), "__call__" + ) as call: + call.return_value = monitoring.FrameworkComplianceReport() + client.fetch_framework_compliance_report(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_fetch_framework_compliance_report_field_headers_async(): + client = MonitoringAsyncClient( + 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 = monitoring.FetchFrameworkComplianceReportRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.fetch_framework_compliance_report), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + monitoring.FrameworkComplianceReport() + ) + await client.fetch_framework_compliance_report(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_fetch_framework_compliance_report_flattened(): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.fetch_framework_compliance_report), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = monitoring.FrameworkComplianceReport() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.fetch_framework_compliance_report( + 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_fetch_framework_compliance_report_flattened_error(): + client = MonitoringClient( + 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.fetch_framework_compliance_report( + monitoring.FetchFrameworkComplianceReportRequest(), + name="name_value", + ) + + +@pytest.mark.asyncio +async def test_fetch_framework_compliance_report_flattened_async(): + client = MonitoringAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.fetch_framework_compliance_report), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = monitoring.FrameworkComplianceReport() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + monitoring.FrameworkComplianceReport() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.fetch_framework_compliance_report( + 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_fetch_framework_compliance_report_flattened_error_async(): + client = MonitoringAsyncClient( + 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.fetch_framework_compliance_report( + monitoring.FetchFrameworkComplianceReportRequest(), + name="name_value", + ) + + +@pytest.mark.parametrize( + "request_type", + [ + monitoring.ListControlComplianceSummariesRequest, + dict, + ], +) +def test_list_control_compliance_summaries(request_type, transport: str = "grpc"): + client = MonitoringClient( + 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_control_compliance_summaries), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = monitoring.ListControlComplianceSummariesResponse( + next_page_token="next_page_token_value", + ) + response = client.list_control_compliance_summaries(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = monitoring.ListControlComplianceSummariesRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListControlComplianceSummariesPager) + assert response.next_page_token == "next_page_token_value" + + +def test_list_control_compliance_summaries_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 = MonitoringClient( + 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 = monitoring.ListControlComplianceSummariesRequest( + parent="parent_value", + page_token="page_token_value", + filter="filter_value", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_control_compliance_summaries), "__call__" + ) as call: + call.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client.list_control_compliance_summaries(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == monitoring.ListControlComplianceSummariesRequest( + parent="parent_value", + page_token="page_token_value", + filter="filter_value", + ) + + +def test_list_control_compliance_summaries_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 = MonitoringClient( + 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_control_compliance_summaries + 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_control_compliance_summaries + ] = mock_rpc + request = {} + client.list_control_compliance_summaries(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.list_control_compliance_summaries(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_control_compliance_summaries_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 = MonitoringAsyncClient( + 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_control_compliance_summaries + 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_control_compliance_summaries + ] = mock_rpc + + request = {} + await client.list_control_compliance_summaries(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.list_control_compliance_summaries(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_control_compliance_summaries_async( + transport: str = "grpc_asyncio", + request_type=monitoring.ListControlComplianceSummariesRequest, +): + client = MonitoringAsyncClient( + 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_control_compliance_summaries), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + monitoring.ListControlComplianceSummariesResponse( + next_page_token="next_page_token_value", + ) + ) + response = await client.list_control_compliance_summaries(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = monitoring.ListControlComplianceSummariesRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListControlComplianceSummariesAsyncPager) + assert response.next_page_token == "next_page_token_value" + + +@pytest.mark.asyncio +async def test_list_control_compliance_summaries_async_from_dict(): + await test_list_control_compliance_summaries_async(request_type=dict) + + +def test_list_control_compliance_summaries_field_headers(): + client = MonitoringClient( + 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 = monitoring.ListControlComplianceSummariesRequest() + + request.parent = "parent_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_control_compliance_summaries), "__call__" + ) as call: + call.return_value = monitoring.ListControlComplianceSummariesResponse() + client.list_control_compliance_summaries(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_control_compliance_summaries_field_headers_async(): + client = MonitoringAsyncClient( + 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 = monitoring.ListControlComplianceSummariesRequest() + + request.parent = "parent_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_control_compliance_summaries), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + monitoring.ListControlComplianceSummariesResponse() + ) + await client.list_control_compliance_summaries(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_control_compliance_summaries_flattened(): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_control_compliance_summaries), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = monitoring.ListControlComplianceSummariesResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_control_compliance_summaries( + 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_control_compliance_summaries_flattened_error(): + client = MonitoringClient( + 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_control_compliance_summaries( + monitoring.ListControlComplianceSummariesRequest(), + parent="parent_value", + ) + + +@pytest.mark.asyncio +async def test_list_control_compliance_summaries_flattened_async(): + client = MonitoringAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_control_compliance_summaries), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = monitoring.ListControlComplianceSummariesResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + monitoring.ListControlComplianceSummariesResponse() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_control_compliance_summaries( + 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_control_compliance_summaries_flattened_error_async(): + client = MonitoringAsyncClient( + 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_control_compliance_summaries( + monitoring.ListControlComplianceSummariesRequest(), + parent="parent_value", + ) + + +def test_list_control_compliance_summaries_pager(transport_name: str = "grpc"): + client = MonitoringClient( + 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_control_compliance_summaries), "__call__" + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + monitoring.ListControlComplianceSummariesResponse( + control_compliance_summaries=[ + monitoring.ControlComplianceSummary(), + monitoring.ControlComplianceSummary(), + monitoring.ControlComplianceSummary(), + ], + next_page_token="abc", + ), + monitoring.ListControlComplianceSummariesResponse( + control_compliance_summaries=[], + next_page_token="def", + ), + monitoring.ListControlComplianceSummariesResponse( + control_compliance_summaries=[ + monitoring.ControlComplianceSummary(), + ], + next_page_token="ghi", + ), + monitoring.ListControlComplianceSummariesResponse( + control_compliance_summaries=[ + monitoring.ControlComplianceSummary(), + monitoring.ControlComplianceSummary(), + ], + ), + RuntimeError, + ) + + expected_metadata = () + retry = retries.Retry() + timeout = 5 + expected_metadata = tuple(expected_metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", ""),)), + ) + pager = client.list_control_compliance_summaries( + 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, monitoring.ControlComplianceSummary) for i in results) + + +def test_list_control_compliance_summaries_pages(transport_name: str = "grpc"): + client = MonitoringClient( + 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_control_compliance_summaries), "__call__" + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + monitoring.ListControlComplianceSummariesResponse( + control_compliance_summaries=[ + monitoring.ControlComplianceSummary(), + monitoring.ControlComplianceSummary(), + monitoring.ControlComplianceSummary(), + ], + next_page_token="abc", + ), + monitoring.ListControlComplianceSummariesResponse( + control_compliance_summaries=[], + next_page_token="def", + ), + monitoring.ListControlComplianceSummariesResponse( + control_compliance_summaries=[ + monitoring.ControlComplianceSummary(), + ], + next_page_token="ghi", + ), + monitoring.ListControlComplianceSummariesResponse( + control_compliance_summaries=[ + monitoring.ControlComplianceSummary(), + monitoring.ControlComplianceSummary(), + ], + ), + RuntimeError, + ) + pages = list(client.list_control_compliance_summaries(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_control_compliance_summaries_async_pager(): + client = MonitoringAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_control_compliance_summaries), + "__call__", + new_callable=mock.AsyncMock, + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + monitoring.ListControlComplianceSummariesResponse( + control_compliance_summaries=[ + monitoring.ControlComplianceSummary(), + monitoring.ControlComplianceSummary(), + monitoring.ControlComplianceSummary(), + ], + next_page_token="abc", + ), + monitoring.ListControlComplianceSummariesResponse( + control_compliance_summaries=[], + next_page_token="def", + ), + monitoring.ListControlComplianceSummariesResponse( + control_compliance_summaries=[ + monitoring.ControlComplianceSummary(), + ], + next_page_token="ghi", + ), + monitoring.ListControlComplianceSummariesResponse( + control_compliance_summaries=[ + monitoring.ControlComplianceSummary(), + monitoring.ControlComplianceSummary(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_control_compliance_summaries( + 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, monitoring.ControlComplianceSummary) for i in responses + ) + + +@pytest.mark.asyncio +async def test_list_control_compliance_summaries_async_pages(): + client = MonitoringAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_control_compliance_summaries), + "__call__", + new_callable=mock.AsyncMock, + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + monitoring.ListControlComplianceSummariesResponse( + control_compliance_summaries=[ + monitoring.ControlComplianceSummary(), + monitoring.ControlComplianceSummary(), + monitoring.ControlComplianceSummary(), + ], + next_page_token="abc", + ), + monitoring.ListControlComplianceSummariesResponse( + control_compliance_summaries=[], + next_page_token="def", + ), + monitoring.ListControlComplianceSummariesResponse( + control_compliance_summaries=[ + monitoring.ControlComplianceSummary(), + ], + next_page_token="ghi", + ), + monitoring.ListControlComplianceSummariesResponse( + control_compliance_summaries=[ + monitoring.ControlComplianceSummary(), + monitoring.ControlComplianceSummary(), + ], + ), + 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_control_compliance_summaries(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", + [ + monitoring.AggregateFrameworkComplianceReportRequest, + dict, + ], +) +def test_aggregate_framework_compliance_report(request_type, transport: str = "grpc"): + client = MonitoringClient( + 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.aggregate_framework_compliance_report), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = monitoring.AggregateFrameworkComplianceReportResponse() + response = client.aggregate_framework_compliance_report(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = monitoring.AggregateFrameworkComplianceReportRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, monitoring.AggregateFrameworkComplianceReportResponse) + + +def test_aggregate_framework_compliance_report_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 = MonitoringClient( + 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 = monitoring.AggregateFrameworkComplianceReportRequest( + name="name_value", + filter="filter_value", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.aggregate_framework_compliance_report), "__call__" + ) as call: + call.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client.aggregate_framework_compliance_report(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == monitoring.AggregateFrameworkComplianceReportRequest( + name="name_value", + filter="filter_value", + ) + + +def test_aggregate_framework_compliance_report_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 = MonitoringClient( + 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.aggregate_framework_compliance_report + 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.aggregate_framework_compliance_report + ] = mock_rpc + request = {} + client.aggregate_framework_compliance_report(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.aggregate_framework_compliance_report(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_aggregate_framework_compliance_report_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 = MonitoringAsyncClient( + 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.aggregate_framework_compliance_report + 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.aggregate_framework_compliance_report + ] = mock_rpc + + request = {} + await client.aggregate_framework_compliance_report(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.aggregate_framework_compliance_report(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_aggregate_framework_compliance_report_async( + transport: str = "grpc_asyncio", + request_type=monitoring.AggregateFrameworkComplianceReportRequest, +): + client = MonitoringAsyncClient( + 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.aggregate_framework_compliance_report), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + monitoring.AggregateFrameworkComplianceReportResponse() + ) + response = await client.aggregate_framework_compliance_report(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = monitoring.AggregateFrameworkComplianceReportRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, monitoring.AggregateFrameworkComplianceReportResponse) + + +@pytest.mark.asyncio +async def test_aggregate_framework_compliance_report_async_from_dict(): + await test_aggregate_framework_compliance_report_async(request_type=dict) + + +def test_aggregate_framework_compliance_report_field_headers(): + client = MonitoringClient( + 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 = monitoring.AggregateFrameworkComplianceReportRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.aggregate_framework_compliance_report), "__call__" + ) as call: + call.return_value = monitoring.AggregateFrameworkComplianceReportResponse() + client.aggregate_framework_compliance_report(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_aggregate_framework_compliance_report_field_headers_async(): + client = MonitoringAsyncClient( + 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 = monitoring.AggregateFrameworkComplianceReportRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.aggregate_framework_compliance_report), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + monitoring.AggregateFrameworkComplianceReportResponse() + ) + await client.aggregate_framework_compliance_report(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_aggregate_framework_compliance_report_flattened(): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.aggregate_framework_compliance_report), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = monitoring.AggregateFrameworkComplianceReportResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.aggregate_framework_compliance_report( + 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_aggregate_framework_compliance_report_flattened_error(): + client = MonitoringClient( + 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.aggregate_framework_compliance_report( + monitoring.AggregateFrameworkComplianceReportRequest(), + name="name_value", + ) + + +@pytest.mark.asyncio +async def test_aggregate_framework_compliance_report_flattened_async(): + client = MonitoringAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.aggregate_framework_compliance_report), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = monitoring.AggregateFrameworkComplianceReportResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + monitoring.AggregateFrameworkComplianceReportResponse() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.aggregate_framework_compliance_report( + 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_aggregate_framework_compliance_report_flattened_error_async(): + client = MonitoringAsyncClient( + 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.aggregate_framework_compliance_report( + monitoring.AggregateFrameworkComplianceReportRequest(), + name="name_value", + ) + + +def test_list_framework_compliance_summaries_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 = MonitoringClient( + 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_framework_compliance_summaries + 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_framework_compliance_summaries + ] = mock_rpc + + request = {} + client.list_framework_compliance_summaries(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.list_framework_compliance_summaries(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_framework_compliance_summaries_rest_required_fields( + request_type=monitoring.ListFrameworkComplianceSummariesRequest, +): + transport_class = transports.MonitoringRestTransport + + 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_framework_compliance_summaries._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_framework_compliance_summaries._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "filter", + "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 = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = monitoring.ListFrameworkComplianceSummariesResponse() + # 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 = monitoring.ListFrameworkComplianceSummariesResponse.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_framework_compliance_summaries(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_list_framework_compliance_summaries_rest_unset_required_fields(): + transport = transports.MonitoringRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = ( + transport.list_framework_compliance_summaries._get_unset_required_fields({}) + ) + assert set(unset_fields) == ( + set( + ( + "filter", + "pageSize", + "pageToken", + ) + ) + & set(("parent",)) + ) + + +def test_list_framework_compliance_summaries_rest_flattened(): + client = MonitoringClient( + 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 = monitoring.ListFrameworkComplianceSummariesResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {"parent": "organizations/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 = monitoring.ListFrameworkComplianceSummariesResponse.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_framework_compliance_summaries(**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/v1/{parent=organizations/*/locations/*}/frameworkComplianceSummaries" + % client.transport._host, + args[1], + ) + + +def test_list_framework_compliance_summaries_rest_flattened_error( + transport: str = "rest", +): + client = MonitoringClient( + 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_framework_compliance_summaries( + monitoring.ListFrameworkComplianceSummariesRequest(), + parent="parent_value", + ) + + +def test_list_framework_compliance_summaries_rest_pager(transport: str = "rest"): + client = MonitoringClient( + 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 = ( + monitoring.ListFrameworkComplianceSummariesResponse( + framework_compliance_summaries=[ + monitoring.FrameworkComplianceSummary(), + monitoring.FrameworkComplianceSummary(), + monitoring.FrameworkComplianceSummary(), + ], + next_page_token="abc", + ), + monitoring.ListFrameworkComplianceSummariesResponse( + framework_compliance_summaries=[], + next_page_token="def", + ), + monitoring.ListFrameworkComplianceSummariesResponse( + framework_compliance_summaries=[ + monitoring.FrameworkComplianceSummary(), + ], + next_page_token="ghi", + ), + monitoring.ListFrameworkComplianceSummariesResponse( + framework_compliance_summaries=[ + monitoring.FrameworkComplianceSummary(), + monitoring.FrameworkComplianceSummary(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple( + monitoring.ListFrameworkComplianceSummariesResponse.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": "organizations/sample1/locations/sample2"} + + pager = client.list_framework_compliance_summaries(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all( + isinstance(i, monitoring.FrameworkComplianceSummary) for i in results + ) + + pages = list( + client.list_framework_compliance_summaries(request=sample_request).pages + ) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +def test_list_finding_summaries_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 = MonitoringClient( + 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_finding_summaries + 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_finding_summaries + ] = mock_rpc + + request = {} + client.list_finding_summaries(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.list_finding_summaries(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_finding_summaries_rest_required_fields( + request_type=monitoring.ListFindingSummariesRequest, +): + transport_class = transports.MonitoringRestTransport + + 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_finding_summaries._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_finding_summaries._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "end_time", + "filter", + "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 = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = monitoring.ListFindingSummariesResponse() + # 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 = monitoring.ListFindingSummariesResponse.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_finding_summaries(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_list_finding_summaries_rest_unset_required_fields(): + transport = transports.MonitoringRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.list_finding_summaries._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "endTime", + "filter", + "pageSize", + "pageToken", + ) + ) + & set(("parent",)) + ) + + +def test_list_finding_summaries_rest_flattened(): + client = MonitoringClient( + 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 = monitoring.ListFindingSummariesResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {"parent": "organizations/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 = monitoring.ListFindingSummariesResponse.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_finding_summaries(**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/v1/{parent=organizations/*/locations/*}/findingSummaries" + % client.transport._host, + args[1], + ) + + +def test_list_finding_summaries_rest_flattened_error(transport: str = "rest"): + client = MonitoringClient( + 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_finding_summaries( + monitoring.ListFindingSummariesRequest(), + parent="parent_value", + ) + + +def test_list_finding_summaries_rest_pager(transport: str = "rest"): + client = MonitoringClient( + 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 = ( + monitoring.ListFindingSummariesResponse( + finding_summaries=[ + monitoring.FindingSummary(), + monitoring.FindingSummary(), + monitoring.FindingSummary(), + ], + next_page_token="abc", + ), + monitoring.ListFindingSummariesResponse( + finding_summaries=[], + next_page_token="def", + ), + monitoring.ListFindingSummariesResponse( + finding_summaries=[ + monitoring.FindingSummary(), + ], + next_page_token="ghi", + ), + monitoring.ListFindingSummariesResponse( + finding_summaries=[ + monitoring.FindingSummary(), + monitoring.FindingSummary(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple( + monitoring.ListFindingSummariesResponse.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": "organizations/sample1/locations/sample2"} + + pager = client.list_finding_summaries(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, monitoring.FindingSummary) for i in results) + + pages = list(client.list_finding_summaries(request=sample_request).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +def test_fetch_framework_compliance_report_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 = MonitoringClient( + 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.fetch_framework_compliance_report + 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.fetch_framework_compliance_report + ] = mock_rpc + + request = {} + client.fetch_framework_compliance_report(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.fetch_framework_compliance_report(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_fetch_framework_compliance_report_rest_required_fields( + request_type=monitoring.FetchFrameworkComplianceReportRequest, +): + transport_class = transports.MonitoringRestTransport + + 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() + ).fetch_framework_compliance_report._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() + ).fetch_framework_compliance_report._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("end_time",)) + 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 = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = monitoring.FrameworkComplianceReport() + # 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 = monitoring.FrameworkComplianceReport.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.fetch_framework_compliance_report(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_fetch_framework_compliance_report_rest_unset_required_fields(): + transport = transports.MonitoringRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = ( + transport.fetch_framework_compliance_report._get_unset_required_fields({}) + ) + assert set(unset_fields) == (set(("endTime",)) & set(("name",))) + + +def test_fetch_framework_compliance_report_rest_flattened(): + client = MonitoringClient( + 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 = monitoring.FrameworkComplianceReport() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "organizations/sample1/locations/sample2/frameworkComplianceReports/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 = monitoring.FrameworkComplianceReport.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.fetch_framework_compliance_report(**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/v1/{name=organizations/*/locations/*/frameworkComplianceReports/*}:fetch" + % client.transport._host, + args[1], + ) + + +def test_fetch_framework_compliance_report_rest_flattened_error( + transport: str = "rest", +): + client = MonitoringClient( + 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.fetch_framework_compliance_report( + monitoring.FetchFrameworkComplianceReportRequest(), + name="name_value", + ) + + +def test_list_control_compliance_summaries_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 = MonitoringClient( + 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_control_compliance_summaries + 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_control_compliance_summaries + ] = mock_rpc + + request = {} + client.list_control_compliance_summaries(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.list_control_compliance_summaries(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_control_compliance_summaries_rest_required_fields( + request_type=monitoring.ListControlComplianceSummariesRequest, +): + transport_class = transports.MonitoringRestTransport + + 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_control_compliance_summaries._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_control_compliance_summaries._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "end_time", + "filter", + "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 = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = monitoring.ListControlComplianceSummariesResponse() + # 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 = monitoring.ListControlComplianceSummariesResponse.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_control_compliance_summaries(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_list_control_compliance_summaries_rest_unset_required_fields(): + transport = transports.MonitoringRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = ( + transport.list_control_compliance_summaries._get_unset_required_fields({}) + ) + assert set(unset_fields) == ( + set( + ( + "endTime", + "filter", + "pageSize", + "pageToken", + ) + ) + & set(("parent",)) + ) + + +def test_list_control_compliance_summaries_rest_flattened(): + client = MonitoringClient( + 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 = monitoring.ListControlComplianceSummariesResponse() + + # get arguments that satisfy an http rule for this method + sample_request = { + "parent": "organizations/sample1/locations/sample2/frameworkComplianceReports/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 = monitoring.ListControlComplianceSummariesResponse.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_control_compliance_summaries(**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/v1/{parent=organizations/*/locations/*/frameworkComplianceReports/*}/controlComplianceSummaries" + % client.transport._host, + args[1], + ) + + +def test_list_control_compliance_summaries_rest_flattened_error( + transport: str = "rest", +): + client = MonitoringClient( + 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_control_compliance_summaries( + monitoring.ListControlComplianceSummariesRequest(), + parent="parent_value", + ) + + +def test_list_control_compliance_summaries_rest_pager(transport: str = "rest"): + client = MonitoringClient( + 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 = ( + monitoring.ListControlComplianceSummariesResponse( + control_compliance_summaries=[ + monitoring.ControlComplianceSummary(), + monitoring.ControlComplianceSummary(), + monitoring.ControlComplianceSummary(), + ], + next_page_token="abc", + ), + monitoring.ListControlComplianceSummariesResponse( + control_compliance_summaries=[], + next_page_token="def", + ), + monitoring.ListControlComplianceSummariesResponse( + control_compliance_summaries=[ + monitoring.ControlComplianceSummary(), + ], + next_page_token="ghi", + ), + monitoring.ListControlComplianceSummariesResponse( + control_compliance_summaries=[ + monitoring.ControlComplianceSummary(), + monitoring.ControlComplianceSummary(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple( + monitoring.ListControlComplianceSummariesResponse.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": "organizations/sample1/locations/sample2/frameworkComplianceReports/sample3" + } + + pager = client.list_control_compliance_summaries(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, monitoring.ControlComplianceSummary) for i in results) + + pages = list( + client.list_control_compliance_summaries(request=sample_request).pages + ) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +def test_aggregate_framework_compliance_report_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 = MonitoringClient( + 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.aggregate_framework_compliance_report + 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.aggregate_framework_compliance_report + ] = mock_rpc + + request = {} + client.aggregate_framework_compliance_report(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.aggregate_framework_compliance_report(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_aggregate_framework_compliance_report_rest_required_fields( + request_type=monitoring.AggregateFrameworkComplianceReportRequest, +): + transport_class = transports.MonitoringRestTransport + + 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() + ).aggregate_framework_compliance_report._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() + ).aggregate_framework_compliance_report._get_unset_required_fields( + jsonified_request + ) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "filter", + "interval", + ) + ) + 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 = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = monitoring.AggregateFrameworkComplianceReportResponse() + # 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 = monitoring.AggregateFrameworkComplianceReportResponse.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.aggregate_framework_compliance_report(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_aggregate_framework_compliance_report_rest_unset_required_fields(): + transport = transports.MonitoringRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = ( + transport.aggregate_framework_compliance_report._get_unset_required_fields({}) + ) + assert set(unset_fields) == ( + set( + ( + "filter", + "interval", + ) + ) + & set(("name",)) + ) + + +def test_aggregate_framework_compliance_report_rest_flattened(): + client = MonitoringClient( + 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 = monitoring.AggregateFrameworkComplianceReportResponse() + + # get arguments that satisfy an http rule for this method + sample_request = { + "name": "organizations/sample1/locations/sample2/frameworkComplianceReports/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 = monitoring.AggregateFrameworkComplianceReportResponse.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.aggregate_framework_compliance_report(**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/v1/{name=organizations/*/locations/*/frameworkComplianceReports/*}:aggregate" + % client.transport._host, + args[1], + ) + + +def test_aggregate_framework_compliance_report_rest_flattened_error( + transport: str = "rest", +): + client = MonitoringClient( + 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.aggregate_framework_compliance_report( + monitoring.AggregateFrameworkComplianceReportRequest(), + name="name_value", + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.MonitoringGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.MonitoringGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = MonitoringClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.MonitoringGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = MonitoringClient( + 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 = MonitoringClient( + client_options=options, credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.MonitoringGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = MonitoringClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.MonitoringGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = MonitoringClient(transport=transport) + assert client.transport is transport + + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.MonitoringGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.MonitoringGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.MonitoringGrpcTransport, + transports.MonitoringGrpcAsyncIOTransport, + transports.MonitoringRestTransport, + ], +) +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 = MonitoringClient.get_transport_class("grpc")( + credentials=ga_credentials.AnonymousCredentials() + ) + assert transport.kind == "grpc" + + +def test_initialize_client_w_grpc(): + client = MonitoringClient( + 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_framework_compliance_summaries_empty_call_grpc(): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_framework_compliance_summaries), "__call__" + ) as call: + call.return_value = monitoring.ListFrameworkComplianceSummariesResponse() + client.list_framework_compliance_summaries(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = monitoring.ListFrameworkComplianceSummariesRequest() + + 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_finding_summaries_empty_call_grpc(): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_finding_summaries), "__call__" + ) as call: + call.return_value = monitoring.ListFindingSummariesResponse() + client.list_finding_summaries(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = monitoring.ListFindingSummariesRequest() + + 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_fetch_framework_compliance_report_empty_call_grpc(): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.fetch_framework_compliance_report), "__call__" + ) as call: + call.return_value = monitoring.FrameworkComplianceReport() + client.fetch_framework_compliance_report(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = monitoring.FetchFrameworkComplianceReportRequest() + + 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_control_compliance_summaries_empty_call_grpc(): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_control_compliance_summaries), "__call__" + ) as call: + call.return_value = monitoring.ListControlComplianceSummariesResponse() + client.list_control_compliance_summaries(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = monitoring.ListControlComplianceSummariesRequest() + + 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_aggregate_framework_compliance_report_empty_call_grpc(): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.aggregate_framework_compliance_report), "__call__" + ) as call: + call.return_value = monitoring.AggregateFrameworkComplianceReportResponse() + client.aggregate_framework_compliance_report(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = monitoring.AggregateFrameworkComplianceReportRequest() + + assert args[0] == request_msg + + +def test_transport_kind_grpc_asyncio(): + transport = MonitoringAsyncClient.get_transport_class("grpc_asyncio")( + credentials=async_anonymous_credentials() + ) + assert transport.kind == "grpc_asyncio" + + +def test_initialize_client_w_grpc_asyncio(): + client = MonitoringAsyncClient( + 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_framework_compliance_summaries_empty_call_grpc_asyncio(): + client = MonitoringAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_framework_compliance_summaries), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + monitoring.ListFrameworkComplianceSummariesResponse( + next_page_token="next_page_token_value", + ) + ) + await client.list_framework_compliance_summaries(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = monitoring.ListFrameworkComplianceSummariesRequest() + + 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_finding_summaries_empty_call_grpc_asyncio(): + client = MonitoringAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_finding_summaries), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + monitoring.ListFindingSummariesResponse( + next_page_token="next_page_token_value", + ) + ) + await client.list_finding_summaries(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = monitoring.ListFindingSummariesRequest() + + 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_fetch_framework_compliance_report_empty_call_grpc_asyncio(): + client = MonitoringAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.fetch_framework_compliance_report), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + monitoring.FrameworkComplianceReport( + framework="framework_value", + framework_description="framework_description_value", + framework_type=common.Framework.FrameworkType.BUILT_IN, + supported_cloud_providers=[common.CloudProvider.AWS], + framework_categories=[ + common.FrameworkCategory.INDUSTRY_DEFINED_STANDARD + ], + framework_display_name="framework_display_name_value", + name="name_value", + major_revision_id=1811, + minor_revision_id=1823, + ) + ) + await client.fetch_framework_compliance_report(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = monitoring.FetchFrameworkComplianceReportRequest() + + 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_control_compliance_summaries_empty_call_grpc_asyncio(): + client = MonitoringAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_control_compliance_summaries), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + monitoring.ListControlComplianceSummariesResponse( + next_page_token="next_page_token_value", + ) + ) + await client.list_control_compliance_summaries(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = monitoring.ListControlComplianceSummariesRequest() + + 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_aggregate_framework_compliance_report_empty_call_grpc_asyncio(): + client = MonitoringAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.aggregate_framework_compliance_report), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + monitoring.AggregateFrameworkComplianceReportResponse() + ) + await client.aggregate_framework_compliance_report(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = monitoring.AggregateFrameworkComplianceReportRequest() + + assert args[0] == request_msg + + +def test_transport_kind_rest(): + transport = MonitoringClient.get_transport_class("rest")( + credentials=ga_credentials.AnonymousCredentials() + ) + assert transport.kind == "rest" + + +def test_list_framework_compliance_summaries_rest_bad_request( + request_type=monitoring.ListFrameworkComplianceSummariesRequest, +): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {"parent": "organizations/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_framework_compliance_summaries(request) + + +@pytest.mark.parametrize( + "request_type", + [ + monitoring.ListFrameworkComplianceSummariesRequest, + dict, + ], +) +def test_list_framework_compliance_summaries_rest_call_success(request_type): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "organizations/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 = monitoring.ListFrameworkComplianceSummariesResponse( + 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 = monitoring.ListFrameworkComplianceSummariesResponse.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_framework_compliance_summaries(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListFrameworkComplianceSummariesPager) + assert response.next_page_token == "next_page_token_value" + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_framework_compliance_summaries_rest_interceptors(null_interceptor): + transport = transports.MonitoringRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.MonitoringRestInterceptor(), + ) + client = MonitoringClient(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.MonitoringRestInterceptor, "post_list_framework_compliance_summaries" + ) as post, mock.patch.object( + transports.MonitoringRestInterceptor, + "post_list_framework_compliance_summaries_with_metadata", + ) as post_with_metadata, mock.patch.object( + transports.MonitoringRestInterceptor, "pre_list_framework_compliance_summaries" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = monitoring.ListFrameworkComplianceSummariesRequest.pb( + monitoring.ListFrameworkComplianceSummariesRequest() + ) + 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 = monitoring.ListFrameworkComplianceSummariesResponse.to_json( + monitoring.ListFrameworkComplianceSummariesResponse() + ) + req.return_value.content = return_value + + request = monitoring.ListFrameworkComplianceSummariesRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = monitoring.ListFrameworkComplianceSummariesResponse() + post_with_metadata.return_value = ( + monitoring.ListFrameworkComplianceSummariesResponse(), + metadata, + ) + + client.list_framework_compliance_summaries( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_list_finding_summaries_rest_bad_request( + request_type=monitoring.ListFindingSummariesRequest, +): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {"parent": "organizations/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_finding_summaries(request) + + +@pytest.mark.parametrize( + "request_type", + [ + monitoring.ListFindingSummariesRequest, + dict, + ], +) +def test_list_finding_summaries_rest_call_success(request_type): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "organizations/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 = monitoring.ListFindingSummariesResponse( + 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 = monitoring.ListFindingSummariesResponse.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_finding_summaries(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListFindingSummariesPager) + assert response.next_page_token == "next_page_token_value" + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_finding_summaries_rest_interceptors(null_interceptor): + transport = transports.MonitoringRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.MonitoringRestInterceptor(), + ) + client = MonitoringClient(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.MonitoringRestInterceptor, "post_list_finding_summaries" + ) as post, mock.patch.object( + transports.MonitoringRestInterceptor, + "post_list_finding_summaries_with_metadata", + ) as post_with_metadata, mock.patch.object( + transports.MonitoringRestInterceptor, "pre_list_finding_summaries" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = monitoring.ListFindingSummariesRequest.pb( + monitoring.ListFindingSummariesRequest() + ) + 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 = monitoring.ListFindingSummariesResponse.to_json( + monitoring.ListFindingSummariesResponse() + ) + req.return_value.content = return_value + + request = monitoring.ListFindingSummariesRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = monitoring.ListFindingSummariesResponse() + post_with_metadata.return_value = ( + monitoring.ListFindingSummariesResponse(), + metadata, + ) + + client.list_finding_summaries( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_fetch_framework_compliance_report_rest_bad_request( + request_type=monitoring.FetchFrameworkComplianceReportRequest, +): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + # send a request that will satisfy transcoding + request_init = { + "name": "organizations/sample1/locations/sample2/frameworkComplianceReports/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.fetch_framework_compliance_report(request) + + +@pytest.mark.parametrize( + "request_type", + [ + monitoring.FetchFrameworkComplianceReportRequest, + dict, + ], +) +def test_fetch_framework_compliance_report_rest_call_success(request_type): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "organizations/sample1/locations/sample2/frameworkComplianceReports/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 = monitoring.FrameworkComplianceReport( + framework="framework_value", + framework_description="framework_description_value", + framework_type=common.Framework.FrameworkType.BUILT_IN, + supported_cloud_providers=[common.CloudProvider.AWS], + framework_categories=[common.FrameworkCategory.INDUSTRY_DEFINED_STANDARD], + framework_display_name="framework_display_name_value", + name="name_value", + major_revision_id=1811, + minor_revision_id=1823, + ) + + # 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 = monitoring.FrameworkComplianceReport.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.fetch_framework_compliance_report(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, monitoring.FrameworkComplianceReport) + assert response.framework == "framework_value" + assert response.framework_description == "framework_description_value" + assert response.framework_type == common.Framework.FrameworkType.BUILT_IN + assert response.supported_cloud_providers == [common.CloudProvider.AWS] + assert response.framework_categories == [ + common.FrameworkCategory.INDUSTRY_DEFINED_STANDARD + ] + assert response.framework_display_name == "framework_display_name_value" + assert response.name == "name_value" + assert response.major_revision_id == 1811 + assert response.minor_revision_id == 1823 + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_fetch_framework_compliance_report_rest_interceptors(null_interceptor): + transport = transports.MonitoringRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.MonitoringRestInterceptor(), + ) + client = MonitoringClient(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.MonitoringRestInterceptor, "post_fetch_framework_compliance_report" + ) as post, mock.patch.object( + transports.MonitoringRestInterceptor, + "post_fetch_framework_compliance_report_with_metadata", + ) as post_with_metadata, mock.patch.object( + transports.MonitoringRestInterceptor, "pre_fetch_framework_compliance_report" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = monitoring.FetchFrameworkComplianceReportRequest.pb( + monitoring.FetchFrameworkComplianceReportRequest() + ) + 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 = monitoring.FrameworkComplianceReport.to_json( + monitoring.FrameworkComplianceReport() + ) + req.return_value.content = return_value + + request = monitoring.FetchFrameworkComplianceReportRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = monitoring.FrameworkComplianceReport() + post_with_metadata.return_value = ( + monitoring.FrameworkComplianceReport(), + metadata, + ) + + client.fetch_framework_compliance_report( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_list_control_compliance_summaries_rest_bad_request( + request_type=monitoring.ListControlComplianceSummariesRequest, +): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + # send a request that will satisfy transcoding + request_init = { + "parent": "organizations/sample1/locations/sample2/frameworkComplianceReports/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_control_compliance_summaries(request) + + +@pytest.mark.parametrize( + "request_type", + [ + monitoring.ListControlComplianceSummariesRequest, + dict, + ], +) +def test_list_control_compliance_summaries_rest_call_success(request_type): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = { + "parent": "organizations/sample1/locations/sample2/frameworkComplianceReports/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 = monitoring.ListControlComplianceSummariesResponse( + 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 = monitoring.ListControlComplianceSummariesResponse.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_control_compliance_summaries(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListControlComplianceSummariesPager) + assert response.next_page_token == "next_page_token_value" + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_control_compliance_summaries_rest_interceptors(null_interceptor): + transport = transports.MonitoringRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.MonitoringRestInterceptor(), + ) + client = MonitoringClient(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.MonitoringRestInterceptor, "post_list_control_compliance_summaries" + ) as post, mock.patch.object( + transports.MonitoringRestInterceptor, + "post_list_control_compliance_summaries_with_metadata", + ) as post_with_metadata, mock.patch.object( + transports.MonitoringRestInterceptor, "pre_list_control_compliance_summaries" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = monitoring.ListControlComplianceSummariesRequest.pb( + monitoring.ListControlComplianceSummariesRequest() + ) + 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 = monitoring.ListControlComplianceSummariesResponse.to_json( + monitoring.ListControlComplianceSummariesResponse() + ) + req.return_value.content = return_value + + request = monitoring.ListControlComplianceSummariesRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = monitoring.ListControlComplianceSummariesResponse() + post_with_metadata.return_value = ( + monitoring.ListControlComplianceSummariesResponse(), + metadata, + ) + + client.list_control_compliance_summaries( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_aggregate_framework_compliance_report_rest_bad_request( + request_type=monitoring.AggregateFrameworkComplianceReportRequest, +): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + # send a request that will satisfy transcoding + request_init = { + "name": "organizations/sample1/locations/sample2/frameworkComplianceReports/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.aggregate_framework_compliance_report(request) + + +@pytest.mark.parametrize( + "request_type", + [ + monitoring.AggregateFrameworkComplianceReportRequest, + dict, + ], +) +def test_aggregate_framework_compliance_report_rest_call_success(request_type): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = { + "name": "organizations/sample1/locations/sample2/frameworkComplianceReports/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 = monitoring.AggregateFrameworkComplianceReportResponse() + + # 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 = monitoring.AggregateFrameworkComplianceReportResponse.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.aggregate_framework_compliance_report(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, monitoring.AggregateFrameworkComplianceReportResponse) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_aggregate_framework_compliance_report_rest_interceptors(null_interceptor): + transport = transports.MonitoringRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.MonitoringRestInterceptor(), + ) + client = MonitoringClient(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.MonitoringRestInterceptor, + "post_aggregate_framework_compliance_report", + ) as post, mock.patch.object( + transports.MonitoringRestInterceptor, + "post_aggregate_framework_compliance_report_with_metadata", + ) as post_with_metadata, mock.patch.object( + transports.MonitoringRestInterceptor, + "pre_aggregate_framework_compliance_report", + ) as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = monitoring.AggregateFrameworkComplianceReportRequest.pb( + monitoring.AggregateFrameworkComplianceReportRequest() + ) + 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 = monitoring.AggregateFrameworkComplianceReportResponse.to_json( + monitoring.AggregateFrameworkComplianceReportResponse() + ) + req.return_value.content = return_value + + request = monitoring.AggregateFrameworkComplianceReportRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = monitoring.AggregateFrameworkComplianceReportResponse() + post_with_metadata.return_value = ( + monitoring.AggregateFrameworkComplianceReportResponse(), + metadata, + ) + + client.aggregate_framework_compliance_report( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_get_location_rest_bad_request(request_type=locations_pb2.GetLocationRequest): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type() + request = json_format.ParseDict( + {"name": "organizations/sample1/locations/sample2"}, request + ) + + # 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 = Response() + json_return_value = "" + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.get_location(request) + + +@pytest.mark.parametrize( + "request_type", + [ + locations_pb2.GetLocationRequest, + dict, + ], +) +def test_get_location_rest(request_type): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + request_init = {"name": "organizations/sample1/locations/sample2"} + request = request_type(**request_init) + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # Designate an appropriate value for the returned response. + return_value = locations_pb2.Location() + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + 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_location(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, locations_pb2.Location) + + +def test_list_locations_rest_bad_request( + request_type=locations_pb2.ListLocationsRequest, +): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type() + request = json_format.ParseDict({"name": "organizations/sample1"}, request) + + # 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 = Response() + json_return_value = "" + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.list_locations(request) + + +@pytest.mark.parametrize( + "request_type", + [ + locations_pb2.ListLocationsRequest, + dict, + ], +) +def test_list_locations_rest(request_type): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + request_init = {"name": "organizations/sample1"} + request = request_type(**request_init) + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # Designate an appropriate value for the returned response. + return_value = locations_pb2.ListLocationsResponse() + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + 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_locations(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, locations_pb2.ListLocationsResponse) + + +def test_cancel_operation_rest_bad_request( + request_type=operations_pb2.CancelOperationRequest, +): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type() + request = json_format.ParseDict( + {"name": "organizations/sample1/locations/sample2/operations/sample3"}, request + ) + + # 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 = Response() + json_return_value = "" + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.cancel_operation(request) + + +@pytest.mark.parametrize( + "request_type", + [ + operations_pb2.CancelOperationRequest, + dict, + ], +) +def test_cancel_operation_rest(request_type): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + request_init = { + "name": "organizations/sample1/locations/sample2/operations/sample3" + } + request = request_type(**request_init) + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + json_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.cancel_operation(request) + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_operation_rest_bad_request( + request_type=operations_pb2.DeleteOperationRequest, +): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type() + request = json_format.ParseDict( + {"name": "organizations/sample1/locations/sample2/operations/sample3"}, request + ) + + # 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 = Response() + json_return_value = "" + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.delete_operation(request) + + +@pytest.mark.parametrize( + "request_type", + [ + operations_pb2.DeleteOperationRequest, + dict, + ], +) +def test_delete_operation_rest(request_type): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + request_init = { + "name": "organizations/sample1/locations/sample2/operations/sample3" + } + request = request_type(**request_init) + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + json_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.delete_operation(request) + + # Establish that the response is the type that we expect. + assert response is None + + +def test_get_operation_rest_bad_request( + request_type=operations_pb2.GetOperationRequest, +): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type() + request = json_format.ParseDict( + {"name": "organizations/sample1/locations/sample2/operations/sample3"}, request + ) + + # 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 = Response() + json_return_value = "" + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.get_operation(request) + + +@pytest.mark.parametrize( + "request_type", + [ + operations_pb2.GetOperationRequest, + dict, + ], +) +def test_get_operation_rest(request_type): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + request_init = { + "name": "organizations/sample1/locations/sample2/operations/sample3" + } + request = request_type(**request_init) + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.Operation() + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + 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_operation(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, operations_pb2.Operation) + + +def test_list_operations_rest_bad_request( + request_type=operations_pb2.ListOperationsRequest, +): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type() + request = json_format.ParseDict( + {"name": "organizations/sample1/locations/sample2"}, request + ) + + # 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 = Response() + json_return_value = "" + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.list_operations(request) + + +@pytest.mark.parametrize( + "request_type", + [ + operations_pb2.ListOperationsRequest, + dict, + ], +) +def test_list_operations_rest(request_type): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + request_init = {"name": "organizations/sample1/locations/sample2"} + request = request_type(**request_init) + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # Designate an appropriate value for the returned response. + return_value = operations_pb2.ListOperationsResponse() + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + 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_operations(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, operations_pb2.ListOperationsResponse) + + +def test_initialize_client_w_rest(): + client = MonitoringClient( + 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_framework_compliance_summaries_empty_call_rest(): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_framework_compliance_summaries), "__call__" + ) as call: + client.list_framework_compliance_summaries(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = monitoring.ListFrameworkComplianceSummariesRequest() + + 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_finding_summaries_empty_call_rest(): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_finding_summaries), "__call__" + ) as call: + client.list_finding_summaries(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = monitoring.ListFindingSummariesRequest() + + 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_fetch_framework_compliance_report_empty_call_rest(): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.fetch_framework_compliance_report), "__call__" + ) as call: + client.fetch_framework_compliance_report(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = monitoring.FetchFrameworkComplianceReportRequest() + + 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_control_compliance_summaries_empty_call_rest(): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_control_compliance_summaries), "__call__" + ) as call: + client.list_control_compliance_summaries(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = monitoring.ListControlComplianceSummariesRequest() + + 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_aggregate_framework_compliance_report_empty_call_rest(): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.aggregate_framework_compliance_report), "__call__" + ) as call: + client.aggregate_framework_compliance_report(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = monitoring.AggregateFrameworkComplianceReportRequest() + + assert args[0] == request_msg + + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.MonitoringGrpcTransport, + ) + + +def test_monitoring_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.MonitoringTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json", + ) + + +def test_monitoring_base_transport(): + # Instantiate the base transport. + with mock.patch( + "google.cloud.cloudsecuritycompliance_v1.services.monitoring.transports.MonitoringTransport.__init__" + ) as Transport: + Transport.return_value = None + transport = transports.MonitoringTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + "list_framework_compliance_summaries", + "list_finding_summaries", + "fetch_framework_compliance_report", + "list_control_compliance_summaries", + "aggregate_framework_compliance_report", + "get_location", + "list_locations", + "get_operation", + "cancel_operation", + "delete_operation", + "list_operations", + ) + 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_monitoring_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.cloudsecuritycompliance_v1.services.monitoring.transports.MonitoringTransport._prep_wrapped_messages" + ) as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.MonitoringTransport( + 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_monitoring_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.cloudsecuritycompliance_v1.services.monitoring.transports.MonitoringTransport._prep_wrapped_messages" + ) as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.MonitoringTransport() + adc.assert_called_once() + + +def test_monitoring_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) + MonitoringClient() + 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.MonitoringGrpcTransport, + transports.MonitoringGrpcAsyncIOTransport, + ], +) +def test_monitoring_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.MonitoringGrpcTransport, + transports.MonitoringGrpcAsyncIOTransport, + transports.MonitoringRestTransport, + ], +) +def test_monitoring_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.MonitoringGrpcTransport, grpc_helpers), + (transports.MonitoringGrpcAsyncIOTransport, grpc_helpers_async), + ], +) +def test_monitoring_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( + "cloudsecuritycompliance.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="cloudsecuritycompliance.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize( + "transport_class", + [transports.MonitoringGrpcTransport, transports.MonitoringGrpcAsyncIOTransport], +) +def test_monitoring_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_monitoring_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.MonitoringRestTransport( + 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_monitoring_host_no_port(transport_name): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions( + api_endpoint="cloudsecuritycompliance.googleapis.com" + ), + transport=transport_name, + ) + assert client.transport._host == ( + "cloudsecuritycompliance.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://cloudsecuritycompliance.googleapis.com" + ) + + +@pytest.mark.parametrize( + "transport_name", + [ + "grpc", + "grpc_asyncio", + "rest", + ], +) +def test_monitoring_host_with_port(transport_name): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions( + api_endpoint="cloudsecuritycompliance.googleapis.com:8000" + ), + transport=transport_name, + ) + assert client.transport._host == ( + "cloudsecuritycompliance.googleapis.com:8000" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://cloudsecuritycompliance.googleapis.com:8000" + ) + + +@pytest.mark.parametrize( + "transport_name", + [ + "rest", + ], +) +def test_monitoring_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = MonitoringClient( + credentials=creds1, + transport=transport_name, + ) + client2 = MonitoringClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.list_framework_compliance_summaries._session + session2 = client2.transport.list_framework_compliance_summaries._session + assert session1 != session2 + session1 = client1.transport.list_finding_summaries._session + session2 = client2.transport.list_finding_summaries._session + assert session1 != session2 + session1 = client1.transport.fetch_framework_compliance_report._session + session2 = client2.transport.fetch_framework_compliance_report._session + assert session1 != session2 + session1 = client1.transport.list_control_compliance_summaries._session + session2 = client2.transport.list_control_compliance_summaries._session + assert session1 != session2 + session1 = client1.transport.aggregate_framework_compliance_report._session + session2 = client2.transport.aggregate_framework_compliance_report._session + assert session1 != session2 + + +def test_monitoring_grpc_transport_channel(): + channel = grpc.secure_channel("http://localhost/", grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.MonitoringGrpcTransport( + 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_monitoring_grpc_asyncio_transport_channel(): + channel = aio.secure_channel("http://localhost/", grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.MonitoringGrpcAsyncIOTransport( + 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.MonitoringGrpcTransport, transports.MonitoringGrpcAsyncIOTransport], +) +def test_monitoring_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.MonitoringGrpcTransport, transports.MonitoringGrpcAsyncIOTransport], +) +def test_monitoring_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_control_compliance_summary_path(): + project = "squid" + location = "clam" + framework_compliance_report = "whelk" + control_compliance_summary = "octopus" + expected = "projects/{project}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}/controlComplianceSummaries/{control_compliance_summary}".format( + project=project, + location=location, + framework_compliance_report=framework_compliance_report, + control_compliance_summary=control_compliance_summary, + ) + actual = MonitoringClient.control_compliance_summary_path( + project, location, framework_compliance_report, control_compliance_summary + ) + assert expected == actual + + +def test_parse_control_compliance_summary_path(): + expected = { + "project": "oyster", + "location": "nudibranch", + "framework_compliance_report": "cuttlefish", + "control_compliance_summary": "mussel", + } + path = MonitoringClient.control_compliance_summary_path(**expected) + + # Check that the path construction is reversible. + actual = MonitoringClient.parse_control_compliance_summary_path(path) + assert expected == actual + + +def test_finding_summary_path(): + project = "winkle" + location = "nautilus" + finding_summary = "scallop" + expected = "projects/{project}/locations/{location}/findingSummaries/{finding_summary}".format( + project=project, + location=location, + finding_summary=finding_summary, + ) + actual = MonitoringClient.finding_summary_path(project, location, finding_summary) + assert expected == actual + + +def test_parse_finding_summary_path(): + expected = { + "project": "abalone", + "location": "squid", + "finding_summary": "clam", + } + path = MonitoringClient.finding_summary_path(**expected) + + # Check that the path construction is reversible. + actual = MonitoringClient.parse_finding_summary_path(path) + assert expected == actual + + +def test_framework_compliance_report_path(): + project = "whelk" + location = "octopus" + framework_compliance_report = "oyster" + expected = "projects/{project}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}".format( + project=project, + location=location, + framework_compliance_report=framework_compliance_report, + ) + actual = MonitoringClient.framework_compliance_report_path( + project, location, framework_compliance_report + ) + assert expected == actual + + +def test_parse_framework_compliance_report_path(): + expected = { + "project": "nudibranch", + "location": "cuttlefish", + "framework_compliance_report": "mussel", + } + path = MonitoringClient.framework_compliance_report_path(**expected) + + # Check that the path construction is reversible. + actual = MonitoringClient.parse_framework_compliance_report_path(path) + assert expected == actual + + +def test_framework_compliance_summary_path(): + project = "winkle" + location = "nautilus" + framework_compliance_summary = "scallop" + expected = "projects/{project}/locations/{location}/frameworkComplianceSummaries/{framework_compliance_summary}".format( + project=project, + location=location, + framework_compliance_summary=framework_compliance_summary, + ) + actual = MonitoringClient.framework_compliance_summary_path( + project, location, framework_compliance_summary + ) + assert expected == actual + + +def test_parse_framework_compliance_summary_path(): + expected = { + "project": "abalone", + "location": "squid", + "framework_compliance_summary": "clam", + } + path = MonitoringClient.framework_compliance_summary_path(**expected) + + # Check that the path construction is reversible. + actual = MonitoringClient.parse_framework_compliance_summary_path(path) + assert expected == actual + + +def test_common_billing_account_path(): + billing_account = "whelk" + expected = "billingAccounts/{billing_account}".format( + billing_account=billing_account, + ) + actual = MonitoringClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "octopus", + } + path = MonitoringClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = MonitoringClient.parse_common_billing_account_path(path) + assert expected == actual + + +def test_common_folder_path(): + folder = "oyster" + expected = "folders/{folder}".format( + folder=folder, + ) + actual = MonitoringClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "nudibranch", + } + path = MonitoringClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = MonitoringClient.parse_common_folder_path(path) + assert expected == actual + + +def test_common_organization_path(): + organization = "cuttlefish" + expected = "organizations/{organization}".format( + organization=organization, + ) + actual = MonitoringClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "mussel", + } + path = MonitoringClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = MonitoringClient.parse_common_organization_path(path) + assert expected == actual + + +def test_common_project_path(): + project = "winkle" + expected = "projects/{project}".format( + project=project, + ) + actual = MonitoringClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "nautilus", + } + path = MonitoringClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = MonitoringClient.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 = MonitoringClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "squid", + "location": "clam", + } + path = MonitoringClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = MonitoringClient.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.MonitoringTransport, "_prep_wrapped_messages" + ) as prep: + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object( + transports.MonitoringTransport, "_prep_wrapped_messages" + ) as prep: + transport_class = MonitoringClient.get_transport_class() + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + +def test_delete_operation(transport: str = "grpc"): + client = MonitoringClient( + 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 = operations_pb2.DeleteOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = None + response = client.delete_operation(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 response is the type that we expect. + assert response is None + + +@pytest.mark.asyncio +async def test_delete_operation_async(transport: str = "grpc_asyncio"): + client = MonitoringAsyncClient( + 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 = operations_pb2.DeleteOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + response = await client.delete_operation(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 response is the type that we expect. + assert response is None + + +def test_delete_operation_field_headers(): + client = MonitoringClient( + 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 = operations_pb2.DeleteOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_operation), "__call__") as call: + call.return_value = None + + client.delete_operation(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=locations", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_delete_operation_field_headers_async(): + client = MonitoringAsyncClient( + 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 = operations_pb2.DeleteOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_operation), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + await client.delete_operation(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=locations", + ) in kw["metadata"] + + +def test_delete_operation_from_dict(): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = None + + response = client.delete_operation( + request={ + "name": "locations", + } + ) + call.assert_called() + + +@pytest.mark.asyncio +async def test_delete_operation_from_dict_async(): + client = MonitoringAsyncClient( + credentials=async_anonymous_credentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + response = await client.delete_operation( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_cancel_operation(transport: str = "grpc"): + client = MonitoringClient( + 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 = operations_pb2.CancelOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.cancel_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = None + response = client.cancel_operation(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 response is the type that we expect. + assert response is None + + +@pytest.mark.asyncio +async def test_cancel_operation_async(transport: str = "grpc_asyncio"): + client = MonitoringAsyncClient( + 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 = operations_pb2.CancelOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.cancel_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + response = await client.cancel_operation(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 response is the type that we expect. + assert response is None + + +def test_cancel_operation_field_headers(): + client = MonitoringClient( + 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 = operations_pb2.CancelOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.cancel_operation), "__call__") as call: + call.return_value = None + + client.cancel_operation(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=locations", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_cancel_operation_field_headers_async(): + client = MonitoringAsyncClient( + 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 = operations_pb2.CancelOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.cancel_operation), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + await client.cancel_operation(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=locations", + ) in kw["metadata"] + + +def test_cancel_operation_from_dict(): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.cancel_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = None + + response = client.cancel_operation( + request={ + "name": "locations", + } + ) + call.assert_called() + + +@pytest.mark.asyncio +async def test_cancel_operation_from_dict_async(): + client = MonitoringAsyncClient( + credentials=async_anonymous_credentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.cancel_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + response = await client.cancel_operation( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_get_operation(transport: str = "grpc"): + client = MonitoringClient( + 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 = operations_pb2.GetOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation() + response = client.get_operation(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 response is the type that we expect. + assert isinstance(response, operations_pb2.Operation) + + +@pytest.mark.asyncio +async def test_get_operation_async(transport: str = "grpc_asyncio"): + client = MonitoringAsyncClient( + 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 = operations_pb2.GetOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation() + ) + response = await client.get_operation(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 response is the type that we expect. + assert isinstance(response, operations_pb2.Operation) + + +def test_get_operation_field_headers(): + client = MonitoringClient( + 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 = operations_pb2.GetOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + call.return_value = operations_pb2.Operation() + + client.get_operation(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=locations", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_get_operation_field_headers_async(): + client = MonitoringAsyncClient( + 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 = operations_pb2.GetOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation() + ) + await client.get_operation(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=locations", + ) in kw["metadata"] + + +def test_get_operation_from_dict(): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation() + + response = client.get_operation( + request={ + "name": "locations", + } + ) + call.assert_called() + + +@pytest.mark.asyncio +async def test_get_operation_from_dict_async(): + client = MonitoringAsyncClient( + credentials=async_anonymous_credentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation() + ) + response = await client.get_operation( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_list_operations(transport: str = "grpc"): + client = MonitoringClient( + 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 = operations_pb2.ListOperationsRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.ListOperationsResponse() + response = client.list_operations(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 response is the type that we expect. + assert isinstance(response, operations_pb2.ListOperationsResponse) + + +@pytest.mark.asyncio +async def test_list_operations_async(transport: str = "grpc_asyncio"): + client = MonitoringAsyncClient( + 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 = operations_pb2.ListOperationsRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.ListOperationsResponse() + ) + response = await client.list_operations(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 response is the type that we expect. + assert isinstance(response, operations_pb2.ListOperationsResponse) + + +def test_list_operations_field_headers(): + client = MonitoringClient( + 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 = operations_pb2.ListOperationsRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + call.return_value = operations_pb2.ListOperationsResponse() + + client.list_operations(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=locations", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_list_operations_field_headers_async(): + client = MonitoringAsyncClient( + 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 = operations_pb2.ListOperationsRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.ListOperationsResponse() + ) + await client.list_operations(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=locations", + ) in kw["metadata"] + + +def test_list_operations_from_dict(): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.ListOperationsResponse() + + response = client.list_operations( + request={ + "name": "locations", + } + ) + call.assert_called() + + +@pytest.mark.asyncio +async def test_list_operations_from_dict_async(): + client = MonitoringAsyncClient( + credentials=async_anonymous_credentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.ListOperationsResponse() + ) + response = await client.list_operations( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_list_locations(transport: str = "grpc"): + client = MonitoringClient( + 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 = locations_pb2.ListLocationsRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = locations_pb2.ListLocationsResponse() + response = client.list_locations(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 response is the type that we expect. + assert isinstance(response, locations_pb2.ListLocationsResponse) + + +@pytest.mark.asyncio +async def test_list_locations_async(transport: str = "grpc_asyncio"): + client = MonitoringAsyncClient( + 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 = locations_pb2.ListLocationsRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + locations_pb2.ListLocationsResponse() + ) + response = await client.list_locations(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 response is the type that we expect. + assert isinstance(response, locations_pb2.ListLocationsResponse) + + +def test_list_locations_field_headers(): + client = MonitoringClient( + 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 = locations_pb2.ListLocationsRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + call.return_value = locations_pb2.ListLocationsResponse() + + client.list_locations(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=locations", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_list_locations_field_headers_async(): + client = MonitoringAsyncClient( + 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 = locations_pb2.ListLocationsRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + locations_pb2.ListLocationsResponse() + ) + await client.list_locations(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=locations", + ) in kw["metadata"] + + +def test_list_locations_from_dict(): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = locations_pb2.ListLocationsResponse() + + response = client.list_locations( + request={ + "name": "locations", + } + ) + call.assert_called() + + +@pytest.mark.asyncio +async def test_list_locations_from_dict_async(): + client = MonitoringAsyncClient( + credentials=async_anonymous_credentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + locations_pb2.ListLocationsResponse() + ) + response = await client.list_locations( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_get_location(transport: str = "grpc"): + client = MonitoringClient( + 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 = locations_pb2.GetLocationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_location), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = locations_pb2.Location() + response = client.get_location(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 response is the type that we expect. + assert isinstance(response, locations_pb2.Location) + + +@pytest.mark.asyncio +async def test_get_location_async(transport: str = "grpc_asyncio"): + client = MonitoringAsyncClient( + 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 = locations_pb2.GetLocationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_location), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + locations_pb2.Location() + ) + response = await client.get_location(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 response is the type that we expect. + assert isinstance(response, locations_pb2.Location) + + +def test_get_location_field_headers(): + client = MonitoringClient(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 = locations_pb2.GetLocationRequest() + request.name = "locations/abc" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_location), "__call__") as call: + call.return_value = locations_pb2.Location() + + client.get_location(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=locations/abc", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_get_location_field_headers_async(): + client = MonitoringAsyncClient(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 = locations_pb2.GetLocationRequest() + request.name = "locations/abc" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_location), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + locations_pb2.Location() + ) + await client.get_location(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=locations/abc", + ) in kw["metadata"] + + +def test_get_location_from_dict(): + client = MonitoringClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = locations_pb2.Location() + + response = client.get_location( + request={ + "name": "locations/abc", + } + ) + call.assert_called() + + +@pytest.mark.asyncio +async def test_get_location_from_dict_async(): + client = MonitoringAsyncClient( + credentials=async_anonymous_credentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_locations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + locations_pb2.Location() + ) + response = await client.get_location( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_transport_close_grpc(): + client = MonitoringClient( + 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 = MonitoringAsyncClient( + 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 = MonitoringClient( + 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 = MonitoringClient( + 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", + [ + (MonitoringClient, transports.MonitoringGrpcTransport), + (MonitoringAsyncClient, transports.MonitoringGrpcAsyncIOTransport), + ], +) +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, + )