Package io.supabase.api

Interface IStorageFileAPI

All Known Implementing Classes:

StorageFileAPI

public interface IStorageFileAPI

Method Summary

Modifier and Type	Method	Description
CompletableFuture<FilePathResponse>	copy(String fromPath, String toPath)	POST /object/copy/
CompletableFuture<List<File>>	delete(List<String> paths)	DELETE /object/{bucketName}
CompletableFuture<FileDownload>	download(String path, FileTransformOptions transformOptions)	Downloads a file from a private bucket.
FilePublicUrlResponse	getPublicUrl(String path, FileDownloadOption downloadOptions, FileTransformOptions transformOptions)	Creates the url for an object in a public bucket
CompletableFuture<FileSignedUrlResponse>	getSignedUrl(String path, int expiresIn, FileDownloadOption downloadOptions, FileTransformOptions transformOptions)	POST /object/sign/{bucketName}
CompletableFuture<List<FileSignedUrlResponse>>	getSignedUrls(List<String> paths, int expiresIn, FileDownloadOption downloadOptions, FileTransformOptions transformOptions)	POST /object/sign/{bucketName}
CompletableFuture<List<File>>	list(FileSearchOptions options)	POST /object/list/{bucketName}
CompletableFuture<List<File>>	list(String path, FileSearchOptions options)	POST /object/list/{bucketName}
CompletableFuture<MessageResponse>	move(String fromPath, String toPath)	POST /object/move/
CompletableFuture<FilePathResponse>	update(String path, File file)	PUT /object/{bucketName}/{wildcard}
CompletableFuture<FilePathResponse>	upload(String path, File file)	POST /object/{bucketName}/{wildcard}

Method Details

upload

CompletableFuture<FilePathResponse> upload(String path,
 File file)

POST /object/{bucketName}/{wildcard}

Parameters:

path - The path to the file within the bucket of where it should be uploaded.

file - The file that needs to be uploaded.

Returns:

a FilePathResponse

update

CompletableFuture<FilePathResponse> update(String path,
 File file)

PUT /object/{bucketName}/{wildcard}

Parameters:

path - The path to the file within the bucket that should get updated.

file - The new file that should be placed.

Returns:

a FilePathResponse

move

CompletableFuture<MessageResponse> move(String fromPath,
 String toPath)

POST /object/move/

Parameters:

fromPath - The path to the object that needs to be moved.

toPath - The new path where the object should be moved to.

Returns:

a MessageResponse

copy

CompletableFuture<FilePathResponse> copy(String fromPath,
 String toPath)

POST /object/copy/

Parameters:

fromPath - The path to the object that needs to be copied.

toPath - The new path where the object should be copied to.

Returns:

a FilePathResponse

getSignedUrl

CompletableFuture<FileSignedUrlResponse> getSignedUrl(String path,
 int expiresIn,
 FileDownloadOption downloadOptions,
 FileTransformOptions transformOptions)

POST /object/sign/{bucketName}

This method just wraps getSignedUrls(List, int, FileDownloadOption, FileTransformOptions)

Parameters:

path - The singular file path that should be signed.

expiresIn - how many seconds until the signed url expires.

downloadOptions - any additional download options.

transformOptions - The transform options if any

Returns:

a FileSignedUrlResponse

getSignedUrls

CompletableFuture<List<FileSignedUrlResponse>> getSignedUrls(List<String> paths,
 int expiresIn,
 FileDownloadOption downloadOptions,
 FileTransformOptions transformOptions)

POST /object/sign/{bucketName}

Parameters:

paths - a list of file paths that should be signed.

expiresIn - how many seconds until the signed urls expires.

downloadOptions - any additional download options.

transformOptions - The transform options if any

Returns:

a list of FileSignedUrlResponse

download

CompletableFuture<FileDownload> download(String path,
 FileTransformOptions transformOptions)

Downloads a file from a private bucket. To download something from a public bucket, make a request to the url from getPublicUrl(String, FileDownloadOption, FileTransformOptions)

GET /object/authenticated/{bucketName}/{wildcard}

Parameters:

path - The path of the file to download

transformOptions - The transform options if any

Returns:

a FileDownload

getPublicUrl

FilePublicUrlResponse getPublicUrl(String path,
 FileDownloadOption downloadOptions,
 FileTransformOptions transformOptions)

Creates the url for an object in a public bucket

Parameters:

path - The path of the file the link should point to.

downloadOptions - The download options if any.

transformOptions - The transform options if any

Returns:

a FilePublicUrlResponse

list

CompletableFuture<List<File>> list(FileSearchOptions options)

POST /object/list/{bucketName}

Parameters:

options - Options for the file search

Returns:

a list of File

list

CompletableFuture<List<File>> list(String path,
 FileSearchOptions options)

POST /object/list/{bucketName}

Parameters:

path - The prefix to list objects by

options - Options for the file search

Returns:

a list of File

delete

CompletableFuture<List<File>> delete(List<String> paths)

DELETE /object/{bucketName}

Parameters:

paths - a list of paths to files that should be deleted. BE WARY! PROVIDING NULL OR AN EMPTY LIST WILL DELETE THE ENTIRE BUCKET!

Returns:

a list of the deleted files