Package com.google.cloud.storage

Class BlobAppendableUploadConfig

java.lang.Object

com.google.cloud.storage.BlobAppendableUploadConfig

@Immutable
@BetaApi
@TransportCompatibility(GRPC)
public final class BlobAppendableUploadConfig
extends Object

Configuration parameters for an appendable uploads channel.

Instances of this class are immutable and thread safe.

Since:

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

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BlobAppendableUploadConfig.CloseAction	Enum providing the possible actions which can be taken during the BlobAppendableUpload.AppendableUploadWriteableByteChannel.close() call.

Method Summary

Modifier and Type	Method	Description
BlobAppendableUploadConfig.CloseAction	getCloseAction()	The BlobAppendableUploadConfig.CloseAction which will dictate the behavior of BlobAppendableUpload.AppendableUploadWriteableByteChannel.close().
FlushPolicy	getFlushPolicy()	The FlushPolicy which will be used to determine when and how many bytes to flush to GCS.
static BlobAppendableUploadConfig	of()	Default instance factory method.
BlobAppendableUploadConfig	withCloseAction(BlobAppendableUploadConfig.CloseAction closeAction)	Return an instance with the CloseAction set to be the specified value.
BlobAppendableUploadConfig	withFlushPolicy(FlushPolicy flushPolicy)	Return an instance with the FlushPolicy set to be the specified value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getFlushPolicy

@BetaApi
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)

Since:

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

See Also:

• withFlushPolicy(FlushPolicy)

withFlushPolicy

@BetaApi
public BlobAppendableUploadConfig withFlushPolicy(FlushPolicy flushPolicy)

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

Default: FlushPolicy.minFlushSize(256 * 1024)

Since:

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

See Also:

• getFlushPolicy()

getCloseAction

@BetaApi
public BlobAppendableUploadConfig.CloseAction getCloseAction()

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

Default: BlobAppendableUploadConfig.CloseAction.CLOSE_WITHOUT_FINALIZING

Since:

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

See Also:

• withCloseAction(CloseAction)

withCloseAction

@BetaApi
public BlobAppendableUploadConfig withCloseAction(BlobAppendableUploadConfig.CloseAction closeAction)

Return an instance with the CloseAction set to be the specified value. Default: BlobAppendableUploadConfig.CloseAction.CLOSE_WITHOUT_FINALIZING

Since:

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

See Also:

• getCloseAction()

of

@BetaApi
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)
 

Since:

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

See Also:

• FlushPolicy.minFlushSize(int)