com.oracle.bmc.objectstorage.transfer

Class UploadConfiguration

java.lang.Object

com.oracle.bmc.objectstorage.transfer.UploadConfiguration

public class UploadConfiguration
extends Object

The configuration for the UploadManager. For more information, please refer to the online documentation found here.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UploadConfiguration.UploadConfigurationBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static long	MAXIMUM_ALLOWED_LENGTH_PER_PART_MB
static int	MAXIMUM_NUM_ALLOWED_PARTS
static long	MINIMUM_ALLOWED_LENGTH_PER_PART_MB

Method Summary

Modifier and Type	Method and Description
static UploadConfiguration.UploadConfigurationBuilder	builder()
ChecksumAlgorithm	getAdditionalChecksumAlgorithm() The value of the additional checksum algorithm.
ChecksumAlgorithm	getEnforceAdditionalChecksumBeforeMultipartUpload() Flag to indicate that additional checksum should be set on every part of a multi-part upload.
ChecksumAlgorithm	getEnforceAdditionalChecksumBeforeUpload() Flag to indicate that additional checksum should be set on every PutObject call.
long	getLengthPerUploadPart() Length in MiB for each part of a multi-part upload (except the last), default 128.
int	getMaxPartsForMultipartUpload() Deprecated. no longer configurable as maxPartsForMultipartUpload is always configured as the default of 10,000. Use instead
long	getMinimumLengthForMultipartUpload() Minimum length in MiB before an upload is performed using multi-part upload, default 128.
long	getMinimumLengthPerUploadPart() Deprecated.
boolean	isAllowMultipartUploads() Flag to indicate that multi-part uploads can be used.
boolean	isAllowParallelUploads() Flag to indicate that multi-part uploads can upload individual parts in parallel if possible.
boolean	isDisableAutoAbort() Flag to indicate that uploads that fail should not be automatically aborted (client is reponsible for always cleaning up failed uploads themselves).
boolean	isEnforceMd5BeforeMultipartUpload() Flag to indicate that MD5 should be set on every part of a multi-part upload.
boolean	isEnforceMd5BeforeUpload() Flag to indicate that MD5 should be set on every PutObject call.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

MAXIMUM_NUM_ALLOWED_PARTS

public static final int MAXIMUM_NUM_ALLOWED_PARTS

See Also:

Constant Field Values

MINIMUM_ALLOWED_LENGTH_PER_PART_MB

public static final long MINIMUM_ALLOWED_LENGTH_PER_PART_MB

See Also:

Constant Field Values

MAXIMUM_ALLOWED_LENGTH_PER_PART_MB

public static final long MAXIMUM_ALLOWED_LENGTH_PER_PART_MB

See Also:

Constant Field Values

Method Detail

getMinimumLengthPerUploadPart

@Deprecated
public long getMinimumLengthPerUploadPart()

Deprecated.

builder

public static UploadConfiguration.UploadConfigurationBuilder builder()

getMinimumLengthForMultipartUpload

public long getMinimumLengthForMultipartUpload()

Minimum length in MiB before an upload is performed using multi-part upload, default 128.

Note: Accepted values: 0 - 51200. Using a large value is not recommended.

getLengthPerUploadPart

public long getLengthPerUploadPart()

Length in MiB for each part of a multi-part upload (except the last), default 128.

Accepted values: 1 - 51200. Using a large value is not recommended.

getMaxPartsForMultipartUpload

@Deprecated
public int getMaxPartsForMultipartUpload()

Deprecated. no longer configurable as maxPartsForMultipartUpload is always configured as the default of 10,000. Use instead

Maximum number of parts to split an upload into, default 10,000 (max allowable parts by Object Storage Service).

Note: Accepted values: 1 - 10000

isEnforceMd5BeforeUpload

public boolean isEnforceMd5BeforeUpload()

Flag to indicate that MD5 should be set on every PutObject call. If not provided, the SDK will calculate it before uploading the object. Default is false.

Note, having the SDK calculate it could lead to OutOfMemory exceptions if the stream cannot be duplicated, ie does not implement DuplicatableInputStream, as the entire stream will have to be read into memory.

isEnforceMd5BeforeMultipartUpload

public boolean isEnforceMd5BeforeMultipartUpload()

Flag to indicate that MD5 should be set on every part of a multi-part upload. The SDK will calculate the MD5 before uploading for each part it creates. Default is false.

Note, having the SDK calculate it could lead to OutOfMemory exceptions if the source stream for the part cannot be duplicated, ie does not implement DuplicatableInputStream, as the entire part will have to be read into memory.

getEnforceAdditionalChecksumBeforeUpload

public ChecksumAlgorithm getEnforceAdditionalChecksumBeforeUpload()

Flag to indicate that additional checksum should be set on every PutObject call. If not provided, the SDK will calculate it before uploading the object. Default is null.

Note: Valid values are "SHA256", "SHA384", "CRC32C".

getEnforceAdditionalChecksumBeforeMultipartUpload

public ChecksumAlgorithm getEnforceAdditionalChecksumBeforeMultipartUpload()

Flag to indicate that additional checksum should be set on every part of a multi-part upload. The SDK will calculate the additional checksum before uploading for each part it creates. Default is null.

Note: Valid values are "SHA256", "SHA384", "CRC32C".

isAllowMultipartUploads

public boolean isAllowMultipartUploads()

Flag to indicate that multi-part uploads can be used. Default is true.

isAllowParallelUploads

public boolean isAllowParallelUploads()

Flag to indicate that multi-part uploads can upload individual parts in parallel if possible. Default is true.

isDisableAutoAbort

public boolean isDisableAutoAbort()

Flag to indicate that uploads that fail should not be automatically aborted (client is reponsible for always cleaning up failed uploads themselves). Default is false.

getAdditionalChecksumAlgorithm

public ChecksumAlgorithm getAdditionalChecksumAlgorithm()

The value of the additional checksum algorithm. Default is null.

toString

public String toString()

Overrides:

toString in class Object