databricks-sdk 0.57.0__py3-none-any.whl → 0.59.0__py3-none-any.whl

databricks/sdk/service/sharing.py

@@ -55,193 +55,6 @@ class ColumnTypeName(Enum):
     VARIANT = "VARIANT"
 
 
-@dataclass
-class CreateProvider:
-    name: str
-    """The name of the Provider."""
-
-    authentication_type: AuthenticationType
-    """The delta sharing authentication type."""
-
-    comment: Optional[str] = None
-    """Description about the provider."""
-
-    recipient_profile_str: Optional[str] = None
-    """This field is required when the __authentication_type__ is **TOKEN**,
-    **OAUTH_CLIENT_CREDENTIALS** or not provided."""
-
-    def as_dict(self) -> dict:
-        """Serializes the CreateProvider into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        if self.authentication_type is not None:
-            body["authentication_type"] = self.authentication_type.value
-        if self.comment is not None:
-            body["comment"] = self.comment
-        if self.name is not None:
-            body["name"] = self.name
-        if self.recipient_profile_str is not None:
-            body["recipient_profile_str"] = self.recipient_profile_str
-        return body
-
-    def as_shallow_dict(self) -> dict:
-        """Serializes the CreateProvider into a shallow dictionary of its immediate attributes."""
-        body = {}
-        if self.authentication_type is not None:
-            body["authentication_type"] = self.authentication_type
-        if self.comment is not None:
-            body["comment"] = self.comment
-        if self.name is not None:
-            body["name"] = self.name
-        if self.recipient_profile_str is not None:
-            body["recipient_profile_str"] = self.recipient_profile_str
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> CreateProvider:
-        """Deserializes the CreateProvider from a dictionary."""
-        return cls(
-            authentication_type=_enum(d, "authentication_type", AuthenticationType),
-            comment=d.get("comment", None),
-            name=d.get("name", None),
-            recipient_profile_str=d.get("recipient_profile_str", None),
-        )
-
-
-@dataclass
-class CreateRecipient:
-    name: str
-    """Name of Recipient."""
-
-    authentication_type: AuthenticationType
-    """The delta sharing authentication type."""
-
-    comment: Optional[str] = None
-    """Description about the recipient."""
-
-    data_recipient_global_metastore_id: Optional[str] = None
-    """The global Unity Catalog metastore id provided by the data recipient. This field is only present
-    when the __authentication_type__ is **DATABRICKS**. The identifier is of format
-    __cloud__:__region__:__metastore-uuid__."""
-
-    expiration_time: Optional[int] = None
-    """Expiration timestamp of the token, in epoch milliseconds."""
-
-    ip_access_list: Optional[IpAccessList] = None
-    """IP Access List"""
-
-    owner: Optional[str] = None
-    """Username of the recipient owner."""
-
-    properties_kvpairs: Optional[SecurablePropertiesKvPairs] = None
-    """Recipient properties as map of string key-value pairs. When provided in update request, the
-    specified properties will override the existing properties. To add and remove properties, one
-    would need to perform a read-modify-write."""
-
-    sharing_code: Optional[str] = None
-    """The one-time sharing code provided by the data recipient. This field is only present when the
-    __authentication_type__ is **DATABRICKS**."""
-
-    def as_dict(self) -> dict:
-        """Serializes the CreateRecipient into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        if self.authentication_type is not None:
-            body["authentication_type"] = self.authentication_type.value
-        if self.comment is not None:
-            body["comment"] = self.comment
-        if self.data_recipient_global_metastore_id is not None:
-            body["data_recipient_global_metastore_id"] = self.data_recipient_global_metastore_id
-        if self.expiration_time is not None:
-            body["expiration_time"] = self.expiration_time
-        if self.ip_access_list:
-            body["ip_access_list"] = self.ip_access_list.as_dict()
-        if self.name is not None:
-            body["name"] = self.name
-        if self.owner is not None:
-            body["owner"] = self.owner
-        if self.properties_kvpairs:
-            body["properties_kvpairs"] = self.properties_kvpairs.as_dict()
-        if self.sharing_code is not None:
-            body["sharing_code"] = self.sharing_code
-        return body
-
-    def as_shallow_dict(self) -> dict:
-        """Serializes the CreateRecipient into a shallow dictionary of its immediate attributes."""
-        body = {}
-        if self.authentication_type is not None:
-            body["authentication_type"] = self.authentication_type
-        if self.comment is not None:
-            body["comment"] = self.comment
-        if self.data_recipient_global_metastore_id is not None:
-            body["data_recipient_global_metastore_id"] = self.data_recipient_global_metastore_id
-        if self.expiration_time is not None:
-            body["expiration_time"] = self.expiration_time
-        if self.ip_access_list:
-            body["ip_access_list"] = self.ip_access_list
-        if self.name is not None:
-            body["name"] = self.name
-        if self.owner is not None:
-            body["owner"] = self.owner
-        if self.properties_kvpairs:
-            body["properties_kvpairs"] = self.properties_kvpairs
-        if self.sharing_code is not None:
-            body["sharing_code"] = self.sharing_code
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> CreateRecipient:
-        """Deserializes the CreateRecipient from a dictionary."""
-        return cls(
-            authentication_type=_enum(d, "authentication_type", AuthenticationType),
-            comment=d.get("comment", None),
-            data_recipient_global_metastore_id=d.get("data_recipient_global_metastore_id", None),
-            expiration_time=d.get("expiration_time", None),
-            ip_access_list=_from_dict(d, "ip_access_list", IpAccessList),
-            name=d.get("name", None),
-            owner=d.get("owner", None),
-            properties_kvpairs=_from_dict(d, "properties_kvpairs", SecurablePropertiesKvPairs),
-            sharing_code=d.get("sharing_code", None),
-        )
-
-
-@dataclass
-class CreateShare:
-    name: str
-    """Name of the share."""
-
-    comment: Optional[str] = None
-    """User-provided free-form text description."""
-
-    storage_root: Optional[str] = None
-    """Storage root URL for the share."""
-
-    def as_dict(self) -> dict:
-        """Serializes the CreateShare into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        if self.comment is not None:
-            body["comment"] = self.comment
-        if self.name is not None:
-            body["name"] = self.name
-        if self.storage_root is not None:
-            body["storage_root"] = self.storage_root
-        return body
-
-    def as_shallow_dict(self) -> dict:
-        """Serializes the CreateShare into a shallow dictionary of its immediate attributes."""
-        body = {}
-        if self.comment is not None:
-            body["comment"] = self.comment
-        if self.name is not None:
-            body["name"] = self.name
-        if self.storage_root is not None:
-            body["storage_root"] = self.storage_root
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> CreateShare:
-        """Deserializes the CreateShare from a dictionary."""
-        return cls(comment=d.get("comment", None), name=d.get("name", None), storage_root=d.get("storage_root", None))
-
-
 @dataclass
 class DeleteResponse:
     def as_dict(self) -> dict:
@@ -265,10 +78,8 @@ class DeltaSharingDependency:
     """Represents a UC dependency."""
 
     function: Optional[DeltaSharingFunctionDependency] = None
-    """A Function in UC as a dependency."""
 
     table: Optional[DeltaSharingTableDependency] = None
-    """A Table in UC as a dependency."""
 
     def as_dict(self) -> dict:
         """Serializes the DeltaSharingDependency into a dictionary suitable for use as a JSON request body."""
@@ -1320,7 +1131,8 @@ class PermissionsChange:
     """The set of privileges to add."""
 
     principal: Optional[str] = None
-    """The principal whose privileges we are changing."""
+    """The principal whose privileges we are changing. Only one of principal or principal_id should be
+    specified, never both at the same time."""
 
     remove: Optional[List[str]] = None
     """The set of privileges to remove."""
@@ -1405,7 +1217,8 @@ class Privilege(Enum):
 @dataclass
 class PrivilegeAssignment:
     principal: Optional[str] = None
-    """The principal (user email address or group name)."""
+    """The principal (user email address or group name). For deleted principals, `principal` is empty
+    while `principal_id` is populated."""
 
     privileges: Optional[List[Privilege]] = None
     """The privileges assigned to the principal."""
@@ -1437,7 +1250,6 @@ class PrivilegeAssignment:
 @dataclass
 class ProviderInfo:
     authentication_type: Optional[AuthenticationType] = None
-    """The delta sharing authentication type."""
 
     cloud: Optional[str] = None
     """Cloud vendor of the provider's UC metastore. This field is only present when the
