databricks-sdk 0.23.0__py3-none-any.whl → 0.25.0__py3-none-any.whl

databricks/sdk/service/compute.py

@@ -388,6 +388,23 @@ class ClientsTypes:
         return cls(jobs=d.get('jobs', None), notebooks=d.get('notebooks', None))
 
 
+@dataclass
+class CloneCluster:
+    source_cluster_id: str
+    """The cluster that is being cloned."""
+
+    def as_dict(self) -> dict:
+        """Serializes the CloneCluster into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        if self.source_cluster_id is not None: body['source_cluster_id'] = self.source_cluster_id
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> CloneCluster:
+        """Deserializes the CloneCluster from a dictionary."""
+        return cls(source_cluster_id=d.get('source_cluster_id', None))
+
+
 @dataclass
 class CloudProviderNodeInfo:
     status: Optional[List[CloudProviderNodeStatus]] = None
@@ -1420,6 +1437,10 @@ class ClusterSpec:
     """Attributes related to clusters running on Microsoft Azure. If not specified at cluster creation,
     a set of default values will be used."""
 
+    clone_from: Optional[CloneCluster] = None
+    """When specified, this clones libraries from a source cluster during the creation of a new
+    cluster."""
+
     cluster_log_conf: Optional[ClusterLogConf] = None
     """The configuration for delivering spark logs to a long-term storage destination. Two kinds of
     destinations (dbfs and s3) are supported. Only one destination can be specified for one cluster.
@@ -1554,6 +1575,7 @@ class ClusterSpec:
             body['autotermination_minutes'] = self.autotermination_minutes
         if self.aws_attributes: body['aws_attributes'] = self.aws_attributes.as_dict()
         if self.azure_attributes: body['azure_attributes'] = self.azure_attributes.as_dict()
+        if self.clone_from: body['clone_from'] = self.clone_from.as_dict()
         if self.cluster_log_conf: body['cluster_log_conf'] = self.cluster_log_conf.as_dict()
         if self.cluster_name is not None: body['cluster_name'] = self.cluster_name
         if self.cluster_source is not None: body['cluster_source'] = self.cluster_source.value
@@ -1589,6 +1611,7 @@ class ClusterSpec:
                    autotermination_minutes=d.get('autotermination_minutes', None),
                    aws_attributes=_from_dict(d, 'aws_attributes', AwsAttributes),
                    azure_attributes=_from_dict(d, 'azure_attributes', AzureAttributes),
+                   clone_from=_from_dict(d, 'clone_from', CloneCluster),
                    cluster_log_conf=_from_dict(d, 'cluster_log_conf', ClusterLogConf),
                    cluster_name=d.get('cluster_name', None),
                    cluster_source=_enum(d, 'cluster_source', ClusterSource),
@@ -1679,29 +1702,6 @@ class CommandStatusResponse:
                    status=_enum(d, 'status', CommandStatus))
 
 
-@dataclass
-class ComputeSpec:
-    kind: Optional[ComputeSpecKind] = None
-    """The kind of compute described by this compute specification."""
-
-    def as_dict(self) -> dict:
-        """Serializes the ComputeSpec into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        if self.kind is not None: body['kind'] = self.kind.value
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, any]) -> ComputeSpec:
-        """Deserializes the ComputeSpec from a dictionary."""
-        return cls(kind=_enum(d, 'kind', ComputeSpecKind))
-
-
-class ComputeSpecKind(Enum):
-    """The kind of compute described by this compute specification."""
-
-    SERVERLESS_PREVIEW = 'SERVERLESS_PREVIEW'
-
-
 class ContextStatus(Enum):
 
     ERROR = 'Error'
@@ -1754,6 +1754,10 @@ class CreateCluster:
     """Attributes related to clusters running on Microsoft Azure. If not specified at cluster creation,
     a set of default values will be used."""
 
+    clone_from: Optional[CloneCluster] = None
+    """When specified, this clones libraries from a source cluster during the creation of a new
+    cluster."""
+
     cluster_log_conf: Optional[ClusterLogConf] = None
     """The configuration for delivering spark logs to a long-term storage destination. Two kinds of
     destinations (dbfs and s3) are supported. Only one destination can be specified for one cluster.
