databricks-sdk 0.20.0__py3-none-any.whl → 0.21.0__py3-none-any.whl

databricks/sdk/service/files.py

@@ -34,6 +34,20 @@ class AddBlock:
         return cls(data=d.get('data', None), handle=d.get('handle', None))
 
 
+@dataclass
+class AddBlockResponse:
+
+    def as_dict(self) -> dict:
+        """Serializes the AddBlockResponse into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> AddBlockResponse:
+        """Deserializes the AddBlockResponse from a dictionary."""
+        return cls()
+
+
 @dataclass
 class Close:
     handle: int
@@ -51,6 +65,20 @@ class Close:
         return cls(handle=d.get('handle', None))
 
 
+@dataclass
+class CloseResponse:
+
+    def as_dict(self) -> dict:
+        """Serializes the CloseResponse into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> CloseResponse:
+        """Deserializes the CloseResponse from a dictionary."""
+        return cls()
+
+
 @dataclass
 class Create:
     path: str
@@ -72,6 +100,20 @@ class Create:
         return cls(overwrite=d.get('overwrite', None), path=d.get('path', None))
 
 
+@dataclass
+class CreateDirectoryResponse:
+
+    def as_dict(self) -> dict:
+        """Serializes the CreateDirectoryResponse into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> CreateDirectoryResponse:
+        """Deserializes the CreateDirectoryResponse from a dictionary."""
+        return cls()
+
+
 @dataclass
 class CreateResponse:
     handle: Optional[int] = None
@@ -112,6 +154,34 @@ class Delete:
         return cls(path=d.get('path', None), recursive=d.get('recursive', None))
 
 
+@dataclass
+class DeleteDirectoryResponse:
+
+    def as_dict(self) -> dict:
+        """Serializes the DeleteDirectoryResponse into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> DeleteDirectoryResponse:
+        """Deserializes the DeleteDirectoryResponse from a dictionary."""
+        return cls()
+
+
+@dataclass
+class DeleteResponse:
+
+    def as_dict(self) -> dict:
+        """Serializes the DeleteResponse into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> DeleteResponse:
+        """Deserializes the DeleteResponse from a dictionary."""
+        return cls()
+
+
 @dataclass
 class DirectoryEntry:
     file_size: Optional[int] = None
@@ -171,7 +241,7 @@ class DownloadResponse:
     @classmethod
     def from_dict(cls, d: Dict[str, any]) -> DownloadResponse:
         """Deserializes the DownloadResponse from a dictionary."""
-        return cls(content_length=d.get('content-length', None),
+        return cls(content_length=int(d.get('content-length', None)),
                    content_type=d.get('content-type', None),
                    contents=d.get('contents', None),
                    last_modified=d.get('last-modified', None))
@@ -209,6 +279,20 @@ class FileInfo:
                    path=d.get('path', None))
 
 
+@dataclass
+class GetDirectoryMetadataResponse:
+
+    def as_dict(self) -> dict:
+        """Serializes the GetDirectoryMetadataResponse into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> GetDirectoryMetadataResponse:
+        """Deserializes the GetDirectoryMetadataResponse from a dictionary."""
+        return cls()
+
+
 @dataclass
 class GetMetadataResponse:
     content_length: Optional[int] = None
@@ -228,7 +312,7 @@ class GetMetadataResponse:
     @classmethod
     def from_dict(cls, d: Dict[str, any]) -> GetMetadataResponse:
         """Deserializes the GetMetadataResponse from a dictionary."""
-        return cls(content_length=d.get('content-length', None),
+        return cls(content_length=int(d.get('content-length', None)),
                    content_type=d.get('content-type', None),
                    last_modified=d.get('last-modified', None))
 
@@ -289,6 +373,20 @@ class MkDirs:
         return cls(path=d.get('path', None))
 
 
+@dataclass
+class MkDirsResponse:
+
+    def as_dict(self) -> dict:
+        """Serializes the MkDirsResponse into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> MkDirsResponse:
+        """Deserializes the MkDirsResponse from a dictionary."""
+        return cls()
+
+
 @dataclass
 class Move:
     source_path: str
@@ -310,6 +408,20 @@ class Move:
         return cls(destination_path=d.get('destination_path', None), source_path=d.get('source_path', None))
 
 
+@dataclass
+class MoveResponse:
+
+    def as_dict(self) -> dict:
+        """Serializes the MoveResponse into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> MoveResponse:
+        """Deserializes the MoveResponse from a dictionary."""
+        return cls()
+
+
 @dataclass
 class Put:
     path: str
@@ -337,6 +449,20 @@ class Put:
                    path=d.get('path', None))
 
 
