com.google.cloud.storage.spi

Interface StorageRpc

All Known Implementing Classes:

DefaultStorageRpc

public interface StorageRpc

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	StorageRpc.Option
static class	StorageRpc.RewriteRequest
static class	StorageRpc.RewriteResponse
static class	StorageRpc.Tuple<X,Y>

Method Summary

Methods

Modifier and Type	Method and Description
com.google.api.services.storage.model.StorageObject	compose(Iterable<com.google.api.services.storage.model.StorageObject> sources, com.google.api.services.storage.model.StorageObject target, Map<StorageRpc.Option,?> targetOptions) Sends a compose request.
StorageRpc.RewriteResponse	continueRewrite(StorageRpc.RewriteResponse previousResponse) Continues rewriting on an already open rewrite channel.
com.google.api.services.storage.model.Bucket	create(com.google.api.services.storage.model.Bucket bucket, Map<StorageRpc.Option,?> options) Creates a new bucket.
com.google.api.services.storage.model.StorageObject	create(com.google.api.services.storage.model.StorageObject object, InputStream content, Map<StorageRpc.Option,?> options) Creates a new storage object.
RpcBatch	createBatch() Creates an empty batch.
boolean	delete(com.google.api.services.storage.model.Bucket bucket, Map<StorageRpc.Option,?> options) Deletes the requested bucket.
boolean	delete(com.google.api.services.storage.model.StorageObject object, Map<StorageRpc.Option,?> options) Deletes the requested storage object.
com.google.api.services.storage.model.Bucket	get(com.google.api.services.storage.model.Bucket bucket, Map<StorageRpc.Option,?> options) Returns the requested bucket or null if not found.
com.google.api.services.storage.model.StorageObject	get(com.google.api.services.storage.model.StorageObject object, Map<StorageRpc.Option,?> options) Returns the requested storage object or null if not found.
StorageRpc.Tuple<String,Iterable<com.google.api.services.storage.model.Bucket>>	list(Map<StorageRpc.Option,?> options) Lists the project's buckets.
StorageRpc.Tuple<String,Iterable<com.google.api.services.storage.model.StorageObject>>	list(String bucket, Map<StorageRpc.Option,?> options) Lists the bucket's blobs.
byte[]	load(com.google.api.services.storage.model.StorageObject storageObject, Map<StorageRpc.Option,?> options) Reads all the bytes from a storage object.
String	open(com.google.api.services.storage.model.StorageObject object, Map<StorageRpc.Option,?> options) Opens a resumable upload channel for a given storage object.
StorageRpc.RewriteResponse	openRewrite(StorageRpc.RewriteRequest rewriteRequest) Sends a rewrite request to open a rewrite channel.
com.google.api.services.storage.model.Bucket	patch(com.google.api.services.storage.model.Bucket bucket, Map<StorageRpc.Option,?> options) Updates bucket information.
com.google.api.services.storage.model.StorageObject	patch(com.google.api.services.storage.model.StorageObject storageObject, Map<StorageRpc.Option,?> options) Updates the storage object's information.
StorageRpc.Tuple<String,byte[]>	read(com.google.api.services.storage.model.StorageObject from, Map<StorageRpc.Option,?> options, long position, int bytes) Reads the given amount of bytes from a storage object at the given position.
void	write(String uploadId, byte[] toWrite, int toWriteOffset, long destOffset, int length, boolean last) Writes the provided bytes to a storage object at the provided location.

Method Detail

create

com.google.api.services.storage.model.Bucket create(com.google.api.services.storage.model.Bucket bucket,
                                                  Map<StorageRpc.Option,?> options)

Creates a new bucket.

Throws:

StorageException - upon failure

create

com.google.api.services.storage.model.StorageObject create(com.google.api.services.storage.model.StorageObject object,
                                                         InputStream content,
                                                         Map<StorageRpc.Option,?> options)

Creates a new storage object.

Throws:

StorageException - upon failure

list

StorageRpc.Tuple<String,Iterable<com.google.api.services.storage.model.Bucket>> list(Map<StorageRpc.Option,?> options)

Lists the project's buckets.

Throws:

StorageException - upon failure

list

StorageRpc.Tuple<String,Iterable<com.google.api.services.storage.model.StorageObject>> list(String bucket,
                                                                                          Map<StorageRpc.Option,?> options)

Lists the bucket's blobs.

Throws:

StorageException - upon failure

get

com.google.api.services.storage.model.Bucket get(com.google.api.services.storage.model.Bucket bucket,
                                               Map<StorageRpc.Option,?> options)

Returns the requested bucket or null if not found.

Throws:

StorageException - upon failure

get

com.google.api.services.storage.model.StorageObject get(com.google.api.services.storage.model.StorageObject object,
                                                      Map<StorageRpc.Option,?> options)

Returns the requested storage object or null if not found.

Throws:

StorageException - upon failure

patch

com.google.api.services.storage.model.Bucket patch(com.google.api.services.storage.model.Bucket bucket,
                                                 Map<StorageRpc.Option,?> options)

Updates bucket information.

Throws:

StorageException - upon failure

patch

com.google.api.services.storage.model.StorageObject patch(com.google.api.services.storage.model.StorageObject storageObject,
                                                        Map<StorageRpc.Option,?> options)

Updates the storage object's information. Original metadata are merged with metadata in the provided storageObject.

Throws:

StorageException - upon failure

delete

boolean delete(com.google.api.services.storage.model.Bucket bucket,
             Map<StorageRpc.Option,?> options)

Deletes the requested bucket.

Returns:

true if the bucket was deleted, false if it was not found

Throws:

StorageException - upon failure

delete

boolean delete(com.google.api.services.storage.model.StorageObject object,
             Map<StorageRpc.Option,?> options)

Deletes the requested storage object.

Returns:

true if the storage object was deleted, false if it was not found

Throws:

StorageException - upon failure

createBatch

RpcBatch createBatch()

Creates an empty batch.

compose

com.google.api.services.storage.model.StorageObject compose(Iterable<com.google.api.services.storage.model.StorageObject> sources,
                                                          com.google.api.services.storage.model.StorageObject target,
                                                          Map<StorageRpc.Option,?> targetOptions)

Sends a compose request.

Throws:

StorageException - upon failure

load

byte[] load(com.google.api.services.storage.model.StorageObject storageObject,
          Map<StorageRpc.Option,?> options)

Reads all the bytes from a storage object.

Throws:

StorageException - upon failure

read

StorageRpc.Tuple<String,byte[]> read(com.google.api.services.storage.model.StorageObject from,
                                   Map<StorageRpc.Option,?> options,
                                   long position,
                                   int bytes)

Reads the given amount of bytes from a storage object at the given position.

Throws:

StorageException - upon failure

open

String open(com.google.api.services.storage.model.StorageObject object,
          Map<StorageRpc.Option,?> options)

Opens a resumable upload channel for a given storage object.

Throws:

StorageException - upon failure

write

void write(String uploadId,
         byte[] toWrite,
         int toWriteOffset,
         long destOffset,
         int length,
         boolean last)

Writes the provided bytes to a storage object at the provided location.

Throws:

StorageException - upon failure

openRewrite

StorageRpc.RewriteResponse openRewrite(StorageRpc.RewriteRequest rewriteRequest)

Sends a rewrite request to open a rewrite channel.

Throws:

StorageException - upon failure

continueRewrite

StorageRpc.RewriteResponse continueRewrite(StorageRpc.RewriteResponse previousResponse)

Continues rewriting on an already open rewrite channel.

Throws:

StorageException - upon failure