@@ -1884,6 +1888,7 @@ class CreateCluster:
             body['autotermination_minutes'] = self.autotermination_minutes
         if self.aws_attributes: body['aws_attributes'] = self.aws_attributes.as_dict()
         if self.azure_attributes: body['azure_attributes'] = self.azure_attributes.as_dict()
+        if self.clone_from: body['clone_from'] = self.clone_from.as_dict()
         if self.cluster_log_conf: body['cluster_log_conf'] = self.cluster_log_conf.as_dict()
         if self.cluster_name is not None: body['cluster_name'] = self.cluster_name
         if self.cluster_source is not None: body['cluster_source'] = self.cluster_source.value
@@ -1919,6 +1924,7 @@ class CreateCluster:
                    autotermination_minutes=d.get('autotermination_minutes', None),
                    aws_attributes=_from_dict(d, 'aws_attributes', AwsAttributes),
                    azure_attributes=_from_dict(d, 'azure_attributes', AzureAttributes),
+                   clone_from=_from_dict(d, 'clone_from', CloneCluster),
                    cluster_log_conf=_from_dict(d, 'cluster_log_conf', ClusterLogConf),
                    cluster_name=d.get('cluster_name', None),
                    cluster_source=_enum(d, 'cluster_source', ClusterSource),
@@ -2592,6 +2598,10 @@ class EditCluster:
     """Attributes related to clusters running on Microsoft Azure. If not specified at cluster creation,
     a set of default values will be used."""
 
