Package com.google.cloud.storage

Interface BlobAppendableUpload

All Superinterfaces:

BlobWriteSession

@BetaApi
@InternalExtensionOnly
public interface BlobAppendableUpload
extends BlobWriteSession

Interface representing those methods which can be used to write to and interact with an appendable upload.

See Also:

• Storage.blobAppendableUpload(BlobInfo, BlobAppendableUploadConfig, BlobWriteOption...)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	BlobAppendableUpload.AppendableUploadWriteableByteChannel	The WritableByteChannel returned from open().

Method Summary

Modifier and Type	Method	Description
com.google.api.core.ApiFuture<BlobInfo>	getResult()	Return an ApiFuture<BlobInfo> which will represent the state of the object in Google Cloud Storage.
BlobAppendableUpload.AppendableUploadWriteableByteChannel	open()	Open the AppendableUploadWriteableByteChannel for this session.

Method Details

open

BlobAppendableUpload.AppendableUploadWriteableByteChannel open()
                                                        throws IOException

Open the AppendableUploadWriteableByteChannel for this session.

A session may only be opened once. If multiple calls to open are made, an illegal state exception will be thrown

The returned AppendableUploadWriteableByteChannel can throw IOExceptions from any of its usual methods. Any IOException thrown can have a cause of a StorageException. However, not all IOExceptions will have StorageExceptions.

Specified by:

open in interface BlobWriteSession

Throws:

IOException - When creating the BlobAppendableUpload.AppendableUploadWriteableByteChannel if an unrecoverable underlying IOException occurs it can be rethrown

IllegalStateException - if open is called more than once

Since:

2.51.0 This new api is in preview and is subject to breaking changes.

getResult

com.google.api.core.ApiFuture<BlobInfo> getResult()

Return an ApiFuture<BlobInfo> which will represent the state of the object in Google Cloud Storage.

This future will not resolve until:

1. The object is successfully finalized in Google Cloud Storage by calling AppendableUploadWriteableByteChannel#finalizeAndClose()
2. This session is detached from the upload without finalizing by calling AppendableUploadWriteableByteChannel#closeWithoutFinalizing()
3. The session is closed by calling AppendableUploadWriteableByteChannel#close()
4. A terminal failure occurs, the terminal failure will become the exception result

NOTICE: Some fields may not be populated unless finalization has completed.

If a terminal failure is encountered, calling either Future.get() or Future.get(long, TimeUnit) will result in an ExecutionException with the cause.

Specified by:

getResult in interface BlobWriteSession

Since:

2.51.0 This new api is in preview and is subject to breaking changes.