Package io.supabase.api

Interface IStorageBucketAPI

All Known Implementing Classes:

StorageBucketAPI, StorageClient

public interface IStorageBucketAPI

Method Summary

Modifier and Type	Method	Description
CompletableFuture<CreateBucketResponse>	createBucket(String bucketId)	POST /bucket/
CompletableFuture<CreateBucketResponse>	createBucket(String bucketId, BucketCreateOptions options)	POST /bucket/
CompletableFuture<MessageResponse>	deleteBucket(String bucketId)	DELETE /bucket/{bucketId}
CompletableFuture<MessageResponse>	emptyBucket(String bucketId)	POST /bucket/{bucketId}/empty
CompletableFuture<Bucket>	getBucket(String bucketId)	GET /bucket/{bucketId}/
CompletableFuture<List<Bucket>>	listBuckets()	GET /bucket/
CompletableFuture<MessageResponse>	updateBucket(String bucketId, BucketUpdateOptions options)	PUT /bucket/{bucketId}/

Method Details

createBucket

CompletableFuture<CreateBucketResponse> createBucket(String bucketId)

POST /bucket/

Parameters:

bucketId - The name/id of the bucket you want to create.

Returns:

a CreateBucketResponse object.

createBucket

CompletableFuture<CreateBucketResponse> createBucket(String bucketId,
 BucketCreateOptions options)

POST /bucket/

Parameters:

bucketId - The name/id of the bucket you want to create.

options - The options you want to pass for the bucket creation.

Returns:

a CreateBucketResponse object.

listBuckets

CompletableFuture<List<Bucket>> listBuckets()

GET /bucket/

Lists all buckets in the project.

Returns:

A list of all buckets.

emptyBucket

CompletableFuture<MessageResponse> emptyBucket(String bucketId)

POST /bucket/{bucketId}/empty

Parameters:

bucketId - The bucket you want to empty.

Returns:

a status message

getBucket

CompletableFuture<Bucket> getBucket(String bucketId)

GET /bucket/{bucketId}/

Parameters:

bucketId - The bucket of which you want to retrieve.

Returns:

the asked for bucket

updateBucket

CompletableFuture<MessageResponse> updateBucket(String bucketId,
 BucketUpdateOptions options)

PUT /bucket/{bucketId}/

Parameters:

bucketId - The bucket you want to update

options - The options to update the bucket to.

Returns:

a status message

deleteBucket

CompletableFuture<MessageResponse> deleteBucket(String bucketId)

DELETE /bucket/{bucketId}

Parameters:

bucketId - The bucket of which you want to delete.

Returns:

a status message