+@dataclass
+class PutResponse:
+
+    def as_dict(self) -> dict:
+        """Serializes the PutResponse into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> PutResponse:
+        """Deserializes the PutResponse from a dictionary."""
+        return cls()
+
+
 @dataclass
 class ReadResponse:
     bytes_read: Optional[int] = None
@@ -359,6 +485,20 @@ class ReadResponse:
         return cls(bytes_read=d.get('bytes_read', None), data=d.get('data', None))
 
 
+@dataclass
+class UploadResponse:
+
+    def as_dict(self) -> dict:
+        """Serializes the UploadResponse into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> UploadResponse:
+        """Deserializes the UploadResponse from a dictionary."""
+        return cls()
+
+
 class DbfsAPI:
     """DBFS API makes it simple to interact with various data sources without having to include a users
     credentials every time to read a file."""
@@ -616,18 +756,20 @@ class DbfsAPI:
 
 
 class FilesAPI:
-    """The Files API allows you to read, write, list, and delete files and directories. We support Unity Catalog
-    volumes with paths starting with "/Volumes/<catalog>/<schema>/<volume>".
+    """The Files API is a standard HTTP API that allows you to read, write, list, and delete files and
+    directories by referring to their URI. The API makes working with file content as raw bytes easier and
+    more efficient.
     
-    The Files API is designed like a standard HTTP API, rather than as a JSON RPC API. This is intended to
-    make it easier and more efficient to work with file contents as raw bytes.
+    The API supports [Unity Catalog volumes], where files and directories to operate on are specified using
+    their volume URI path, which follows the format
+    /Volumes/&lt;catalog_name&gt;/&lt;schema_name&gt;/&lt;volume_name&gt;/&lt;path_to_file&gt;.
     
-    Because the Files API is a standard HTTP API, the URI path is used to specify the file or directory to
-    operate on. The path is always absolute.
+    The Files API has two distinct endpoints, one for working with files (`/fs/files`) and another one for
+    working with directories (`/fs/directories`). Both endpoints, use the standard HTTP methods GET, HEAD,
+    PUT, and DELETE to manage files and directories specified using their URI path. The path is always
+    absolute.
     
-    The Files API has separate endpoints for working with files, `/fs/files`, and working with directories,
-    `/fs/directories`. The standard HTTP methods `GET`, `HEAD`, `PUT`, and `DELETE` work as expected on these
-    endpoints."""
+    [Unity Catalog volumes]: https://docs.databricks.com/en/connect/unity-catalog/volumes.html"""
 
     def __init__(self, api_client):
         self._api = api_client
@@ -637,7 +779,7 @@ class FilesAPI:
         
         Creates an empty directory. If necessary, also creates any parent directories of the new, empty
         directory (like the shell command `mkdir -p`). If called on an existing directory, returns a success
-        response; this method is idempotent.
+        response; this method is idempotent (it will succeed if the directory already exists).
         
         :param directory_path: str
           The absolute path of a directory.

databricks/sdk/service/iam.py

@@ -117,6 +117,34 @@ class ComplexValue:
                    value=d.get('value', None))
 
 
+@dataclass
+class DeleteResponse:
+
+    def as_dict(self) -> dict:
+        """Serializes the DeleteResponse into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> DeleteResponse:
+        """Deserializes the DeleteResponse from a dictionary."""
+        return cls()
+
+
+@dataclass
+class DeleteWorkspaceAssignments:
+
+    def as_dict(self) -> dict:
+        """Serializes the DeleteWorkspaceAssignments into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> DeleteWorkspaceAssignments:
+        """Deserializes the DeleteWorkspaceAssignments from a dictionary."""
+        return cls()
+
+
 @dataclass
 class GetAssignableRolesForResourceResponse:
     roles: Optional[List[Role]] = None
@@ -649,6 +677,20 @@ class PatchOp(Enum):
     REPLACE = 'replace'
 
 
