google-cloud-cloudcontrolspartner 0.1.0__py3-none-any.whl

google/cloud/cloudcontrolspartner_v1beta/services/cloud_controls_partner_monitoring/transports/rest.py

@@ -0,0 +1,434 @@
+# -*- coding: utf-8 -*-
+# Copyright 2023 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 re
+from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union
+import warnings
+
+from google.api_core import gapic_v1, path_template, rest_helpers, rest_streaming
+from google.api_core import exceptions as core_exceptions
+from google.api_core import retry as retries
+from google.auth import credentials as ga_credentials  # type: ignore
+from google.auth.transport.grpc import SslCredentials  # type: ignore
+from google.auth.transport.requests import AuthorizedSession  # type: ignore
+from google.protobuf import json_format
+import grpc  # type: ignore
+from requests import __version__ as requests_version
+
+try:
+    OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None]
+except AttributeError:  # pragma: NO COVER
+    OptionalRetry = Union[retries.Retry, object, None]  # type: ignore
+
+
+from google.cloud.cloudcontrolspartner_v1beta.types import violations
+
+from .base import CloudControlsPartnerMonitoringTransport
+from .base import DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO
+
+DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
+    gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version,
+    grpc_version=None,
+    rest_version=requests_version,
+)
+
+
+class CloudControlsPartnerMonitoringRestInterceptor:
+    """Interceptor for CloudControlsPartnerMonitoring.
+
+    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 CloudControlsPartnerMonitoringRestTransport.
+
+    .. code-block:: python
+        class MyCustomCloudControlsPartnerMonitoringInterceptor(CloudControlsPartnerMonitoringRestInterceptor):
+            def pre_get_violation(self, request, metadata):
+                logging.log(f"Received request: {request}")
+                return request, metadata
+
+            def post_get_violation(self, response):
+                logging.log(f"Received response: {response}")
+                return response
+
+            def pre_list_violations(self, request, metadata):
+                logging.log(f"Received request: {request}")
+                return request, metadata
+
+            def post_list_violations(self, response):
+                logging.log(f"Received response: {response}")
+                return response
+
+        transport = CloudControlsPartnerMonitoringRestTransport(interceptor=MyCustomCloudControlsPartnerMonitoringInterceptor())
+        client = CloudControlsPartnerMonitoringClient(transport=transport)
+
+
+    """
+
+    def pre_get_violation(
+        self,
+        request: violations.GetViolationRequest,
+        metadata: Sequence[Tuple[str, str]],
+    ) -> Tuple[violations.GetViolationRequest, Sequence[Tuple[str, str]]]:
+        """Pre-rpc interceptor for get_violation
+
+        Override in a subclass to manipulate the request or metadata
+        before they are sent to the CloudControlsPartnerMonitoring server.
+        """
+        return request, metadata
+
+    def post_get_violation(
+        self, response: violations.Violation
+    ) -> violations.Violation:
+        """Post-rpc interceptor for get_violation
+
+        Override in a subclass to manipulate the response
+        after it is returned by the CloudControlsPartnerMonitoring server but before
+        it is returned to user code.
+        """
+        return response
+
+    def pre_list_violations(
+        self,
+        request: violations.ListViolationsRequest,
+        metadata: Sequence[Tuple[str, str]],
+    ) -> Tuple[violations.ListViolationsRequest, Sequence[Tuple[str, str]]]:
+        """Pre-rpc interceptor for list_violations
+
+        Override in a subclass to manipulate the request or metadata
+        before they are sent to the CloudControlsPartnerMonitoring server.
+        """
+        return request, metadata
+
+    def post_list_violations(
+        self, response: violations.ListViolationsResponse
+    ) -> violations.ListViolationsResponse:
+        """Post-rpc interceptor for list_violations
+
+        Override in a subclass to manipulate the response
+        after it is returned by the CloudControlsPartnerMonitoring server but before
+        it is returned to user code.
+        """
+        return response
+
+
+@dataclasses.dataclass
+class CloudControlsPartnerMonitoringRestStub:
+    _session: AuthorizedSession
+    _host: str
+    _interceptor: CloudControlsPartnerMonitoringRestInterceptor
+
+
+class CloudControlsPartnerMonitoringRestTransport(
+    CloudControlsPartnerMonitoringTransport
+):
+    """REST backend transport for CloudControlsPartnerMonitoring.
+
+    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 = "cloudcontrolspartner.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[CloudControlsPartnerMonitoringRestInterceptor] = None,
+        api_audience: Optional[str] = None,
+    ) -> None:
+        """Instantiate the transport.
+
+        Args:
+            host (Optional[str]):
+                 The hostname to connect to (default: 'cloudcontrolspartner.googleapis.com').
+            credentials (Optional[google.auth.credentials.Credentials]): The
+                authorization credentials to attach to requests. These
+                credentials identify the application to the service; if none
+                are specified, the client will attempt to ascertain the
+                credentials from the environment.
+
+            credentials_file (Optional[str]): A file with credentials that can
+                be loaded with :func:`google.auth.load_credentials_from_file`.
+                This argument is ignored if ``channel`` is provided.
+            scopes (Optional(Sequence[str])): A list of scopes. This argument is
+                ignored if ``channel`` is provided.
+            client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client
+                certificate to configure mutual TLS HTTP channel. It is ignored
+                if ``channel`` is provided.
+            quota_project_id (Optional[str]): An optional project to use for billing
+                and quota.
+            client_info (google.api_core.gapic_v1.client_info.ClientInfo):
+                The client info used to send a user-agent string along with
+                API requests. If ``None``, then default info will be used.
+                Generally, you only need to set this if you are developing
+                your own client library.
+            always_use_jwt_access (Optional[bool]): Whether self signed JWT should
+                be used for service account credentials.
+            url_scheme: the protocol scheme for the API endpoint.  Normally
+                "https", but for testing or local servers,
+                "http" can be specified.
+        """
+        # Run the base constructor
+        # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc.
+        # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the
+        # credentials object
+        maybe_url_match = re.match("^(?P<scheme>http(?:s)?://)?(?P<host>.*)$", 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,
+        )
+        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 CloudControlsPartnerMonitoringRestInterceptor()
+        )
+        self._prep_wrapped_messages(client_info)
+
+    class _GetViolation(CloudControlsPartnerMonitoringRestStub):
+        def __hash__(self):
+            return hash("GetViolation")
+
+        __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
+            }
+
+        def __call__(
+            self,
+            request: violations.GetViolationRequest,
+            *,
+            retry: OptionalRetry = gapic_v1.method.DEFAULT,
+            timeout: Optional[float] = None,
+            metadata: Sequence[Tuple[str, str]] = (),
+        ) -> violations.Violation:
+            r"""Call the get violation method over HTTP.
+
+            Args:
+                request (~.violations.GetViolationRequest):
+                    The request object. Message for getting a Violation
+                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, str]]): Strings which should be
+                    sent along with the request as metadata.
+
+            Returns:
+                ~.violations.Violation:
+                    Details of resource Violation
+            """
+
+            http_options: List[Dict[str, str]] = [
+                {
+                    "method": "get",
+                    "uri": "/v1beta/{name=organizations/*/locations/*/customers/*/workloads/*/violations/*}",
+                },
+            ]
+            request, metadata = self._interceptor.pre_get_violation(request, metadata)
+            pb_request = violations.GetViolationRequest.pb(request)
+            transcoded_request = path_template.transcode(http_options, pb_request)
+
+            uri = transcoded_request["uri"]
+            method = transcoded_request["method"]
+
+            # Jsonify the query params
+            query_params = json.loads(
+                json_format.MessageToJson(
+                    transcoded_request["query_params"],
+                    use_integers_for_enums=True,
+                )
+            )
+            query_params.update(self._get_unset_required_fields(query_params))
+
+            query_params["$alt"] = "json;enum-encoding=int"
+
+            # Send the request
+            headers = dict(metadata)
+            headers["Content-Type"] = "application/json"
+            response = getattr(self._session, method)(
+                "{host}{uri}".format(host=self._host, uri=uri),
+                timeout=timeout,
+                headers=headers,
+                params=rest_helpers.flatten_query_params(query_params, strict=True),
+            )
+
+            # 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 = violations.Violation()
+            pb_resp = violations.Violation.pb(resp)
+
+            json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True)
+            resp = self._interceptor.post_get_violation(resp)
+            return resp
+
+    class _ListViolations(CloudControlsPartnerMonitoringRestStub):
+        def __hash__(self):
+            return hash("ListViolations")
+
+        __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
+            }
+
+        def __call__(
+            self,
+            request: violations.ListViolationsRequest,
+            *,
+            retry: OptionalRetry = gapic_v1.method.DEFAULT,
+            timeout: Optional[float] = None,
+            metadata: Sequence[Tuple[str, str]] = (),
+        ) -> violations.ListViolationsResponse:
+            r"""Call the list violations method over HTTP.
+
+            Args:
+                request (~.violations.ListViolationsRequest):
+                    The request object. Message for requesting list of
+                Violations
+                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, str]]): Strings which should be
+                    sent along with the request as metadata.
+
+            Returns:
+                ~.violations.ListViolationsResponse:
+                    Response message for list customer
+                violation requests
+
+            """
+
+            http_options: List[Dict[str, str]] = [
+                {
+                    "method": "get",
+                    "uri": "/v1beta/{parent=organizations/*/locations/*/customers/*/workloads/*}/violations",
+                },
+            ]
+            request, metadata = self._interceptor.pre_list_violations(request, metadata)
+            pb_request = violations.ListViolationsRequest.pb(request)
+            transcoded_request = path_template.transcode(http_options, pb_request)
+
+            uri = transcoded_request["uri"]
+            method = transcoded_request["method"]
+
+            # Jsonify the query params
+            query_params = json.loads(
+                json_format.MessageToJson(
+                    transcoded_request["query_params"],
+                    use_integers_for_enums=True,
+                )
+            )
+            query_params.update(self._get_unset_required_fields(query_params))
+
+            query_params["$alt"] = "json;enum-encoding=int"
+
+            # Send the request
+            headers = dict(metadata)
+            headers["Content-Type"] = "application/json"
+            response = getattr(self._session, method)(
+                "{host}{uri}".format(host=self._host, uri=uri),
+                timeout=timeout,
+                headers=headers,
+                params=rest_helpers.flatten_query_params(query_params, strict=True),
+            )
+
+            # 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 = violations.ListViolationsResponse()
+            pb_resp = violations.ListViolationsResponse.pb(resp)
+
+            json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True)
+            resp = self._interceptor.post_list_violations(resp)
+            return resp
+
+    @property
+    def get_violation(
+        self,
+    ) -> Callable[[violations.GetViolationRequest], violations.Violation]:
+        # 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._GetViolation(self._session, self._host, self._interceptor)  # type: ignore
+
+    @property
+    def list_violations(
+        self,
+    ) -> Callable[
+        [violations.ListViolationsRequest], violations.ListViolationsResponse
+    ]:
+        # 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._ListViolations(self._session, self._host, self._interceptor)  # type: ignore
+
+    @property
+    def kind(self) -> str:
+        return "rest"
+
+    def close(self):
+        self._session.close()
+
+
+__all__ = ("CloudControlsPartnerMonitoringRestTransport",)

google/cloud/cloudcontrolspartner_v1beta/types/__init__.py

@@ -0,0 +1,82 @@
+# -*- coding: utf-8 -*-
+# Copyright 2023 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 .access_approval_requests import (
+    AccessApprovalRequest,
+    AccessReason,
+    ListAccessApprovalRequestsRequest,
+    ListAccessApprovalRequestsResponse,
+)
+from .completion_state import CompletionState
+from .core import OperationMetadata
+from .customer_workloads import (
+    GetWorkloadRequest,
+    ListWorkloadsRequest,
+    ListWorkloadsResponse,
+    Workload,
+    WorkloadOnboardingState,
+    WorkloadOnboardingStep,
+)
+from .customers import (
+    Customer,
+    CustomerOnboardingState,
+    CustomerOnboardingStep,
+    GetCustomerRequest,
+    ListCustomersRequest,
+    ListCustomersResponse,
+)
+from .ekm_connections import EkmConnection, EkmConnections, GetEkmConnectionsRequest
+from .partner_permissions import GetPartnerPermissionsRequest, PartnerPermissions
+from .partners import EkmMetadata, GetPartnerRequest, Partner, Sku
+from .violations import (
+    GetViolationRequest,
+    ListViolationsRequest,
+    ListViolationsResponse,
+    Violation,
+)
+
+__all__ = (
+    "AccessApprovalRequest",
+    "AccessReason",
+    "ListAccessApprovalRequestsRequest",
+    "ListAccessApprovalRequestsResponse",
+    "CompletionState",
+    "OperationMetadata",
+    "GetWorkloadRequest",
+    "ListWorkloadsRequest",
+    "ListWorkloadsResponse",
+    "Workload",
+    "WorkloadOnboardingState",
+    "WorkloadOnboardingStep",
+    "Customer",
+    "CustomerOnboardingState",
+    "CustomerOnboardingStep",
+    "GetCustomerRequest",
+    "ListCustomersRequest",
+    "ListCustomersResponse",
+    "EkmConnection",
+    "EkmConnections",
+    "GetEkmConnectionsRequest",
+    "GetPartnerPermissionsRequest",
+    "PartnerPermissions",
+    "EkmMetadata",
+    "GetPartnerRequest",
+    "Partner",
+    "Sku",
+    "GetViolationRequest",
+    "ListViolationsRequest",
+    "ListViolationsResponse",
+    "Violation",
+)