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 allows you to read, write, and delete files and directories in Unity Catalog volumes.

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) Create a directory.
void	createDirectory(String directoryPath)
void	delete(DeleteFileRequest request) Delete a file.
void	delete(String filePath)
void	deleteDirectory(DeleteDirectoryRequest request) Delete a directory.
void	deleteDirectory(String directoryPath)
DownloadResponse	download(DownloadRequest request) Download a file.
DownloadResponse	download(String filePath)
FilesService	impl()
Iterable<DirectoryEntry>	listDirectoryContents(ListDirectoryContentsRequest request) List directory contents.
Iterable<DirectoryEntry>	listDirectoryContents(String directoryPath)
void	upload(String filePath, InputStream contents)
void	upload(UploadRequest request) Upload a file.

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(String directoryPath)

createDirectory

public void createDirectory(CreateDirectoryRequest request)

Create a directory.

Creates an empty directory. If called on an existing directory, the API returns a success response.

delete

public void delete(String filePath)

delete

public void delete(DeleteFileRequest request)

Delete a file.

Deletes a file.

deleteDirectory

public void deleteDirectory(String directoryPath)

deleteDirectory

public void deleteDirectory(DeleteDirectoryRequest request)

Delete a directory.

Deletes an empty directory. If the directory is not empty, the API returns a HTTP 400 error.

download

public DownloadResponse download(String filePath)

download

public DownloadResponse download(DownloadRequest request)

Download a file.

Downloads a file of up to 5 GiB.

listDirectoryContents

public Iterable<DirectoryEntry> listDirectoryContents(String directoryPath)

listDirectoryContents

public Iterable<DirectoryEntry> listDirectoryContents(ListDirectoryContentsRequest request)

List directory contents.

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(String filePath,
                   InputStream contents)

upload

public void upload(UploadRequest request)

Upload a file.

Uploads a file of up to 5 GiB.

impl

public FilesService impl()