Class BlobAppendableUploadConfig (2.52.2)

public final class BlobAppendableUploadConfig

Configuration parameters for an appendable uploads channel.

Instances of this class are immutable and thread safe. See Also: Storage#blobAppendableUpload(BlobInfo, BlobAppendableUploadConfig, BlobWriteOption...)

Inheritance

java.lang.Object > BlobAppendableUploadConfig

Static Methods

of()

public static BlobAppendableUploadConfig of()

Default instance factory method.

The FlushPolicy of this instance is equivalent to the following:


 BlobAppendableUploadConfig.of()
   .withFlushPolicy(FlushPolicy.minFlushSize(256 * 1024))
   .withCloseAction(CloseAction.CLOSE_WITHOUT_FINALIZING)
 

See Also: FlushPolicy#minFlushSize(int)

Returns
Type Description
BlobAppendableUploadConfig

Methods

getCloseAction()

public BlobAppendableUploadConfig.CloseAction getCloseAction()

The CloseAction which will dictate the behavior of AppendableUploadWriteableByteChannel#close().

Default: CloseAction#CLOSE_WITHOUT_FINALIZING See Also: #withCloseAction(CloseAction)

Returns
Type Description
BlobAppendableUploadConfig.CloseAction

getFlushPolicy()

public FlushPolicy getFlushPolicy()

The FlushPolicy which will be used to determine when and how many bytes to flush to GCS.

Default: FlushPolicy.minFlushSize(256 * 1024) See Also: #withFlushPolicy(FlushPolicy)

Returns
Type Description
FlushPolicy

withCloseAction(BlobAppendableUploadConfig.CloseAction closeAction)

public BlobAppendableUploadConfig withCloseAction(BlobAppendableUploadConfig.CloseAction closeAction)

Return an instance with the CloseAction set to be the specified value. Default: CloseAction#CLOSE_WITHOUT_FINALIZING See Also: #getCloseAction()

Parameter
Name Description
closeAction BlobAppendableUploadConfig.CloseAction
Returns
Type Description
BlobAppendableUploadConfig

withFlushPolicy(FlushPolicy flushPolicy)

public BlobAppendableUploadConfig withFlushPolicy(FlushPolicy flushPolicy)

Return an instance with the FlushPolicy set to be the specified value.

Default: FlushPolicy.minFlushSize(256 * 1024) See Also: #getFlushPolicy()

Parameter
Name Description
flushPolicy FlushPolicy
Returns
Type Description
BlobAppendableUploadConfig