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

google/cloud/cloudcontrolspartner_v1beta/services/cloud_controls_partner_core/transports/grpc.py

@@ -0,0 +1,466 @@
+# -*- 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 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
+import grpc  # type: ignore
+
+from google.cloud.cloudcontrolspartner_v1beta.types import (
+    access_approval_requests,
+    customer_workloads,
+    customers,
+    ekm_connections,
+    partner_permissions,
+    partners,
+)
+
+from .base import DEFAULT_CLIENT_INFO, CloudControlsPartnerCoreTransport
+
+
+class CloudControlsPartnerCoreGrpcTransport(CloudControlsPartnerCoreTransport):
+    """gRPC backend transport for CloudControlsPartnerCore.
+
+    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 = "cloudcontrolspartner.googleapis.com",
+        credentials: Optional[ga_credentials.Credentials] = None,
+        credentials_file: Optional[str] = None,
+        scopes: Optional[Sequence[str]] = None,
+        channel: Optional[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: '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.
+                This argument is ignored if ``channel`` is provided.
+            credentials_file (Optional[str]): A file with credentials that can
+                be loaded with :func:`google.auth.load_credentials_from_file`.
+                This argument is ignored if ``channel`` is provided.
+            scopes (Optional(Sequence[str])): A list of scopes. This argument is
+                ignored if ``channel`` is provided.
+            channel (Optional[grpc.Channel]): A ``Channel`` instance through
+                which to make calls.
+            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 ``channel`` 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 ``channel`` 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 channel:
+            # Ignore credentials if a channel was passed.
+            credentials = False
+            # 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:
+            self._grpc_channel = type(self).create_channel(
+                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),
+                ],
+            )
+
+        # Wrap messages. This must be done after self._grpc_channel exists
+        self._prep_wrapped_messages(client_info)
+
+    @classmethod
+    def create_channel(
+        cls,
+        host: str = "cloudcontrolspartner.googleapis.com",
+        credentials: Optional[ga_credentials.Credentials] = None,
+        credentials_file: Optional[str] = None,
+        scopes: Optional[Sequence[str]] = None,
+        quota_project_id: Optional[str] = None,
+        **kwargs,
+    ) -> grpc.Channel:
+        """Create and return a gRPC channel object.
+        Args:
+            host (Optional[str]): The host for the channel to use.
+            credentials (Optional[~.Credentials]): The
+                authorization credentials to attach to requests. These
+                credentials identify this application to the service. If
+                none are specified, the client will attempt to ascertain
+                the credentials from the environment.
+            credentials_file (Optional[str]): A file with credentials that can
+                be loaded with :func:`google.auth.load_credentials_from_file`.
+                This argument is mutually exclusive with credentials.
+            scopes (Optional[Sequence[str]]): A optional list of scopes needed for this
+                service. These are only used when credentials are not specified and
+                are passed to :func:`google.auth.default`.
+            quota_project_id (Optional[str]): An optional project to use for billing
+                and quota.
+            kwargs (Optional[dict]): Keyword arguments, which are passed to the
+                channel creation.
+        Returns:
+            grpc.Channel: A gRPC channel object.
+
+        Raises:
+            google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials``
+              and ``credentials_file`` are passed.
+        """
+
+        return grpc_helpers.create_channel(
+            host,
+            credentials=credentials,
+            credentials_file=credentials_file,
+            quota_project_id=quota_project_id,
+            default_scopes=cls.AUTH_SCOPES,
+            scopes=scopes,
+            default_host=cls.DEFAULT_HOST,
+            **kwargs,
+        )
+
+    @property
+    def grpc_channel(self) -> grpc.Channel:
+        """Return the channel designed to connect to this service."""
+        return self._grpc_channel
+
+    @property
+    def get_workload(
+        self,
+    ) -> Callable[[customer_workloads.GetWorkloadRequest], customer_workloads.Workload]:
+        r"""Return a callable for the get workload method over gRPC.
+
+        Gets details of a single workload
+
+        Returns:
+            Callable[[~.GetWorkloadRequest],
+                    ~.Workload]:
+                A function that, when called, will call the underlying RPC
+                on the server.
+        """
+        # Generate a "stub function" on-the-fly which will actually make
+        # the request.
+        # gRPC handles serialization and deserialization, so we just need
+        # to pass in the functions for each.
+        if "get_workload" not in self._stubs:
+            self._stubs["get_workload"] = self.grpc_channel.unary_unary(
+                "/google.cloud.cloudcontrolspartner.v1beta.CloudControlsPartnerCore/GetWorkload",
+                request_serializer=customer_workloads.GetWorkloadRequest.serialize,
+                response_deserializer=customer_workloads.Workload.deserialize,
+            )
+        return self._stubs["get_workload"]
+
+    @property
+    def list_workloads(
+        self,
+    ) -> Callable[
+        [customer_workloads.ListWorkloadsRequest],
+        customer_workloads.ListWorkloadsResponse,
+    ]:
+        r"""Return a callable for the list workloads method over gRPC.
+
+        Lists customer workloads for a given customer org id
+
+        Returns:
+            Callable[[~.ListWorkloadsRequest],
+                    ~.ListWorkloadsResponse]:
+                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_workloads" not in self._stubs:
+            self._stubs["list_workloads"] = self.grpc_channel.unary_unary(
+                "/google.cloud.cloudcontrolspartner.v1beta.CloudControlsPartnerCore/ListWorkloads",
+                request_serializer=customer_workloads.ListWorkloadsRequest.serialize,
+                response_deserializer=customer_workloads.ListWorkloadsResponse.deserialize,
+            )
+        return self._stubs["list_workloads"]
+
+    @property
+    def get_customer(
+        self,
+    ) -> Callable[[customers.GetCustomerRequest], customers.Customer]:
+        r"""Return a callable for the get customer method over gRPC.
+
+        Gets details of a single customer
+
+        Returns:
+            Callable[[~.GetCustomerRequest],
+                    ~.Customer]:
+                A function that, when called, will call the underlying RPC
+                on the server.
+        """
+        # Generate a "stub function" on-the-fly which will actually make
+        # the request.
+        # gRPC handles serialization and deserialization, so we just need
+        # to pass in the functions for each.
+        if "get_customer" not in self._stubs:
+            self._stubs["get_customer"] = self.grpc_channel.unary_unary(
+                "/google.cloud.cloudcontrolspartner.v1beta.CloudControlsPartnerCore/GetCustomer",
+                request_serializer=customers.GetCustomerRequest.serialize,
+                response_deserializer=customers.Customer.deserialize,
+            )
+        return self._stubs["get_customer"]
+
+    @property
+    def list_customers(
+        self,
+    ) -> Callable[[customers.ListCustomersRequest], customers.ListCustomersResponse]:
+        r"""Return a callable for the list customers method over gRPC.
+
+        Lists customers of a partner identified by its Google
+        Cloud organization ID
+
+        Returns:
+            Callable[[~.ListCustomersRequest],
+                    ~.ListCustomersResponse]:
+                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_customers" not in self._stubs:
+            self._stubs["list_customers"] = self.grpc_channel.unary_unary(
+                "/google.cloud.cloudcontrolspartner.v1beta.CloudControlsPartnerCore/ListCustomers",
+                request_serializer=customers.ListCustomersRequest.serialize,
+                response_deserializer=customers.ListCustomersResponse.deserialize,
+            )
+        return self._stubs["list_customers"]
+
+    @property
+    def get_ekm_connections(
+        self,
+    ) -> Callable[
+        [ekm_connections.GetEkmConnectionsRequest], ekm_connections.EkmConnections
+    ]:
+        r"""Return a callable for the get ekm connections method over gRPC.
+
+        Gets the EKM connections associated with a workload
+
+        Returns:
+            Callable[[~.GetEkmConnectionsRequest],
+                    ~.EkmConnections]:
+                A function that, when called, will call the underlying RPC
+                on the server.
+        """
+        # Generate a "stub function" on-the-fly which will actually make
+        # the request.
+        # gRPC handles serialization and deserialization, so we just need
+        # to pass in the functions for each.
+        if "get_ekm_connections" not in self._stubs:
+            self._stubs["get_ekm_connections"] = self.grpc_channel.unary_unary(
+                "/google.cloud.cloudcontrolspartner.v1beta.CloudControlsPartnerCore/GetEkmConnections",
+                request_serializer=ekm_connections.GetEkmConnectionsRequest.serialize,
+                response_deserializer=ekm_connections.EkmConnections.deserialize,
+            )
+        return self._stubs["get_ekm_connections"]
+
+    @property
+    def get_partner_permissions(
+        self,
+    ) -> Callable[
+        [partner_permissions.GetPartnerPermissionsRequest],
+        partner_permissions.PartnerPermissions,
+    ]:
+        r"""Return a callable for the get partner permissions method over gRPC.
+
+        Gets the partner permissions granted for a workload
+
+        Returns:
+            Callable[[~.GetPartnerPermissionsRequest],
+                    ~.PartnerPermissions]:
+                A function that, when called, will call the underlying RPC
+                on the server.
+        """
+        # Generate a "stub function" on-the-fly which will actually make
+        # the request.
+        # gRPC handles serialization and deserialization, so we just need
+        # to pass in the functions for each.
+        if "get_partner_permissions" not in self._stubs:
+            self._stubs["get_partner_permissions"] = self.grpc_channel.unary_unary(
+                "/google.cloud.cloudcontrolspartner.v1beta.CloudControlsPartnerCore/GetPartnerPermissions",
+                request_serializer=partner_permissions.GetPartnerPermissionsRequest.serialize,
+                response_deserializer=partner_permissions.PartnerPermissions.deserialize,
+            )
+        return self._stubs["get_partner_permissions"]
+
+    @property
+    def list_access_approval_requests(
+        self,
+    ) -> Callable[
+        [access_approval_requests.ListAccessApprovalRequestsRequest],
+        access_approval_requests.ListAccessApprovalRequestsResponse,
+    ]:
+        r"""Return a callable for the list access approval requests method over gRPC.
+
+        Lists access requests associated with a workload
+
+        Returns:
+            Callable[[~.ListAccessApprovalRequestsRequest],
+                    ~.ListAccessApprovalRequestsResponse]:
+                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_access_approval_requests" not in self._stubs:
+            self._stubs[
+                "list_access_approval_requests"
+            ] = self.grpc_channel.unary_unary(
+                "/google.cloud.cloudcontrolspartner.v1beta.CloudControlsPartnerCore/ListAccessApprovalRequests",
+                request_serializer=access_approval_requests.ListAccessApprovalRequestsRequest.serialize,
+                response_deserializer=access_approval_requests.ListAccessApprovalRequestsResponse.deserialize,
+            )
+        return self._stubs["list_access_approval_requests"]
+
+    @property
+    def get_partner(self) -> Callable[[partners.GetPartnerRequest], partners.Partner]:
+        r"""Return a callable for the get partner method over gRPC.
+
+        Get details of a Partner.
+
+        Returns:
+            Callable[[~.GetPartnerRequest],
+                    ~.Partner]:
+                A function that, when called, will call the underlying RPC
+                on the server.
+        """
+        # Generate a "stub function" on-the-fly which will actually make
+        # the request.
+        # gRPC handles serialization and deserialization, so we just need
+        # to pass in the functions for each.
+        if "get_partner" not in self._stubs:
+            self._stubs["get_partner"] = self.grpc_channel.unary_unary(
+                "/google.cloud.cloudcontrolspartner.v1beta.CloudControlsPartnerCore/GetPartner",
+                request_serializer=partners.GetPartnerRequest.serialize,
+                response_deserializer=partners.Partner.deserialize,
+            )
+        return self._stubs["get_partner"]
+
+    def close(self):
+        self.grpc_channel.close()
+
+    @property
+    def kind(self) -> str:
+        return "grpc"
+
+
+__all__ = ("CloudControlsPartnerCoreGrpcTransport",)