@@ -1607,7 +1419,6 @@ class RecipientInfo:
     retrieved."""
 
     authentication_type: Optional[AuthenticationType] = None
-    """The delta sharing authentication type."""
 
     cloud: Optional[str] = None
     """Cloud vendor of the recipient's Unity Catalog Metastore. This field is only present when the
@@ -1979,42 +1790,6 @@ class RetrieveTokenResponse:
         )
 
 
-@dataclass
-class RotateRecipientToken:
-    existing_token_expire_in_seconds: int
-    """The expiration time of the bearer token in ISO 8601 format. This will set the expiration_time of
-    existing token only to a smaller timestamp, it cannot extend the expiration_time. Use 0 to
-    expire the existing token immediately, negative number will return an error."""
-
-    name: Optional[str] = None
-    """The name of the Recipient."""
-
-    def as_dict(self) -> dict:
-        """Serializes the RotateRecipientToken into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        if self.existing_token_expire_in_seconds is not None:
-            body["existing_token_expire_in_seconds"] = self.existing_token_expire_in_seconds
-        if self.name is not None:
-            body["name"] = self.name
-        return body
-
-    def as_shallow_dict(self) -> dict:
-        """Serializes the RotateRecipientToken into a shallow dictionary of its immediate attributes."""
-        body = {}
-        if self.existing_token_expire_in_seconds is not None:
-            body["existing_token_expire_in_seconds"] = self.existing_token_expire_in_seconds
-        if self.name is not None:
-            body["name"] = self.name
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> RotateRecipientToken:
-        """Deserializes the RotateRecipientToken from a dictionary."""
-        return cls(
-            existing_token_expire_in_seconds=d.get("existing_token_expire_in_seconds", None), name=d.get("name", None)
-        )
-
-
 @dataclass
 class SecurablePropertiesKvPairs:
     """An object with __properties__ containing map of key-value properties attached to the securable."""
@@ -2549,6 +2324,7 @@ class TableInternalAttributes:
 
 class TableInternalAttributesSharedTableType(Enum):
 
+    DELTA_ICEBERG_TABLE = "DELTA_ICEBERG_TABLE"
     DIRECTORY_BASED_TABLE = "DIRECTORY_BASED_TABLE"
     FILE_BASED_TABLE = "FILE_BASED_TABLE"
     FOREIGN_TABLE = "FOREIGN_TABLE"
@@ -2557,253 +2333,6 @@ class TableInternalAttributesSharedTableType(Enum):
     VIEW = "VIEW"
 
 
-@dataclass
-class UpdateProvider:
-    comment: Optional[str] = None
-    """Description about the provider."""
-
-    name: Optional[str] = None
-    """Name of the provider."""
-
-    new_name: Optional[str] = None
-    """New name for the provider."""
-
-    owner: Optional[str] = None
-    """Username of Provider owner."""
-
-    recipient_profile_str: Optional[str] = None
-    """This field is required when the __authentication_type__ is **TOKEN**,
-    **OAUTH_CLIENT_CREDENTIALS** or not provided."""
-
-    def as_dict(self) -> dict:
-        """Serializes the UpdateProvider into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        if self.comment is not None:
-            body["comment"] = self.comment
-        if self.name is not None:
-            body["name"] = self.name
-        if self.new_name is not None:
-            body["new_name"] = self.new_name
-        if self.owner is not None:
-            body["owner"] = self.owner
-        if self.recipient_profile_str is not None:
-            body["recipient_profile_str"] = self.recipient_profile_str
-        return body
-
-    def as_shallow_dict(self) -> dict:
-        """Serializes the UpdateProvider into a shallow dictionary of its immediate attributes."""
-        body = {}
-        if self.comment is not None:
-            body["comment"] = self.comment
-        if self.name is not None:
-            body["name"] = self.name
-        if self.new_name is not None:
-            body["new_name"] = self.new_name
-        if self.owner is not None:
-            body["owner"] = self.owner
-        if self.recipient_profile_str is not None:
-            body["recipient_profile_str"] = self.recipient_profile_str
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> UpdateProvider:
-        """Deserializes the UpdateProvider from a dictionary."""
-        return cls(
-            comment=d.get("comment", None),
-            name=d.get("name", None),
-            new_name=d.get("new_name", None),
-            owner=d.get("owner", None),
-            recipient_profile_str=d.get("recipient_profile_str", None),
-        )
-
-
-@dataclass
-class UpdateRecipient:
-    comment: Optional[str] = None
-    """Description about the recipient."""
-
-    expiration_time: Optional[int] = None
-    """Expiration timestamp of the token, in epoch milliseconds."""
-
-    ip_access_list: Optional[IpAccessList] = None
-    """IP Access List"""
-
-    name: Optional[str] = None
-    """Name of the recipient."""
-
-    new_name: Optional[str] = None
-    """New name for the recipient. ."""
-
-    owner: Optional[str] = None
-    """Username of the recipient owner."""
-
-    properties_kvpairs: Optional[SecurablePropertiesKvPairs] = None
-    """Recipient properties as map of string key-value pairs. When provided in update request, the
-    specified properties will override the existing properties. To add and remove properties, one
-    would need to perform a read-modify-write."""
-
-    def as_dict(self) -> dict:
-        """Serializes the UpdateRecipient into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        if self.comment is not None:
-            body["comment"] = self.comment
-        if self.expiration_time is not None:
-            body["expiration_time"] = self.expiration_time
-        if self.ip_access_list:
-            body["ip_access_list"] = self.ip_access_list.as_dict()
-        if self.name is not None:
-            body["name"] = self.name
-        if self.new_name is not None:
-            body["new_name"] = self.new_name
-        if self.owner is not None:
-            body["owner"] = self.owner
-        if self.properties_kvpairs:
-            body["properties_kvpairs"] = self.properties_kvpairs.as_dict()
-        return body
-
-    def as_shallow_dict(self) -> dict:
-        """Serializes the UpdateRecipient into a shallow dictionary of its immediate attributes."""
-        body = {}
-        if self.comment is not None:
-            body["comment"] = self.comment
-        if self.expiration_time is not None:
-            body["expiration_time"] = self.expiration_time
-        if self.ip_access_list:
-            body["ip_access_list"] = self.ip_access_list
-        if self.name is not None:
-            body["name"] = self.name
-        if self.new_name is not None:
-            body["new_name"] = self.new_name
-        if self.owner is not None:
-            body["owner"] = self.owner
-        if self.properties_kvpairs:
-            body["properties_kvpairs"] = self.properties_kvpairs
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> UpdateRecipient:
-        """Deserializes the UpdateRecipient from a dictionary."""
-        return cls(
-            comment=d.get("comment", None),
-            expiration_time=d.get("expiration_time", None),
-            ip_access_list=_from_dict(d, "ip_access_list", IpAccessList),
-            name=d.get("name", None),
-            new_name=d.get("new_name", None),
-            owner=d.get("owner", None),
-            properties_kvpairs=_from_dict(d, "properties_kvpairs", SecurablePropertiesKvPairs),
-        )
-
-
-@dataclass
-class UpdateShare:
-    comment: Optional[str] = None
-    """User-provided free-form text description."""
-
-    name: Optional[str] = None
-    """The name of the share."""
-
-    new_name: Optional[str] = None
-    """New name for the share."""
-
-    owner: Optional[str] = None
-    """Username of current owner of share."""
-
-    storage_root: Optional[str] = None
-    """Storage root URL for the share."""
-
-    updates: Optional[List[SharedDataObjectUpdate]] = None
-    """Array of shared data object updates."""
-
-    def as_dict(self) -> dict:
-        """Serializes the UpdateShare into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        if self.comment is not None:
-            body["comment"] = self.comment
-        if self.name is not None:
-            body["name"] = self.name
-        if self.new_name is not None:
-            body["new_name"] = self.new_name
-        if self.owner is not None:
-            body["owner"] = self.owner
-        if self.storage_root is not None:
-            body["storage_root"] = self.storage_root
-        if self.updates:
-            body["updates"] = [v.as_dict() for v in self.updates]
-        return body
-
-    def as_shallow_dict(self) -> dict:
-        """Serializes the UpdateShare into a shallow dictionary of its immediate attributes."""
-        body = {}
-        if self.comment is not None:
-            body["comment"] = self.comment
-        if self.name is not None:
-            body["name"] = self.name
-        if self.new_name is not None:
-            body["new_name"] = self.new_name
-        if self.owner is not None:
-            body["owner"] = self.owner
-        if self.storage_root is not None:
-            body["storage_root"] = self.storage_root
-        if self.updates:
-            body["updates"] = self.updates
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> UpdateShare:
-        """Deserializes the UpdateShare from a dictionary."""
-        return cls(
-            comment=d.get("comment", None),
-            name=d.get("name", None),
-            new_name=d.get("new_name", None),
-            owner=d.get("owner", None),
-            storage_root=d.get("storage_root", None),
-            updates=_repeated_dict(d, "updates", SharedDataObjectUpdate),
-        )
-
-
-@dataclass
-class UpdateSharePermissions:
-    changes: Optional[List[PermissionsChange]] = None
-    """Array of permissions change objects."""
-
-    name: Optional[str] = None
-    """The name of the share."""
-
-    omit_permissions_list: Optional[bool] = None
-    """Optional. Whether to return the latest permissions list of the share in the response."""
-
-    def as_dict(self) -> dict:
-        """Serializes the UpdateSharePermissions into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        if self.changes:
-            body["changes"] = [v.as_dict() for v in self.changes]
-        if self.name is not None:
-            body["name"] = self.name
-        if self.omit_permissions_list is not None:
-            body["omit_permissions_list"] = self.omit_permissions_list
-        return body
-
-    def as_shallow_dict(self) -> dict:
-        """Serializes the UpdateSharePermissions into a shallow dictionary of its immediate attributes."""
-        body = {}
-        if self.changes:
-            body["changes"] = self.changes
-        if self.name is not None:
-            body["name"] = self.name
-        if self.omit_permissions_list is not None:
-            body["omit_permissions_list"] = self.omit_permissions_list
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> UpdateSharePermissions:
-        """Deserializes the UpdateSharePermissions from a dictionary."""
-        return cls(
-            changes=_repeated_dict(d, "changes", PermissionsChange),
-            name=d.get("name", None),
-            omit_permissions_list=d.get("omit_permissions_list", None),
-        )
-
-
 @dataclass
 class UpdateSharePermissionsResponse:
     privilege_assignments: Optional[List[PrivilegeAssignment]] = None
@@ -2968,7 +2497,6 @@ class ProvidersAPI:
         :param name: str
           The name of the Provider.
         :param authentication_type: :class:`AuthenticationType`
-          The delta sharing authentication type.
         :param comment: str (optional)
           Description about the provider.
         :param recipient_profile_str: str (optional)
@@ -3308,6 +2836,7 @@ class RecipientFederationPoliciesAPI:
         :param recipient_name: str
           Name of the recipient. This is the name of the recipient for which the policy is being created.
         :param policy: :class:`FederationPolicy`
+          Name of the policy. This is the name of the policy to be created.
 
         :returns: :class:`FederationPolicy`
         """
@@ -3476,7 +3005,6 @@ class RecipientsAPI:
         :param name: str
           Name of Recipient.
         :param authentication_type: :class:`AuthenticationType`
-          The delta sharing authentication type.
         :param comment: str (optional)
           Description about the recipient.
         :param data_recipient_global_metastore_id: str (optional)