aidp-python-client 1.0.0__py3-none-any.whl

aidp_python_client/aidataplatform_dp/models/permission_summary.py

@@ -0,0 +1,274 @@
+# coding: utf-8
+# Copyright (c) 2026, Oracle and/or its affiliates.  All rights reserved.
+
+
+
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class PermissionSummary(object):
+    """
+    Information about a credential permission.
+    """
+
+    #: A constant which can be used with the grantee_type property of a PermissionSummary.
+    #: This constant has a value of "USER"
+    GRANTEE_TYPE_USER = "USER"
+
+    #: A constant which can be used with the grantee_type property of a PermissionSummary.
+    #: This constant has a value of "ROLE"
+    GRANTEE_TYPE_ROLE = "ROLE"
+
+    #: A constant which can be used with the grantee_type property of a PermissionSummary.
+    #: This constant has a value of "GROUP"
+    GRANTEE_TYPE_GROUP = "GROUP"
+
+    #: A constant which can be used with the grantee_permissions property of a PermissionSummary.
+    #: This constant has a value of "USE"
+    GRANTEE_PERMISSIONS_USE = "USE"
+
+    #: A constant which can be used with the grantee_permissions property of a PermissionSummary.
+    #: This constant has a value of "READ"
+    GRANTEE_PERMISSIONS_READ = "READ"
+
+    #: A constant which can be used with the grantee_permissions property of a PermissionSummary.
+    #: This constant has a value of "MANAGE"
+    GRANTEE_PERMISSIONS_MANAGE = "MANAGE"
+
+    #: A constant which can be used with the grantee_permissions property of a PermissionSummary.
+    #: This constant has a value of "ADMIN"
+    GRANTEE_PERMISSIONS_ADMIN = "ADMIN"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new PermissionSummary object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param grantee:
+            The value to assign to the grantee property of this PermissionSummary.
+        :type grantee: str
+
+        :param grantee_name:
+            The value to assign to the grantee_name property of this PermissionSummary.
+        :type grantee_name: str
+
+        :param grantee_type:
+            The value to assign to the grantee_type property of this PermissionSummary.
+            Allowed values for this property are: "USER", "ROLE", "GROUP"
+        :type grantee_type: str
+
+        :param grantee_permissions:
+            The value to assign to the grantee_permissions property of this PermissionSummary.
+            Allowed values for items in this list are: "USE", "READ", "MANAGE", "ADMIN"
+        :type grantee_permissions: list[str]
+
+        :param is_inherited:
+            The value to assign to the is_inherited property of this PermissionSummary.
+        :type is_inherited: bool
+
+        :param resource_name:
+            The value to assign to the resource_name property of this PermissionSummary.
+        :type resource_name: str
+
+        """
+        self.swagger_types = {
+            'grantee': 'str',
+            'grantee_name': 'str',
+            'grantee_type': 'str',
+            'grantee_permissions': 'list[str]',
+            'is_inherited': 'bool',
+            'resource_name': 'str'
+        }
+
+        self.attribute_map = {
+            'grantee': 'grantee',
+            'grantee_name': 'granteeName',
+            'grantee_type': 'granteeType',
+            'grantee_permissions': 'granteePermissions',
+            'is_inherited': 'isInherited',
+            'resource_name': 'resourceName'
+        }
+
+        self._grantee = None
+        self._grantee_name = None
+        self._grantee_type = None
+        self._grantee_permissions = None
+        self._is_inherited = None
+        self._resource_name = None
+
+    @property
+    def grantee(self):
+        """
+        **[Required]** Gets the grantee of this PermissionSummary.
+        The OCID of user/group and name in case of role.
+
+
+        :return: The grantee of this PermissionSummary.
+        :rtype: str
+        """
+        return self._grantee
+
+    @grantee.setter
+    def grantee(self, grantee):
+        """
+        Sets the grantee of this PermissionSummary.
+        The OCID of user/group and name in case of role.
+
+
+        :param grantee: The grantee of this PermissionSummary.
+        :type: str
+        """
+        self._grantee = grantee
+
+    @property
+    def grantee_name(self):
+        """
+        Gets the grantee_name of this PermissionSummary.
+        The simplified name of the grantee.
+
+
+        :return: The grantee_name of this PermissionSummary.
+        :rtype: str
+        """
+        return self._grantee_name
+
+    @grantee_name.setter
+    def grantee_name(self, grantee_name):
+        """
+        Sets the grantee_name of this PermissionSummary.
+        The simplified name of the grantee.
+
+
+        :param grantee_name: The grantee_name of this PermissionSummary.
+        :type: str
+        """
+        self._grantee_name = grantee_name
+
+    @property
+    def grantee_type(self):
+        """
+        **[Required]** Gets the grantee_type of this PermissionSummary.
+        The type of grantee.
+
+        Allowed values for this property are: "USER", "ROLE", "GROUP"
+
+
+        :return: The grantee_type of this PermissionSummary.
+        :rtype: str
+        """
+        return self._grantee_type
+
+    @grantee_type.setter
+    def grantee_type(self, grantee_type):
+        """
+        Sets the grantee_type of this PermissionSummary.
+        The type of grantee.
+
+
+        :param grantee_type: The grantee_type of this PermissionSummary.
+        :type: str
+        """
+        allowed_values = ["USER", "ROLE", "GROUP"]
+        if not value_allowed_none_or_none_sentinel(grantee_type, allowed_values):
+            raise ValueError(
+                "Invalid value for `grantee_type`, must be None or one of {0}"
+                .format(allowed_values)
+            )
+        self._grantee_type = grantee_type
+
+    @property
+    def grantee_permissions(self):
+        """
+        **[Required]** Gets the grantee_permissions of this PermissionSummary.
+        The selected permissions for a credential.
+
+        Allowed values for items in this list are: "USE", "READ", "MANAGE", "ADMIN"
+
+
+        :return: The grantee_permissions of this PermissionSummary.
+        :rtype: list[str]
+        """
+        return self._grantee_permissions
+
+    @grantee_permissions.setter
+    def grantee_permissions(self, grantee_permissions):
+        """
+        Sets the grantee_permissions of this PermissionSummary.
+        The selected permissions for a credential.
+
+
+        :param grantee_permissions: The grantee_permissions of this PermissionSummary.
+        :type: list[str]
+        """
+        allowed_values = ["USE", "READ", "MANAGE", "ADMIN"]
+        
+        if grantee_permissions and grantee_permissions is not NONE_SENTINEL:
+            for value in grantee_permissions:
+                if not value_allowed_none_or_none_sentinel(value, allowed_values):
+                    raise ValueError(
+                        "Invalid value for `grantee_permissions`, must be None or one of {0}"
+                        .format(allowed_values)
+                    )
+        self._grantee_permissions = grantee_permissions
+
+    @property
+    def is_inherited(self):
+        """
+        Gets the is_inherited of this PermissionSummary.
+        The permission listed is inherited or not from object up in hierarchy.
+
+
+        :return: The is_inherited of this PermissionSummary.
+        :rtype: bool
+        """
+        return self._is_inherited
+
+    @is_inherited.setter
+    def is_inherited(self, is_inherited):
+        """
+        Sets the is_inherited of this PermissionSummary.
+        The permission listed is inherited or not from object up in hierarchy.
+
+
+        :param is_inherited: The is_inherited of this PermissionSummary.
+        :type: bool
+        """
+        self._is_inherited = is_inherited
+
+    @property
+    def resource_name(self):
+        """
+        Gets the resource_name of this PermissionSummary.
+        Name of the object to which this permission belongs.
+
+
+        :return: The resource_name of this PermissionSummary.
+        :rtype: str
+        """
+        return self._resource_name
+
+    @resource_name.setter
+    def resource_name(self, resource_name):
+        """
+        Sets the resource_name of this PermissionSummary.
+        Name of the object to which this permission belongs.
+
+
+        :param resource_name: The resource_name of this PermissionSummary.
+        :type: str
+        """
+        self._resource_name = resource_name
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other

aidp_python_client/aidataplatform_dp/models/permission_with_resource_details.py

@@ -0,0 +1,288 @@
+# coding: utf-8
+# Copyright (c) 2026, Oracle and/or its affiliates.  All rights reserved.
+
+
+
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class PermissionWithResourceDetails(object):
+    """
+    A permission string with resource details.
+    """
+
+    #: A constant which can be used with the permissions property of a PermissionWithResourceDetails.
+    #: This constant has a value of "USER"
+    PERMISSIONS_USER = "USER"
+
+    #: A constant which can be used with the permissions property of a PermissionWithResourceDetails.
+    #: This constant has a value of "ADMINISTRATOR"
+    PERMISSIONS_ADMINISTRATOR = "ADMINISTRATOR"
+
+    #: A constant which can be used with the permissions property of a PermissionWithResourceDetails.
+    #: This constant has a value of "READ"
+    PERMISSIONS_READ = "READ"
+
+    #: A constant which can be used with the permissions property of a PermissionWithResourceDetails.
+    #: This constant has a value of "USE"
+    PERMISSIONS_USE = "USE"
+
+    #: A constant which can be used with the permissions property of a PermissionWithResourceDetails.
+    #: This constant has a value of "MANAGE"
+    PERMISSIONS_MANAGE = "MANAGE"
+
+    #: A constant which can be used with the permissions property of a PermissionWithResourceDetails.
+    #: This constant has a value of "ADMIN"
+    PERMISSIONS_ADMIN = "ADMIN"
+
+    #: A constant which can be used with the permissions property of a PermissionWithResourceDetails.
+    #: This constant has a value of "CREATE_CATALOG"
+    PERMISSIONS_CREATE_CATALOG = "CREATE_CATALOG"
+
+    #: A constant which can be used with the permissions property of a PermissionWithResourceDetails.
+    #: This constant has a value of "SELECT"
+    PERMISSIONS_SELECT = "SELECT"
+
+    #: A constant which can be used with the permissions property of a PermissionWithResourceDetails.
+    #: This constant has a value of "INSERT"
+    PERMISSIONS_INSERT = "INSERT"
+
+    #: A constant which can be used with the permissions property of a PermissionWithResourceDetails.
+    #: This constant has a value of "UPDATE"
+    PERMISSIONS_UPDATE = "UPDATE"
+
+    #: A constant which can be used with the permissions property of a PermissionWithResourceDetails.
+    #: This constant has a value of "DELETE"
+    PERMISSIONS_DELETE = "DELETE"
+
+    #: A constant which can be used with the permissions property of a PermissionWithResourceDetails.
+    #: This constant has a value of "ALTER"
+    PERMISSIONS_ALTER = "ALTER"
+
+    #: A constant which can be used with the permissions property of a PermissionWithResourceDetails.
+    #: This constant has a value of "CREATE_SCHEMA"
+    PERMISSIONS_CREATE_SCHEMA = "CREATE_SCHEMA"
+
+    #: A constant which can be used with the permissions property of a PermissionWithResourceDetails.
+    #: This constant has a value of "WRITE"
+    PERMISSIONS_WRITE = "WRITE"
+
+    #: A constant which can be used with the permissions property of a PermissionWithResourceDetails.
+    #: This constant has a value of "CREATE_VIEW"
+    PERMISSIONS_CREATE_VIEW = "CREATE_VIEW"
+
+    #: A constant which can be used with the permissions property of a PermissionWithResourceDetails.
+    #: This constant has a value of "CREATE_VOLUME"
+    PERMISSIONS_CREATE_VOLUME = "CREATE_VOLUME"
+
+    #: A constant which can be used with the permissions property of a PermissionWithResourceDetails.
+    #: This constant has a value of "CREATE_TABLE"
+    PERMISSIONS_CREATE_TABLE = "CREATE_TABLE"
+
+    #: A constant which can be used with the permissions property of a PermissionWithResourceDetails.
+    #: This constant has a value of "CREATE_KNOWLEDGE_BASE"
+    PERMISSIONS_CREATE_KNOWLEDGE_BASE = "CREATE_KNOWLEDGE_BASE"
+
+    #: A constant which can be used with the resource_type property of a PermissionWithResourceDetails.
+    #: This constant has a value of "WORKSPACE"
+    RESOURCE_TYPE_WORKSPACE = "WORKSPACE"
+
+    #: A constant which can be used with the resource_type property of a PermissionWithResourceDetails.
+    #: This constant has a value of "WORKFLOW"
+    RESOURCE_TYPE_WORKFLOW = "WORKFLOW"
+
+    #: A constant which can be used with the resource_type property of a PermissionWithResourceDetails.
+    #: This constant has a value of "FOLDER"
+    RESOURCE_TYPE_FOLDER = "FOLDER"
+
+    #: A constant which can be used with the resource_type property of a PermissionWithResourceDetails.
+    #: This constant has a value of "FILE"
+    RESOURCE_TYPE_FILE = "FILE"
+
+    #: A constant which can be used with the resource_type property of a PermissionWithResourceDetails.
+    #: This constant has a value of "CLUSTER"
+    RESOURCE_TYPE_CLUSTER = "CLUSTER"
+
+    #: A constant which can be used with the resource_type property of a PermissionWithResourceDetails.
+    #: This constant has a value of "MASTER_CATALOG"
+    RESOURCE_TYPE_MASTER_CATALOG = "MASTER_CATALOG"
+
+    #: A constant which can be used with the resource_type property of a PermissionWithResourceDetails.
+    #: This constant has a value of "CATALOG"
+    RESOURCE_TYPE_CATALOG = "CATALOG"
+
+    #: A constant which can be used with the resource_type property of a PermissionWithResourceDetails.
+    #: This constant has a value of "SCHEMA"
+    RESOURCE_TYPE_SCHEMA = "SCHEMA"
+
+    #: A constant which can be used with the resource_type property of a PermissionWithResourceDetails.
+    #: This constant has a value of "TABLE"
+    RESOURCE_TYPE_TABLE = "TABLE"
+
+    #: A constant which can be used with the resource_type property of a PermissionWithResourceDetails.
+    #: This constant has a value of "SHARE"
+    RESOURCE_TYPE_SHARE = "SHARE"
+
+    #: A constant which can be used with the resource_type property of a PermissionWithResourceDetails.
+    #: This constant has a value of "RECIPIENT"
+    RESOURCE_TYPE_RECIPIENT = "RECIPIENT"
+
+    #: A constant which can be used with the resource_type property of a PermissionWithResourceDetails.
+    #: This constant has a value of "VOLUME"
+    RESOURCE_TYPE_VOLUME = "VOLUME"
+
+    #: A constant which can be used with the resource_type property of a PermissionWithResourceDetails.
+    #: This constant has a value of "VIEW"
+    RESOURCE_TYPE_VIEW = "VIEW"
+
+    #: A constant which can be used with the resource_type property of a PermissionWithResourceDetails.
+    #: This constant has a value of "KNOWLEDGE_BASE"
+    RESOURCE_TYPE_KNOWLEDGE_BASE = "KNOWLEDGE_BASE"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new PermissionWithResourceDetails object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param permissions:
+            The value to assign to the permissions property of this PermissionWithResourceDetails.
+            Allowed values for this property are: "USER", "ADMINISTRATOR", "READ", "USE", "MANAGE", "ADMIN", "CREATE_CATALOG", "SELECT", "INSERT", "UPDATE", "DELETE", "ALTER", "CREATE_SCHEMA", "WRITE", "CREATE_VIEW", "CREATE_VOLUME", "CREATE_TABLE", "CREATE_KNOWLEDGE_BASE"
+        :type permissions: str
+
+        :param resource_type:
+            The value to assign to the resource_type property of this PermissionWithResourceDetails.
+            Allowed values for this property are: "WORKSPACE", "WORKFLOW", "FOLDER", "FILE", "CLUSTER", "MASTER_CATALOG", "CATALOG", "SCHEMA", "TABLE", "SHARE", "RECIPIENT", "VOLUME", "VIEW", "KNOWLEDGE_BASE"
+        :type resource_type: str
+
+        :param resource_key:
+            The value to assign to the resource_key property of this PermissionWithResourceDetails.
+        :type resource_key: str
+
+        """
+        self.swagger_types = {
+            'permissions': 'str',
+            'resource_type': 'str',
+            'resource_key': 'str'
+        }
+
+        self.attribute_map = {
+            'permissions': 'permissions',
+            'resource_type': 'resourceType',
+            'resource_key': 'resourceKey'
+        }
+
+        self._permissions = None
+        self._resource_type = None
+        self._resource_key = None
+
+    @property
+    def permissions(self):
+        """
+        **[Required]** Gets the permissions of this PermissionWithResourceDetails.
+        Permission or privilege name.
+
+        Allowed values for this property are: "USER", "ADMINISTRATOR", "READ", "USE", "MANAGE", "ADMIN", "CREATE_CATALOG", "SELECT", "INSERT", "UPDATE", "DELETE", "ALTER", "CREATE_SCHEMA", "WRITE", "CREATE_VIEW", "CREATE_VOLUME", "CREATE_TABLE", "CREATE_KNOWLEDGE_BASE"
+
+
+        :return: The permissions of this PermissionWithResourceDetails.
+        :rtype: str
+        """
+        return self._permissions
+
+    @permissions.setter
+    def permissions(self, permissions):
+        """
+        Sets the permissions of this PermissionWithResourceDetails.
+        Permission or privilege name.
+
+
+        :param permissions: The permissions of this PermissionWithResourceDetails.
+        :type: str
+        """
+        allowed_values = ["USER", "ADMINISTRATOR", "READ", "USE", "MANAGE", "ADMIN", "CREATE_CATALOG", "SELECT", "INSERT", "UPDATE", "DELETE", "ALTER", "CREATE_SCHEMA", "WRITE", "CREATE_VIEW", "CREATE_VOLUME", "CREATE_TABLE", "CREATE_KNOWLEDGE_BASE"]
+        if not value_allowed_none_or_none_sentinel(permissions, allowed_values):
+            raise ValueError(
+                "Invalid value for `permissions`, must be None or one of {0}"
+                .format(allowed_values)
+            )
+        self._permissions = permissions
+
+    @property
+    def resource_type(self):
+        """
+        **[Required]** Gets the resource_type of this PermissionWithResourceDetails.
+        All sub-resources in catalog and workspace.
+
+        Allowed values for this property are: "WORKSPACE", "WORKFLOW", "FOLDER", "FILE", "CLUSTER", "MASTER_CATALOG", "CATALOG", "SCHEMA", "TABLE", "SHARE", "RECIPIENT", "VOLUME", "VIEW", "KNOWLEDGE_BASE"
+
+
+        :return: The resource_type of this PermissionWithResourceDetails.
+        :rtype: str
+        """
+        return self._resource_type
+
+    @resource_type.setter
+    def resource_type(self, resource_type):
+        """
+        Sets the resource_type of this PermissionWithResourceDetails.
+        All sub-resources in catalog and workspace.
+
+
+        :param resource_type: The resource_type of this PermissionWithResourceDetails.
+        :type: str
+        """
+        allowed_values = ["WORKSPACE", "WORKFLOW", "FOLDER", "FILE", "CLUSTER", "MASTER_CATALOG", "CATALOG", "SCHEMA", "TABLE", "SHARE", "RECIPIENT", "VOLUME", "VIEW", "KNOWLEDGE_BASE"]
+        if not value_allowed_none_or_none_sentinel(resource_type, allowed_values):
+            raise ValueError(
+                "Invalid value for `resource_type`, must be None or one of {0}"
+                .format(allowed_values)
+            )
+        self._resource_type = resource_type
+
+    @property
+    def resource_key(self):
+        """
+        **[Required]** Gets the resource_key of this PermissionWithResourceDetails.
+        Workspace and its sub-resources key.
+        For example - For workspaceKey, clusterKey its a UUID
+        Within catalog its a 3 level namespace
+           tableKey - <catalogName>.<schemaName>.<tableName>
+           schemaKey - <catalogName>.<schemaName>
+           catalogKey - <catalogName>
+
+
+        :return: The resource_key of this PermissionWithResourceDetails.
+        :rtype: str
+        """
+        return self._resource_key
+
+    @resource_key.setter
+    def resource_key(self, resource_key):
+        """
+        Sets the resource_key of this PermissionWithResourceDetails.
+        Workspace and its sub-resources key.
+        For example - For workspaceKey, clusterKey its a UUID
+        Within catalog its a 3 level namespace
+           tableKey - <catalogName>.<schemaName>.<tableName>
+           schemaKey - <catalogName>.<schemaName>
+           catalogKey - <catalogName>
+
+
+        :param resource_key: The resource_key of this PermissionWithResourceDetails.
+        :type: str
+        """
+        self._resource_key = resource_key
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other