com.databricks.sdk.service.files

Class FilesAPI

java.lang.Object

com.databricks.sdk.service.files.FilesAPI

@Generated
public class FilesAPI
extends Object

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 API supports [Unity Catalog volumes], where files and directories to operate on are specified using their volume URI path, which follows the format /Volumes/<catalog_name>/<schema_name>/<volume_name>/<path_to_file>.

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.

Some Files API client features are currently experimental. To enable them, set `enable_experimental_files_api_client = True` in your configuration profile or use the environment variable `DATABRICKS_ENABLE_EXPERIMENTAL_FILES_API_CLIENT=True`.

Use of Files API may incur Databricks data transfer charges.

[Unity Catalog volumes]: https://docs.databricks.com/en/connect/unity-catalog/volumes.html

Constructor Summary

Constructors

Constructor and Description
FilesAPI(ApiClient apiClient) Regular-use constructor
FilesAPI(FilesService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
void	createDirectory(CreateDirectoryRequest request) Creates an empty directory.
void	delete(DeleteFileRequest request) Deletes a file.
void	delete(String filePath)
void	deleteDirectory(DeleteDirectoryRequest request) Deletes an empty directory.
void	deleteDirectory(String directoryPath)
DownloadResponse	download(DownloadRequest request) Downloads a file.
DownloadResponse	download(String filePath)
void	getDirectoryMetadata(GetDirectoryMetadataRequest request) Get the metadata of a directory.
void	getDirectoryMetadata(String directoryPath)
GetMetadataResponse	getMetadata(GetMetadataRequest request) Get the metadata of a file.
GetMetadataResponse	getMetadata(String filePath)
FilesService	impl()
Iterable<DirectoryEntry>	listDirectoryContents(ListDirectoryContentsRequest request) Returns the contents of a directory.
Iterable<DirectoryEntry>	listDirectoryContents(String directoryPath)
void	upload(UploadRequest request) Uploads a file of up to 5 GiB.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FilesAPI

public FilesAPI(ApiClient apiClient)

Regular-use constructor

FilesAPI

public FilesAPI(FilesService mock)

Constructor for mocks

Method Detail

createDirectory

public void createDirectory(CreateDirectoryRequest request)

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 (it will succeed if the directory already exists).

delete

public void delete(String filePath)

delete

public void delete(DeleteFileRequest request)

Deletes a file. If the request is successful, there is no response body.

deleteDirectory

public void deleteDirectory(String directoryPath)

deleteDirectory

public void deleteDirectory(DeleteDirectoryRequest request)

Deletes an empty directory.

To delete a non-empty directory, first delete all of its contents. This can be done by listing the directory contents and deleting each file and subdirectory recursively.

download

public DownloadResponse download(String filePath)

download

public DownloadResponse download(DownloadRequest request)

Downloads a file. The file contents are the response body. This is a standard HTTP file download, not a JSON RPC. It supports the Range and If-Unmodified-Since HTTP headers.

getDirectoryMetadata

public void getDirectoryMetadata(String directoryPath)

getDirectoryMetadata

public void getDirectoryMetadata(GetDirectoryMetadataRequest request)

Get the metadata of a directory. The response HTTP headers contain the metadata. There is no response body.

This method is useful to check if a directory exists and the caller has access to it.

If you wish to ensure the directory exists, you can instead use `PUT`, which will create the directory if it does not exist, and is idempotent (it will succeed if the directory already exists).

getMetadata

public GetMetadataResponse getMetadata(String filePath)

getMetadata

public GetMetadataResponse getMetadata(GetMetadataRequest request)

Get the metadata of a file. The response HTTP headers contain the metadata. There is no response body.

listDirectoryContents

public Iterable<DirectoryEntry> listDirectoryContents(String directoryPath)

listDirectoryContents

public Iterable<DirectoryEntry> listDirectoryContents(ListDirectoryContentsRequest request)

Returns the contents of a directory. If there is no directory at the specified path, the API returns a HTTP 404 error.

upload

public void upload(UploadRequest request)

Uploads a file of up to 5 GiB. The file contents should be sent as the request body as raw bytes (an octet stream); do not encode or otherwise modify the bytes before sending. The contents of the resulting file will be exactly the bytes sent in the request body. If the request is successful, there is no response body.

impl

public FilesService impl()