Package com.google.cloud.storage

Interface BlobAppendableUpload.AppendableUploadWriteableByteChannel

All Superinterfaces:

AutoCloseable, Channel, Closeable, WritableByteChannel

Enclosing interface:

BlobAppendableUpload

@BetaApi
@InternalExtensionOnly
public static interface BlobAppendableUpload.AppendableUploadWriteableByteChannel
extends WritableByteChannel

The WritableByteChannel returned from BlobAppendableUpload.open().

This interface allows writing bytes to an Appendable Upload, and provides methods to close this channel -- optionally finalizing the upload.

Since:

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

Method Summary

Modifier and Type	Method	Description
void	close()	Close this instance to further WritableByteChannel.write(ByteBuffer)ing.
void	closeWithoutFinalizing()	Close this instance to further WritableByteChannel.write(ByteBuffer)ing without finalizing the upload.
void	finalizeAndClose()	Finalize the upload and close this instance to further WritableByteChannel.write(ByteBuffer)ing.

Methods inherited from interface java.nio.channels.Channel

isOpen

Methods inherited from interface java.nio.channels.WritableByteChannel

write

Method Details

finalizeAndClose

@BetaApi
void finalizeAndClose()
               throws IOException

Finalize the upload and close this instance to further WritableByteChannel.write(ByteBuffer)ing. This will close any underlying stream and release any releasable resources once out of scope.

Once this method is called, and returns no more writes to the object will be allowed by GCS.

This method and close() are mutually exclusive. If one of the other methods are called before this method, this method will be a no-op.

Throws:

IOException

Since:

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

See Also:

• Storage.blobAppendableUpload(BlobInfo, BlobAppendableUploadConfig, BlobWriteOption...)
• BlobAppendableUploadConfig.CloseAction.FINALIZE_WHEN_CLOSING
• BlobAppendableUploadConfig.getCloseAction()
• BlobAppendableUploadConfig.withCloseAction(CloseAction)

closeWithoutFinalizing

@BetaApi
void closeWithoutFinalizing()
                     throws IOException

Close this instance to further WritableByteChannel.write(ByteBuffer)ing without finalizing the upload. This will close any underlying stream and release any releasable resources once out of scope.

This method, finalizeAndClose() and close() are mutually exclusive. If one of the other methods are called before this method, this method will be a no-op.

Throws:

IOException

Since:

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

See Also:

• Storage.blobAppendableUpload(BlobInfo, BlobAppendableUploadConfig, BlobWriteOption...)
• BlobAppendableUploadConfig.CloseAction.CLOSE_WITHOUT_FINALIZING
• BlobAppendableUploadConfig.getCloseAction()
• BlobAppendableUploadConfig.withCloseAction(CloseAction)

close

@BetaApi
void close()
    throws IOException

Close this instance to further WritableByteChannel.write(ByteBuffer)ing.

Whether the upload is finalized during this depends on the BlobAppendableUploadConfig.getCloseAction() provided to create the BlobAppendableUpload. If BlobAppendableUploadConfig.getCloseAction()== BlobAppendableUploadConfig.CloseAction.FINALIZE_WHEN_CLOSING, finalizeAndClose() will be called. If BlobAppendableUploadConfig.getCloseAction()== BlobAppendableUploadConfig.CloseAction.CLOSE_WITHOUT_FINALIZING, closeWithoutFinalizing() will be called.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Specified by:

close in interface Closeable

Throws:

IOException

Since:

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

See Also:

• Storage.blobAppendableUpload(BlobInfo, BlobAppendableUploadConfig, BlobWriteOption...)
• BlobAppendableUploadConfig.getCloseAction()
• BlobAppendableUploadConfig.withCloseAction(CloseAction)