Class BlobAppendableUploadConfig (2.58.1)

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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

Object > BlobAppendableUploadConfig

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

of()

public static BlobAppendableUploadConfig of()

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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

equals(Object o)

public boolean equals(Object o)

Parameter
Name	Description
o	Object

Returns
Type	Description
boolean

Overrides

Object.equals(Object)

getCloseAction()

public BlobAppendableUploadConfig.CloseAction getCloseAction()

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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()

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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

Default: FlushPolicy#minFlushSize() See Also: #withFlushPolicy(FlushPolicy)

Returns
Type	Description
FlushPolicy

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

Object.hashCode()

toString()

public String toString()

Returns
Type	Description
String

Overrides

Object.toString()

withCloseAction(BlobAppendableUploadConfig.CloseAction closeAction)

public BlobAppendableUploadConfig withCloseAction(BlobAppendableUploadConfig.CloseAction closeAction)

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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)

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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

Default: FlushPolicy#minFlushSize() See Also: #getFlushPolicy()

Parameter
Name	Description
flushPolicy	FlushPolicy

Returns
Type	Description
BlobAppendableUploadConfig