+    clone_from: Optional[CloneCluster] = None
+    """When specified, this clones libraries from a source cluster during the creation of a new
+    cluster."""
+
     cluster_log_conf: Optional[ClusterLogConf] = None
     """The configuration for delivering spark logs to a long-term storage destination. Two kinds of
     destinations (dbfs and s3) are supported. Only one destination can be specified for one cluster.
@@ -2722,6 +2732,7 @@ class EditCluster:
             body['autotermination_minutes'] = self.autotermination_minutes
         if self.aws_attributes: body['aws_attributes'] = self.aws_attributes.as_dict()
         if self.azure_attributes: body['azure_attributes'] = self.azure_attributes.as_dict()
+        if self.clone_from: body['clone_from'] = self.clone_from.as_dict()
         if self.cluster_id is not None: body['cluster_id'] = self.cluster_id
         if self.cluster_log_conf: body['cluster_log_conf'] = self.cluster_log_conf.as_dict()
         if self.cluster_name is not None: body['cluster_name'] = self.cluster_name
@@ -2758,6 +2769,7 @@ class EditCluster:
                    autotermination_minutes=d.get('autotermination_minutes', None),
                    aws_attributes=_from_dict(d, 'aws_attributes', AwsAttributes),
                    azure_attributes=_from_dict(d, 'azure_attributes', AzureAttributes),
+                   clone_from=_from_dict(d, 'clone_from', CloneCluster),
                    cluster_id=d.get('cluster_id', None),
                    cluster_log_conf=_from_dict(d, 'cluster_log_conf', ClusterLogConf),
                    cluster_name=d.get('cluster_name', None),
@@ -2969,6 +2981,37 @@ class EditResponse:
         return cls()
 
 
+@dataclass
+class Environment:
+    """The a environment entity used to preserve serverless environment side panel and jobs'
+    environment for non-notebook task. In this minimal environment spec, only pip dependencies are
+    supported. Next ID: 5"""
+
+    client: str
+    """* User-friendly name for the client version: “client”: “1” The version is a string,
+    consisting of the major client version"""
+
+    dependencies: Optional[List[str]] = None
+    """List of pip dependencies, as supported by the version of pip in this environment. Each
+    dependency is a pip requirement file line
+    https://pip.pypa.io/en/stable/reference/requirements-file-format/ Allowed dependency could be
+    <requirement specifier>, <archive url/path>, <local project path>(WSFS or Volumes in
+    Databricks), <vcs project url> E.g. dependencies: ["foo==0.0.1", "-r
+    /Workspace/test/requirements.txt"]"""
+
+    def as_dict(self) -> dict:
+        """Serializes the Environment into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        if self.client is not None: body['client'] = self.client
+        if self.dependencies: body['dependencies'] = [v for v in self.dependencies]
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> Environment:
+        """Deserializes the Environment from a dictionary."""
+        return cls(client=d.get('client', None), dependencies=d.get('dependencies', None))
+
+
 @dataclass
 class EventDetails:
     attributes: Optional[ClusterAttributes] = None
@@ -6208,6 +6251,7 @@ class ClustersAPI:
                autotermination_minutes: Optional[int] = None,
                aws_attributes: Optional[AwsAttributes] = None,
                azure_attributes: Optional[AzureAttributes] = None,
+               clone_from: Optional[CloneCluster] = None,
                cluster_log_conf: Optional[ClusterLogConf] = None,
                cluster_name: Optional[str] = None,
                cluster_source: Optional[ClusterSource] = None,
@@ -6256,6 +6300,8 @@ class ClustersAPI:
         :param azure_attributes: :class:`AzureAttributes` (optional)
           Attributes related to clusters running on Microsoft Azure. If not specified at cluster creation, a
           set of default values will be used.
+        :param clone_from: :class:`CloneCluster` (optional)
+          When specified, this clones libraries from a source cluster during the creation of a new cluster.
         :param cluster_log_conf: :class:`ClusterLogConf` (optional)
           The configuration for delivering spark logs to a long-term storage destination. Two kinds of
           destinations (dbfs and s3) are supported. Only one destination can be specified for one cluster. If
@@ -6364,6 +6410,7 @@ class ClustersAPI:
         if autotermination_minutes is not None: body['autotermination_minutes'] = autotermination_minutes
         if aws_attributes is not None: body['aws_attributes'] = aws_attributes.as_dict()
         if azure_attributes is not None: body['azure_attributes'] = azure_attributes.as_dict()
+        if clone_from is not None: body['clone_from'] = clone_from.as_dict()
         if cluster_log_conf is not None: body['cluster_log_conf'] = cluster_log_conf.as_dict()
         if cluster_name is not None: body['cluster_name'] = cluster_name
         if cluster_source is not None: body['cluster_source'] = cluster_source.value
@@ -6404,6 +6451,7 @@ class ClustersAPI:
         autotermination_minutes: Optional[int] = None,
         aws_attributes: Optional[AwsAttributes] = None,
         azure_attributes: Optional[AzureAttributes] = None,
+        clone_from: Optional[CloneCluster] = None,
         cluster_log_conf: Optional[ClusterLogConf] = None,
         cluster_name: Optional[str] = None,
         cluster_source: Optional[ClusterSource] = None,
@@ -6432,6 +6480,7 @@ class ClustersAPI:
                            autotermination_minutes=autotermination_minutes,
                            aws_attributes=aws_attributes,
                            azure_attributes=azure_attributes,
+                           clone_from=clone_from,
                            cluster_log_conf=cluster_log_conf,
                            cluster_name=cluster_name,
                            cluster_source=cluster_source,
@@ -6491,6 +6540,7 @@ class ClustersAPI:
              autotermination_minutes: Optional[int] = None,
              aws_attributes: Optional[AwsAttributes] = None,
              azure_attributes: Optional[AzureAttributes] = None,
+             clone_from: Optional[CloneCluster] = None,
              cluster_log_conf: Optional[ClusterLogConf] = None,
              cluster_name: Optional[str] = None,
              cluster_source: Optional[ClusterSource] = None,
@@ -6546,6 +6596,8 @@ class ClustersAPI:
         :param azure_attributes: :class:`AzureAttributes` (optional)
           Attributes related to clusters running on Microsoft Azure. If not specified at cluster creation, a
           set of default values will be used.
+        :param clone_from: :class:`CloneCluster` (optional)
+          When specified, this clones libraries from a source cluster during the creation of a new cluster.
         :param cluster_log_conf: :class:`ClusterLogConf` (optional)
           The configuration for delivering spark logs to a long-term storage destination. Two kinds of
           destinations (dbfs and s3) are supported. Only one destination can be specified for one cluster. If
@@ -6654,6 +6706,7 @@ class ClustersAPI:
         if autotermination_minutes is not None: body['autotermination_minutes'] = autotermination_minutes
         if aws_attributes is not None: body['aws_attributes'] = aws_attributes.as_dict()
         if azure_attributes is not None: body['azure_attributes'] = azure_attributes.as_dict()
+        if clone_from is not None: body['clone_from'] = clone_from.as_dict()
         if cluster_id is not None: body['cluster_id'] = cluster_id
         if cluster_log_conf is not None: body['cluster_log_conf'] = cluster_log_conf.as_dict()
         if cluster_name is not None: body['cluster_name'] = cluster_name
@@ -6696,6 +6749,7 @@ class ClustersAPI:
         autotermination_minutes: Optional[int] = None,
         aws_attributes: Optional[AwsAttributes] = None,
         azure_attributes: Optional[AzureAttributes] = None,
+        clone_from: Optional[CloneCluster] = None,
         cluster_log_conf: Optional[ClusterLogConf] = None,
         cluster_name: Optional[str] = None,
         cluster_source: Optional[ClusterSource] = None,
@@ -6724,6 +6778,7 @@ class ClustersAPI:
                          autotermination_minutes=autotermination_minutes,
                          aws_attributes=aws_attributes,
                          azure_attributes=azure_attributes,
+                         clone_from=clone_from,
                          cluster_id=cluster_id,
                          cluster_log_conf=cluster_log_conf,
                          cluster_name=cluster_name,

databricks/sdk/service/dashboards.py

@@ -117,6 +117,33 @@ class LifecycleState(Enum):
     TRASHED = 'TRASHED'
 
 
+@dataclass
+class MigrateDashboardRequest:
+    source_dashboard_id: str
+    """UUID of the dashboard to be migrated."""
+
+    display_name: Optional[str] = None
+    """Display name for the new Lakeview dashboard."""
+
+    parent_path: Optional[str] = None
+    """The workspace path of the folder to contain the migrated Lakeview dashboard."""
+
+    def as_dict(self) -> dict:
+        """Serializes the MigrateDashboardRequest into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        if self.display_name is not None: body['display_name'] = self.display_name
+        if self.parent_path is not None: body['parent_path'] = self.parent_path
+        if self.source_dashboard_id is not None: body['source_dashboard_id'] = self.source_dashboard_id
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> MigrateDashboardRequest:
+        """Deserializes the MigrateDashboardRequest from a dictionary."""
+        return cls(display_name=d.get('display_name', None),
+                   parent_path=d.get('parent_path', None),
+                   source_dashboard_id=d.get('source_dashboard_id', None))
+
+
 @dataclass
 class PublishRequest:
     dashboard_id: Optional[str] = None
@@ -191,6 +218,20 @@ class TrashDashboardResponse:
         return cls()
 
 
+@dataclass
+class UnpublishDashboardResponse:
+
+    def as_dict(self) -> dict:
+        """Serializes the UnpublishDashboardResponse into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> UnpublishDashboardResponse:
+        """Deserializes the UnpublishDashboardResponse from a dictionary."""
+        return cls()
+
+
 @dataclass
 class UpdateDashboardRequest:
     dashboard_id: Optional[str] = None
@@ -300,6 +341,33 @@ class LakeviewAPI:
         res = self._api.do('GET', f'/api/2.0/lakeview/dashboards/{dashboard_id}/published', headers=headers)
         return PublishedDashboard.from_dict(res)
 
+    def migrate(self,
+                source_dashboard_id: str,
+                *,
+                display_name: Optional[str] = None,
+                parent_path: Optional[str] = None) -> Dashboard:
+        """Migrate dashboard.
+        
+        Migrates a classic SQL dashboard to Lakeview.
+        
+        :param source_dashboard_id: str
+          UUID of the dashboard to be migrated.
+        :param display_name: str (optional)
+          Display name for the new Lakeview dashboard.
+        :param parent_path: str (optional)
+          The workspace path of the folder to contain the migrated Lakeview dashboard.
+        
+        :returns: :class:`Dashboard`
+        """
+        body = {}
+        if display_name is not None: body['display_name'] = display_name
+        if parent_path is not None: body['parent_path'] = parent_path
+        if source_dashboard_id is not None: body['source_dashboard_id'] = source_dashboard_id
+        headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
+
+        res = self._api.do('POST', '/api/2.0/lakeview/dashboards/migrate', body=body, headers=headers)
+        return Dashboard.from_dict(res)
+
     def publish(self,
                 dashboard_id: str,
                 *,
@@ -345,6 +413,21 @@ class LakeviewAPI:
 
         self._api.do('DELETE', f'/api/2.0/lakeview/dashboards/{dashboard_id}', headers=headers)
 
+    def unpublish(self, dashboard_id: str):
+        """Unpublish dashboard.
+        
+        Unpublish the dashboard.
+        
+        :param dashboard_id: str
+          UUID identifying the dashboard to be published.
+        
+        
+        """
+
+        headers = {'Accept': 'application/json', }
+
+        self._api.do('DELETE', f'/api/2.0/lakeview/dashboards/{dashboard_id}/published', headers=headers)
+
     def update(self,
                dashboard_id: str,
                *,

databricks/sdk/service/files.py

@@ -6,7 +6,7 @@ import logging
 from dataclasses import dataclass
 from typing import BinaryIO, Dict, Iterator, List, Optional
 
-from ._internal import _repeated_dict
+from ._internal import _escape_multi_segment_path_parameter, _repeated_dict
 
 _LOG = logging.getLogger('databricks.sdk')
 
@@ -789,7 +789,9 @@ class FilesAPI:
 
         headers = {}
 
-        self._api.do('PUT', f'/api/2.0/fs/directories{directory_path}', headers=headers)
+        self._api.do('PUT',
+                     f'/api/2.0/fs/directories{_escape_multi_segment_path_parameter(directory_path)}',
+                     headers=headers)
 
     def delete(self, file_path: str):
         """Delete a file.
@@ -804,7 +806,9 @@ class FilesAPI:
 
         headers = {}
 
-        self._api.do('DELETE', f'/api/2.0/fs/files{file_path}', headers=headers)
+        self._api.do('DELETE',
+                     f'/api/2.0/fs/files{_escape_multi_segment_path_parameter(file_path)}',
+                     headers=headers)
 
     def delete_directory(self, directory_path: str):
         """Delete a directory.
@@ -822,7 +826,9 @@ class FilesAPI:
 
         headers = {}
 
-        self._api.do('DELETE', f'/api/2.0/fs/directories{directory_path}', headers=headers)
+        self._api.do('DELETE',
+                     f'/api/2.0/fs/directories{_escape_multi_segment_path_parameter(directory_path)}',
+                     headers=headers)
 
     def download(self, file_path: str) -> DownloadResponse:
         """Download a file.
@@ -839,7 +845,7 @@ class FilesAPI:
         headers = {'Accept': 'application/octet-stream', }
         response_headers = ['content-length', 'content-type', 'last-modified', ]
         res = self._api.do('GET',
-                           f'/api/2.0/fs/files{file_path}',
+                           f'/api/2.0/fs/files{_escape_multi_segment_path_parameter(file_path)}',
                            headers=headers,
                            response_headers=response_headers,
                            raw=True)
@@ -864,7 +870,9 @@ class FilesAPI:
 
         headers = {}
 
-        self._api.do('HEAD', f'/api/2.0/fs/directories{directory_path}', headers=headers)
+        self._api.do('HEAD',
+                     f'/api/2.0/fs/directories{_escape_multi_segment_path_parameter(directory_path)}',
+                     headers=headers)
 
     def get_metadata(self, file_path: str) -> GetMetadataResponse:
         """Get file metadata.
@@ -880,7 +888,7 @@ class FilesAPI:
         headers = {}
         response_headers = ['content-length', 'content-type', 'last-modified', ]
         res = self._api.do('HEAD',
-                           f'/api/2.0/fs/files{file_path}',
+                           f'/api/2.0/fs/files{_escape_multi_segment_path_parameter(file_path)}',
                            headers=headers,
                            response_headers=response_headers)
         return GetMetadataResponse.from_dict(res)
@@ -924,10 +932,11 @@ class FilesAPI:
         headers = {'Accept': 'application/json', }
 
         while True:
-            json = self._api.do('GET',
-                                f'/api/2.0/fs/directories{directory_path}',
-                                query=query,
-                                headers=headers)
+            json = self._api.do(
+                'GET',
+                f'/api/2.0/fs/directories{_escape_multi_segment_path_parameter(directory_path)}',
+                query=query,
+                headers=headers)
             if 'contents' in json:
                 for v in json['contents']:
                     yield DirectoryEntry.from_dict(v)
@@ -956,4 +965,8 @@ class FilesAPI:
         if overwrite is not None: query['overwrite'] = overwrite
         headers = {'Content-Type': 'application/octet-stream', }
 
-        self._api.do('PUT', f'/api/2.0/fs/files{file_path}', query=query, headers=headers, data=contents)
+        self._api.do('PUT',
+                     f'/api/2.0/fs/files{_escape_multi_segment_path_parameter(file_path)}',
+                     query=query,
+                     headers=headers,
+                     data=contents)

databricks/sdk/service/iam.py

@@ -890,7 +890,7 @@ class PermissionsRequest:
     request_object_type: Optional[str] = None
     """The type of the request object. Can be one of the following: authorization, clusters,
     cluster-policies, directories, experiments, files, instance-pools, jobs, notebooks, pipelines,
-    registered-models, repos, serving-endpoints, or sql-warehouses."""
+    registered-models, repos, serving-endpoints, or warehouses."""
 
     def as_dict(self) -> dict:
         """Serializes the PermissionsRequest into a dictionary suitable for use as a JSON request body."""
@@ -915,7 +915,7 @@ class PrincipalOutput:
     """The display name of the principal."""
 
     group_name: Optional[str] = None
-    """The group name of the groupl. Present only if the principal is a group."""
+    """The group name of the group. Present only if the principal is a group."""
 
     principal_id: Optional[int] = None
     """The unique, opaque id of the principal."""
@@ -1135,7 +1135,9 @@ class UpdateRuleSetRequest:
 @dataclass
 class UpdateWorkspaceAssignments:
     permissions: List[WorkspacePermission]
-    """Array of permissions assignments to update on the workspace."""
+    """Array of permissions assignments to update on the workspace. Note that excluding this field will
+    have the same effect as providing an empty list which will result in the deletion of all
+    permissions for the principal."""
 
     principal_id: Optional[int] = None
     """The ID of the user, service principal, or group."""
@@ -1238,20 +1240,6 @@ class UserSchema(Enum):
     URN_IETF_PARAMS_SCIM_SCHEMAS_EXTENSION_WORKSPACE_2_0_USER = 'urn:ietf:params:scim:schemas:extension:workspace:2.0:User'
 
 
-@dataclass
-class WorkspaceAssignmentsUpdated:
-
-    def as_dict(self) -> dict:
-        """Serializes the WorkspaceAssignmentsUpdated into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, any]) -> WorkspaceAssignmentsUpdated:
-        """Deserializes the WorkspaceAssignmentsUpdated from a dictionary."""
-        return cls()
-
-
 class WorkspacePermission(Enum):
 
     ADMIN = 'ADMIN'
@@ -2590,6 +2578,9 @@ class PermissionsAPI:
     For the mapping of the required permissions for specific actions or abilities and other important
     information, see [Access Control].
     
+    Note that to manage access control on service principals, use **[Account Access Control
+    Proxy](:service:accountaccesscontrolproxy)**.
+    
     [Access Control]: https://docs.databricks.com/security/auth-authz/access-control/index.html"""
 
     def __init__(self, api_client):
@@ -2604,7 +2595,7 @@ class PermissionsAPI:
         :param request_object_type: str
           The type of the request object. Can be one of the following: authorization, clusters,
           cluster-policies, directories, experiments, files, instance-pools, jobs, notebooks, pipelines,
-          registered-models, repos, serving-endpoints, or sql-warehouses.
+          registered-models, repos, serving-endpoints, or warehouses.
         :param request_object_id: str
           The id of the request object.
         
@@ -2652,7 +2643,7 @@ class PermissionsAPI:
         :param request_object_type: str
           The type of the request object. Can be one of the following: authorization, clusters,
           cluster-policies, directories, experiments, files, instance-pools, jobs, notebooks, pipelines,
-          registered-models, repos, serving-endpoints, or sql-warehouses.
+          registered-models, repos, serving-endpoints, or warehouses.
         :param request_object_id: str
           The id of the request object.
         :param access_control_list: List[:class:`AccessControlRequest`] (optional)
@@ -2683,7 +2674,7 @@ class PermissionsAPI:
         :param request_object_type: str
           The type of the request object. Can be one of the following: authorization, clusters,
           cluster-policies, directories, experiments, files, instance-pools, jobs, notebooks, pipelines,
-          registered-models, repos, serving-endpoints, or sql-warehouses.
+          registered-models, repos, serving-endpoints, or warehouses.
         :param request_object_id: str
           The id of the request object.
         :param access_control_list: List[:class:`AccessControlRequest`] (optional)
@@ -3375,7 +3366,8 @@ class WorkspaceAssignmentAPI:
         parsed = PermissionAssignments.from_dict(json).permission_assignments
         return parsed if parsed is not None else []
 
-    def update(self, workspace_id: int, principal_id: int, permissions: List[WorkspacePermission]):
+    def update(self, workspace_id: int, principal_id: int,
+               permissions: List[WorkspacePermission]) -> PermissionAssignment:
         """Create or update permissions assignment.
         
         Creates or updates the workspace permissions assignment in a given account and workspace for the
@@ -3386,16 +3378,19 @@ class WorkspaceAssignmentAPI:
         :param principal_id: int
           The ID of the user, service principal, or group.
         :param permissions: List[:class:`WorkspacePermission`]
-          Array of permissions assignments to update on the workspace.
-        
+          Array of permissions assignments to update on the workspace. Note that excluding this field will
+          have the same effect as providing an empty list which will result in the deletion of all permissions
+          for the principal.
         
+        :returns: :class:`PermissionAssignment`
         """
         body = {}
         if permissions is not None: body['permissions'] = [v.value for v in permissions]
         headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
 
-        self._api.do(
+        res = self._api.do(
             'PUT',
             f'/api/2.0/accounts/{self._api.account_id}/workspaces/{workspace_id}/permissionassignments/principals/{principal_id}',
             body=body,
             headers=headers)
+        return PermissionAssignment.from_dict(res)