+@dataclass
+class PatchResponse:
+
+    def as_dict(self) -> dict:
+        """Serializes the PatchResponse into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> PatchResponse:
+        """Deserializes the PatchResponse from a dictionary."""
+        return cls()
+
+
 class PatchSchema(Enum):
 
     URN_IETF_PARAMS_SCIM_API_MESSAGES_2_0_PATCH_OP = 'urn:ietf:params:scim:api:messages:2.0:PatchOp'
@@ -744,6 +786,57 @@ class PermissionLevel(Enum):
     IS_OWNER = 'IS_OWNER'
 
 
+@dataclass
+class PermissionMigrationRequest:
+    workspace_id: int
+    """WorkspaceId of the associated workspace where the permission migration will occur. Both
+    workspace group and account group must be in this workspace."""
+
+    from_workspace_group_name: str
+    """The name of the workspace group that permissions will be migrated from."""
+
+    to_account_group_name: str
+    """The name of the account group that permissions will be migrated to."""
+
+    size: Optional[int] = None
+    """The maximum number of permissions that will be migrated."""
+
+    def as_dict(self) -> dict:
+        """Serializes the PermissionMigrationRequest into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        if self.from_workspace_group_name is not None:
+            body['from_workspace_group_name'] = self.from_workspace_group_name
+        if self.size is not None: body['size'] = self.size
+        if self.to_account_group_name is not None: body['to_account_group_name'] = self.to_account_group_name
+        if self.workspace_id is not None: body['workspace_id'] = self.workspace_id
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> PermissionMigrationRequest:
+        """Deserializes the PermissionMigrationRequest from a dictionary."""
+        return cls(from_workspace_group_name=d.get('from_workspace_group_name', None),
+                   size=d.get('size', None),
+                   to_account_group_name=d.get('to_account_group_name', None),
+                   workspace_id=d.get('workspace_id', None))
+
+
+@dataclass
+class PermissionMigrationResponse:
+    permissions_migrated: Optional[int] = None
+    """Number of permissions migrated."""
+
+    def as_dict(self) -> dict:
+        """Serializes the PermissionMigrationResponse into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        if self.permissions_migrated is not None: body['permissions_migrated'] = self.permissions_migrated
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> PermissionMigrationResponse:
+        """Deserializes the PermissionMigrationResponse from a dictionary."""
+        return cls(permissions_migrated=d.get('permissions_migrated', None))
+
+
 @dataclass
 class PermissionOutput:
     description: Optional[str] = None
@@ -1004,6 +1097,20 @@ class ServicePrincipalSchema(Enum):
     URN_IETF_PARAMS_SCIM_SCHEMAS_CORE_2_0_SERVICE_PRINCIPAL = 'urn:ietf:params:scim:schemas:core:2.0:ServicePrincipal'
 
 
+@dataclass
+class UpdateResponse:
+
+    def as_dict(self) -> dict:
+        """Serializes the UpdateResponse into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> UpdateResponse:
+        """Deserializes the UpdateResponse from a dictionary."""
+        return cls()
+
+
 @dataclass
 class UpdateRuleSetRequest:
     name: str
@@ -1130,6 +1237,20 @@ 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'
@@ -2384,6 +2505,46 @@ class GroupsAPI:
         self._api.do('PUT', f'/api/2.0/preview/scim/v2/Groups/{id}', body=body, headers=headers)
 
 
+class PermissionMigrationAPI:
+    """This spec contains undocumented permission migration APIs used in https://github.com/databrickslabs/ucx."""
+
+    def __init__(self, api_client):
+        self._api = api_client
+
+    def migrate_permissions(self,
+                            workspace_id: int,
+                            from_workspace_group_name: str,
+                            to_account_group_name: str,
+                            *,
+                            size: Optional[int] = None) -> PermissionMigrationResponse:
+        """Migrate Permissions.
+        
+        Migrate a batch of permissions from a workspace local group to an account group.
+        
+        :param workspace_id: int
+          WorkspaceId of the associated workspace where the permission migration will occur. Both workspace
+          group and account group must be in this workspace.
+        :param from_workspace_group_name: str
+          The name of the workspace group that permissions will be migrated from.
+        :param to_account_group_name: str
+          The name of the account group that permissions will be migrated to.
+        :param size: int (optional)
+          The maximum number of permissions that will be migrated.
+        
+        :returns: :class:`PermissionMigrationResponse`
+        """
+        body = {}
+        if from_workspace_group_name is not None:
+            body['from_workspace_group_name'] = from_workspace_group_name
+        if size is not None: body['size'] = size
+        if to_account_group_name is not None: body['to_account_group_name'] = to_account_group_name
+        if workspace_id is not None: body['workspace_id'] = workspace_id
+        headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
+
+        res = self._api.do('POST', '/api/2.0/permissionmigration', body=body, headers=headers)
+        return PermissionMigrationResponse.from_dict(res)
+
+
 class PermissionsAPI:
     """Permissions API are used to create read, write, edit, update and manage access for various users on
     different objects and endpoints.

databricks/sdk/service/jobs.py

@@ -261,6 +261,20 @@ class CancelAllRuns:
         return cls(all_queued_runs=d.get('all_queued_runs', None), job_id=d.get('job_id', None))
 
 
+@dataclass
+class CancelAllRunsResponse:
+
+    def as_dict(self) -> dict:
+        """Serializes the CancelAllRunsResponse into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> CancelAllRunsResponse:
+        """Deserializes the CancelAllRunsResponse from a dictionary."""
+        return cls()
+
+
 @dataclass
 class CancelRun:
     run_id: int
