Interface BlobAppendableUpload.AppendableUploadWriteableByteChannel (2.57.0)

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.

The #write(ByteBuffer) method of this channel is non-blocking.

This method is blocking

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

Whether the upload is finalized during this depends on the BlobAppendableUploadConfig#getCloseAction() provided to create the BlobAppendableUpload. If BlobAppendableUploadConfig#getCloseAction()== CloseAction#FINALIZE_WHEN_CLOSING, #finalizeAndClose() will be called. If BlobAppendableUploadConfig#getCloseAction()== CloseAction#CLOSE_WITHOUT_FINALIZING, #closeWithoutFinalizing() will be called. See Also: Storage#blobAppendableUpload(BlobInfo, BlobAppendableUploadConfig, BlobWriteOption...), BlobAppendableUploadConfig#getCloseAction(), BlobAppendableUploadConfig#withCloseAction(CloseAction)

This method is blocking

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

This method, AppendableUploadWriteableByteChannel#finalizeAndClose() and AppendableUploadWriteableByteChannel#close() are mutually exclusive. If one of the other methods are called before this method, this method will be a no-op. See Also: BlobAppendableUploadConfig.CloseAction#CLOSE_WITHOUT_FINALIZING, Storage#blobAppendableUpload(BlobInfo, BlobAppendableUploadConfig, BlobWriteOption...), BlobAppendableUploadConfig#getCloseAction(), BlobAppendableUploadConfig#withCloseAction(CloseAction)

This method is blocking

Finalize the upload and close this instance to further #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. See Also: BlobAppendableUploadConfig.CloseAction#FINALIZE_WHEN_CLOSING, Storage#blobAppendableUpload(BlobInfo, BlobAppendableUploadConfig, BlobWriteOption...), BlobAppendableUploadConfig#getCloseAction(), BlobAppendableUploadConfig#withCloseAction(CloseAction)

This method is blocking

Block the invoking thread, waiting until the number of bytes written so far has been acknowledged by Google Cloud Storage.

This method is non-blocking

Consume as many bytes as can fit in the underlying outbound queue. The size of the outbound queue is determined from BlobAppendableUploadConfig#getFlushPolicy() .getMaxPendingBytes(). If the outbound queue is full, and can not fit more bytes, this method will return 0.

If your application needs to empty its ByteBuffer before progressing, use our helper method StorageChannelUtils#blockingEmptyTo(ByteBuffer, WritableByteChannel) like so:

 try (AppendableUploadWriteableByteChannel channel = session.open()) {
   int written = StorageChannelUtils.blockingEmptyTo(byteBuffer, channel);
 }