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

google/cloud/cloudcontrolspartner_v1beta/types/customers.py

@@ -0,0 +1,236 @@
+# -*- 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 __future__ import annotations
+
+from typing import MutableMapping, MutableSequence
+
+from google.protobuf import timestamp_pb2  # type: ignore
+import proto  # type: ignore
+
+from google.cloud.cloudcontrolspartner_v1beta.types import (
+    completion_state as gcc_completion_state,
+)
+
+__protobuf__ = proto.module(
+    package="google.cloud.cloudcontrolspartner.v1beta",
+    manifest={
+        "Customer",
+        "ListCustomersRequest",
+        "ListCustomersResponse",
+        "GetCustomerRequest",
+        "CustomerOnboardingState",
+        "CustomerOnboardingStep",
+    },
+)
+
+
+class Customer(proto.Message):
+    r"""Contains metadata around a Cloud Controls Partner Customer
+
+    Attributes:
+        name (str):
+            Identifier. Format:
+
+            organizations/{organization}/locations/{location}/customers/{customer}
+        display_name (str):
+            The customer organization's display name.
+            E.g. "google.com".
+        customer_onboarding_state (google.cloud.cloudcontrolspartner_v1beta.types.CustomerOnboardingState):
+            Container for customer onboarding steps
+        is_onboarded (bool):
+            Indicates whether a customer is fully
+            onboarded
+    """
+
+    name: str = proto.Field(
+        proto.STRING,
+        number=1,
+    )
+    display_name: str = proto.Field(
+        proto.STRING,
+        number=2,
+    )
+    customer_onboarding_state: "CustomerOnboardingState" = proto.Field(
+        proto.MESSAGE,
+        number=3,
+        message="CustomerOnboardingState",
+    )
+    is_onboarded: bool = proto.Field(
+        proto.BOOL,
+        number=4,
+    )
+
+
+class ListCustomersRequest(proto.Message):
+    r"""Request to list customers
+
+    Attributes:
+        parent (str):
+            Required. Parent resource
+            Format:
+            organizations/{organization}/locations/{location}
+        page_size (int):
+            The maximum number of Customers to return.
+            The service may return fewer than this value. If
+            unspecified, at most 500 Customers will be
+            returned.
+        page_token (str):
+            A page token, received from a previous ``ListCustomers``
+            call. Provide this to retrieve the subsequent page.
+        filter (str):
+            Optional. Filtering results
+        order_by (str):
+            Optional. Hint for how to order the 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,
+    )
+    order_by: str = proto.Field(
+        proto.STRING,
+        number=5,
+    )
+
+
+class ListCustomersResponse(proto.Message):
+    r"""Response message for list customer Customers requests
+
+    Attributes:
+        customers (MutableSequence[google.cloud.cloudcontrolspartner_v1beta.types.Customer]):
+            List of customers
+        next_page_token (str):
+            A token that can be sent as ``page_token`` to retrieve the
+            next page. If this field is omitted, there are no subsequent
+            pages.
+        unreachable (MutableSequence[str]):
+            Locations that could not be reached.
+    """
+
+    @property
+    def raw_page(self):
+        return self
+
+    customers: MutableSequence["Customer"] = proto.RepeatedField(
+        proto.MESSAGE,
+        number=1,
+        message="Customer",
+    )
+    next_page_token: str = proto.Field(
+        proto.STRING,
+        number=2,
+    )
+    unreachable: MutableSequence[str] = proto.RepeatedField(
+        proto.STRING,
+        number=3,
+    )
+
+
+class GetCustomerRequest(proto.Message):
+    r"""Message for getting a customer
+
+    Attributes:
+        name (str):
+            Required. Format:
+
+            organizations/{organization}/locations/{location}/customers/{customer}
+    """
+
+    name: str = proto.Field(
+        proto.STRING,
+        number=1,
+    )
+
+
+class CustomerOnboardingState(proto.Message):
+    r"""Container for customer onboarding steps
+
+    Attributes:
+        onboarding_steps (MutableSequence[google.cloud.cloudcontrolspartner_v1beta.types.CustomerOnboardingStep]):
+            List of customer onboarding steps
+    """
+
+    onboarding_steps: MutableSequence["CustomerOnboardingStep"] = proto.RepeatedField(
+        proto.MESSAGE,
+        number=1,
+        message="CustomerOnboardingStep",
+    )
+
+
+class CustomerOnboardingStep(proto.Message):
+    r"""Container for customer onboarding information
+
+    Attributes:
+        step (google.cloud.cloudcontrolspartner_v1beta.types.CustomerOnboardingStep.Step):
+            The onboarding step
+        start_time (google.protobuf.timestamp_pb2.Timestamp):
+            The starting time of the onboarding step
+        completion_time (google.protobuf.timestamp_pb2.Timestamp):
+            The completion time of the onboarding step
+        completion_state (google.cloud.cloudcontrolspartner_v1beta.types.CompletionState):
+            Output only. Current state of the step
+    """
+
+    class Step(proto.Enum):
+        r"""Enum for possible onboarding steps
+
+        Values:
+            STEP_UNSPECIFIED (0):
+                Unspecified step
+            KAJ_ENROLLMENT (1):
+                KAJ Enrollment
+            CUSTOMER_ENVIRONMENT (2):
+                Customer Environment
+        """
+        STEP_UNSPECIFIED = 0
+        KAJ_ENROLLMENT = 1
+        CUSTOMER_ENVIRONMENT = 2
+
+    step: Step = proto.Field(
+        proto.ENUM,
+        number=1,
+        enum=Step,
+    )
+    start_time: timestamp_pb2.Timestamp = proto.Field(
+        proto.MESSAGE,
+        number=2,
+        message=timestamp_pb2.Timestamp,
+    )
+    completion_time: timestamp_pb2.Timestamp = proto.Field(
+        proto.MESSAGE,
+        number=3,
+        message=timestamp_pb2.Timestamp,
+    )
+    completion_state: gcc_completion_state.CompletionState = proto.Field(
+        proto.ENUM,
+        number=4,
+        enum=gcc_completion_state.CompletionState,
+    )
+
+
+__all__ = tuple(sorted(__protobuf__.manifest))

google/cloud/cloudcontrolspartner_v1beta/types/ekm_connections.py

@@ -0,0 +1,143 @@
+# -*- 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 __future__ import annotations
+
+from typing import MutableMapping, MutableSequence
+
+import proto  # type: ignore
+
+__protobuf__ = proto.module(
+    package="google.cloud.cloudcontrolspartner.v1beta",
+    manifest={
+        "EkmConnections",
+        "GetEkmConnectionsRequest",
+        "EkmConnection",
+    },
+)
+
+
+class EkmConnections(proto.Message):
+    r"""The EKM connections associated with a workload
+
+    Attributes:
+        name (str):
+            Identifier. Format:
+
+            organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/ekmConnections
+        ekm_connections (MutableSequence[google.cloud.cloudcontrolspartner_v1beta.types.EkmConnection]):
+            The EKM connections associated with the
+            workload
+    """
+
+    name: str = proto.Field(
+        proto.STRING,
+        number=1,
+    )
+    ekm_connections: MutableSequence["EkmConnection"] = proto.RepeatedField(
+        proto.MESSAGE,
+        number=2,
+        message="EkmConnection",
+    )
+
+
+class GetEkmConnectionsRequest(proto.Message):
+    r"""Request for getting the EKM connections associated with a
+    workload
+
+    Attributes:
+        name (str):
+            Required. Format:
+
+            organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/ekmConnections
+    """
+
+    name: str = proto.Field(
+        proto.STRING,
+        number=1,
+    )
+
+
+class EkmConnection(proto.Message):
+    r"""Details about the EKM connection
+
+    Attributes:
+        connection_name (str):
+            Resource name of the EKM connection in the format:
+            projects/{project}/locations/{location}/ekmConnections/{ekm_connection}
+        connection_state (google.cloud.cloudcontrolspartner_v1beta.types.EkmConnection.ConnectionState):
+            Output only. The connection state
+        connection_error (google.cloud.cloudcontrolspartner_v1beta.types.EkmConnection.ConnectionError):
+            The connection error that occurred if any
+    """
+
+    class ConnectionState(proto.Enum):
+        r"""The EKM connection state.
+
+        Values:
+            CONNECTION_STATE_UNSPECIFIED (0):
+                Unspecified EKM connection state
+            AVAILABLE (1):
+                Available EKM connection state
+            NOT_AVAILABLE (2):
+                Not available EKM connection state
+            ERROR (3):
+                Error EKM connection state
+            PERMISSION_DENIED (4):
+                Permission denied EKM connection state
+        """
+        CONNECTION_STATE_UNSPECIFIED = 0
+        AVAILABLE = 1
+        NOT_AVAILABLE = 2
+        ERROR = 3
+        PERMISSION_DENIED = 4
+
+    class ConnectionError(proto.Message):
+        r"""Information around the error that occurred if the connection
+        state is anything other than available or unspecified
+
+        Attributes:
+            error_domain (str):
+                The error domain for the error
+            error_message (str):
+                The error message for the error
+        """
+
+        error_domain: str = proto.Field(
+            proto.STRING,
+            number=1,
+        )
+        error_message: str = proto.Field(
+            proto.STRING,
+            number=2,
+        )
+
+    connection_name: str = proto.Field(
+        proto.STRING,
+        number=1,
+    )
+    connection_state: ConnectionState = proto.Field(
+        proto.ENUM,
+        number=2,
+        enum=ConnectionState,
+    )
+    connection_error: ConnectionError = proto.Field(
+        proto.MESSAGE,
+        number=3,
+        message=ConnectionError,
+    )
+
+
+__all__ = tuple(sorted(__protobuf__.manifest))

google/cloud/cloudcontrolspartner_v1beta/types/monitoring.py

@@ -0,0 +1,24 @@
+# -*- 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 proto  # type: ignore
+
+__protobuf__ = proto.module(
+    package="google.cloud.cloudcontrolspartner.v1beta",
+    manifest={},
+)
+
+
+__all__ = tuple(sorted(__protobuf__.manifest))

google/cloud/cloudcontrolspartner_v1beta/types/partner_permissions.py

@@ -0,0 +1,96 @@
+# -*- 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 __future__ import annotations
+
+from typing import MutableMapping, MutableSequence
+
+import proto  # type: ignore
+
+__protobuf__ = proto.module(
+    package="google.cloud.cloudcontrolspartner.v1beta",
+    manifest={
+        "PartnerPermissions",
+        "GetPartnerPermissionsRequest",
+    },
+)
+
+
+class PartnerPermissions(proto.Message):
+    r"""The permissions granted to the partner for a workload
+
+    Attributes:
+        name (str):
+            Identifier. Format:
+
+            organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/partnerPermissions
+        partner_permissions (MutableSequence[google.cloud.cloudcontrolspartner_v1beta.types.PartnerPermissions.Permission]):
+            The partner permissions granted for the
+            workload
+    """
+
+    class Permission(proto.Enum):
+        r"""
+
+        Values:
+            PERMISSION_UNSPECIFIED (0):
+                Unspecified partner permission
+            ACCESS_TRANSPARENCY_AND_EMERGENCY_ACCESS_LOGS (1):
+                Permission for Access Transparency and
+                emergency logs
+            ASSURED_WORKLOADS_MONITORING (2):
+                Permission for Assured Workloads monitoring
+                violations
+            ACCESS_APPROVAL_REQUESTS (3):
+                Permission for Access Approval requests
+            ASSURED_WORKLOADS_EKM_CONNECTION_STATUS (4):
+                Permission for External Key Manager
+                connection status
+        """
+        PERMISSION_UNSPECIFIED = 0
+        ACCESS_TRANSPARENCY_AND_EMERGENCY_ACCESS_LOGS = 1
+        ASSURED_WORKLOADS_MONITORING = 2
+        ACCESS_APPROVAL_REQUESTS = 3
+        ASSURED_WORKLOADS_EKM_CONNECTION_STATUS = 4
+
+    name: str = proto.Field(
+        proto.STRING,
+        number=1,
+    )
+    partner_permissions: MutableSequence[Permission] = proto.RepeatedField(
+        proto.ENUM,
+        number=2,
+        enum=Permission,
+    )
+
+
+class GetPartnerPermissionsRequest(proto.Message):
+    r"""Request for getting the partner permissions granted for a
+    workload
+
+    Attributes:
+        name (str):
+            Required. Name of the resource to get in the
+            format:
+            organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/partnerPermissions
+    """
+
+    name: str = proto.Field(
+        proto.STRING,
+        number=1,
+    )
+
+
+__all__ = tuple(sorted(__protobuf__.manifest))

google/cloud/cloudcontrolspartner_v1beta/types/partners.py

@@ -0,0 +1,189 @@
+# -*- 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 __future__ import annotations
+
+from typing import MutableMapping, MutableSequence
+
+from google.protobuf import timestamp_pb2  # type: ignore
+import proto  # type: ignore
+
+__protobuf__ = proto.module(
+    package="google.cloud.cloudcontrolspartner.v1beta",
+    manifest={
+        "Partner",
+        "GetPartnerRequest",
+        "Sku",
+        "EkmMetadata",
+    },
+)
+
+
+class Partner(proto.Message):
+    r"""Message describing Partner resource
+
+    Attributes:
+        name (str):
+            Identifier. The resource name of the partner.
+            Format:
+            organizations/{organization}/locations/{location}/partner
+            Example:
+            "organizations/123456/locations/us-central1/partner".
+        skus (MutableSequence[google.cloud.cloudcontrolspartner_v1beta.types.Sku]):
+            List of SKUs the partner is offering
+        ekm_solutions (MutableSequence[google.cloud.cloudcontrolspartner_v1beta.types.EkmMetadata]):
+            List of Google Cloud supported EKM partners
+            supported by the partner
+        operated_cloud_regions (MutableSequence[str]):
+            List of Google Cloud regions that the partner
+            sells services to customers. Valid Google Cloud
+            regions found here:
+
+            https://cloud.google.com/compute/docs/regions-zones
+        partner_project_id (str):
+            Google Cloud project ID in the partner's
+            Google Cloud organization for receiving enhanced
+            Logs for Partners.
+        create_time (google.protobuf.timestamp_pb2.Timestamp):
+            Output only. Time the resource was created
+        update_time (google.protobuf.timestamp_pb2.Timestamp):
+            Output only. The last time the resource was
+            updated
+    """
+
+    name: str = proto.Field(
+        proto.STRING,
+        number=1,
+    )
+    skus: MutableSequence["Sku"] = proto.RepeatedField(
+        proto.MESSAGE,
+        number=3,
+        message="Sku",
+    )
+    ekm_solutions: MutableSequence["EkmMetadata"] = proto.RepeatedField(
+        proto.MESSAGE,
+        number=4,
+        message="EkmMetadata",
+    )
+    operated_cloud_regions: MutableSequence[str] = proto.RepeatedField(
+        proto.STRING,
+        number=5,
+    )
+    partner_project_id: str = proto.Field(
+        proto.STRING,
+        number=7,
+    )
+    create_time: timestamp_pb2.Timestamp = proto.Field(
+        proto.MESSAGE,
+        number=9,
+        message=timestamp_pb2.Timestamp,
+    )
+    update_time: timestamp_pb2.Timestamp = proto.Field(
+        proto.MESSAGE,
+        number=10,
+        message=timestamp_pb2.Timestamp,
+    )
+
+
+class GetPartnerRequest(proto.Message):
+    r"""Message for getting a Partner
+
+    Attributes:
+        name (str):
+            Required. Format:
+            organizations/{organization}/locations/{location}/partner
+    """
+
+    name: str = proto.Field(
+        proto.STRING,
+        number=1,
+    )
+
+
+class Sku(proto.Message):
+    r"""Represents the SKU a partner owns inside Google Cloud to sell
+    to customers.
+
+    Attributes:
+        id (str):
+            Argentum product SKU, that is associated with
+            the partner offerings to customers used by
+            Syntro for billing purposes. SKUs can represent
+            resold Google products or support services.
+        display_name (str):
+            Display name of the product identified by the
+            SKU. A partner may want to show partner branded
+            names for their offerings such as local
+            sovereign cloud solutions.
+    """
+
+    id: str = proto.Field(
+        proto.STRING,
+        number=1,
+    )
+    display_name: str = proto.Field(
+        proto.STRING,
+        number=2,
+    )
+
+
+class EkmMetadata(proto.Message):
+    r"""Holds information needed by Mudbray to use partner EKMs for
+    workloads.
+
+    Attributes:
+        ekm_solution (google.cloud.cloudcontrolspartner_v1beta.types.EkmMetadata.EkmSolution):
+            The Cloud EKM partner.
+        ekm_endpoint_uri (str):
+            Endpoint for sending requests to the EKM for
+            key provisioning during Assured Workload
+            creation.
+    """
+
+    class EkmSolution(proto.Enum):
+        r"""Represents Google Cloud supported external key management partners
+        `Google Cloud EKM partners
+        docs <https://cloud.google.com/kms/docs/ekm#supported_partners>`__.
+
+        Values:
+            EKM_SOLUTION_UNSPECIFIED (0):
+                Unspecified EKM solution
+            FORTANIX (1):
+                EKM Partner Fortanix
+            FUTUREX (2):
+                EKM Partner FutureX
+            THALES (3):
+                EKM Partner Thales
+            VIRTRU (4):
+                EKM Partner Virtu
+        """
+        EKM_SOLUTION_UNSPECIFIED = 0
+        FORTANIX = 1
+        FUTUREX = 2
+        THALES = 3
+        VIRTRU = 4
+
+    ekm_solution: EkmSolution = proto.Field(
+        proto.ENUM,
+        number=1,
+        enum=EkmSolution,
+    )
+    ekm_endpoint_uri: str = proto.Field(
+        proto.STRING,
+        number=2,
+    )
+
+
+__all__ = tuple(sorted(__protobuf__.manifest))