@@ -278,6 +292,20 @@ class CancelRun:
         return cls(run_id=d.get('run_id', None))
 
 
+@dataclass
+class CancelRunResponse:
+
+    def as_dict(self) -> dict:
+        """Serializes the CancelRunResponse into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> CancelRunResponse:
+        """Deserializes the CancelRunResponse from a dictionary."""
+        return cls()
+
+
 @dataclass
 class ClusterInstance:
     cluster_id: Optional[str] = None
@@ -744,6 +772,20 @@ class DeleteJob:
         return cls(job_id=d.get('job_id', None))
 
 
+@dataclass
+class DeleteResponse:
+
+    def as_dict(self) -> dict:
+        """Serializes the DeleteResponse into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> DeleteResponse:
+        """Deserializes the DeleteResponse from a dictionary."""
+        return cls()
+
+
 @dataclass
 class DeleteRun:
     run_id: int
@@ -761,6 +803,20 @@ class DeleteRun:
         return cls(run_id=d.get('run_id', None))
 
 
+@dataclass
+class DeleteRunResponse:
+
+    def as_dict(self) -> dict:
+        """Serializes the DeleteRunResponse into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> DeleteRunResponse:
+        """Deserializes the DeleteRunResponse from a dictionary."""
+        return cls()
+
+
 @dataclass
 class ExportRunOutput:
     views: Optional[List[ViewItem]] = None
@@ -1777,13 +1833,13 @@ class ListJobsResponse:
     """If true, additional jobs matching the provided filter are available for listing."""
 
     jobs: Optional[List[BaseJob]] = None
-    """The list of jobs."""
+    """The list of jobs. Only included in the response if there are jobs to list."""
 
     next_page_token: Optional[str] = None
-    """A token that can be used to list the next page of jobs."""
+    """A token that can be used to list the next page of jobs (if applicable)."""
 
     prev_page_token: Optional[str] = None
-    """A token that can be used to list the previous page of jobs."""
+    """A token that can be used to list the previous page of jobs (if applicable)."""
 
     def as_dict(self) -> dict:
         """Serializes the ListJobsResponse into a dictionary suitable for use as a JSON request body."""
@@ -1809,13 +1865,14 @@ class ListRunsResponse:
     """If true, additional runs matching the provided filter are available for listing."""
 
     next_page_token: Optional[str] = None
-    """A token that can be used to list the next page of runs."""
+    """A token that can be used to list the next page of runs (if applicable)."""
 
     prev_page_token: Optional[str] = None
-    """A token that can be used to list the previous page of runs."""
+    """A token that can be used to list the previous page of runs (if applicable)."""
 
     runs: Optional[List[BaseRun]] = None
-    """A list of runs, from most recently started to least."""
+    """A list of runs, from most recently started to least. Only included in the response if there are
+    runs to list."""
 
     def as_dict(self) -> dict:
         """Serializes the ListRunsResponse into a dictionary suitable for use as a JSON request body."""
@@ -2248,6 +2305,20 @@ class ResetJob:
         return cls(job_id=d.get('job_id', None), new_settings=_from_dict(d, 'new_settings', JobSettings))
 
 
+@dataclass
+class ResetResponse:
+
+    def as_dict(self) -> dict:
+        """Serializes the ResetResponse into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> ResetResponse:
+        """Deserializes the ResetResponse from a dictionary."""
+        return cls()
+
+
 @dataclass
 class ResolvedConditionTaskValues:
     left: Optional[str] = None
@@ -4576,6 +4647,20 @@ class UpdateJob:
                    new_settings=_from_dict(d, 'new_settings', JobSettings))
 
 
+@dataclass
+class UpdateResponse:
+
+    def as_dict(self) -> dict:
+        """Serializes the UpdateResponse into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> UpdateResponse:
+        """Deserializes the UpdateResponse from a dictionary."""
+        return cls()
+
+
 @dataclass
 class ViewItem:
     content: Optional[str] = None
@@ -4783,8 +4868,10 @@ class JobsAPI:
         if run_id is not None: body['run_id'] = run_id
         headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
 
-        self._api.do('POST', '/api/2.1/jobs/runs/cancel', body=body, headers=headers)
-        return Wait(self.wait_get_run_job_terminated_or_skipped, run_id=run_id)
+        op_response = self._api.do('POST', '/api/2.1/jobs/runs/cancel', body=body, headers=headers)
+        return Wait(self.wait_get_run_job_terminated_or_skipped,
+                    response=CancelRunResponse.from_dict(op_response),
+                    run_id=run_id)
 
     def cancel_run_and_wait(self, run_id: int, timeout=timedelta(minutes=20)) -> Run:
         return self.cancel_run(run_id=run_id).result(timeout=timeout)