com.azure.storage.blob.models

Class ParallelTransferOptions

java.lang.Object

com.azure.storage.blob.models.ParallelTransferOptions

public final class ParallelTransferOptions
extends Object

This class contains configuration used to parallelize data transfer operations. Note that not all values are used by every method which accepts this type. Please refer to the javadoc on specific methods for these cases.

Constructor Summary

Constructors

Constructor and Description
ParallelTransferOptions(Integer blockSize, Integer numBuffers, ProgressReceiver progressReceiver) Creates a new ParallelTransferOptions with default parameters applied.

Method Summary

Modifier and Type	Method and Description
Integer	getBlockSize() Gets the block size (chunk size) to transfer at a time.
Integer	getNumBuffers() Gets the number of buffers being used for a transfer operation.
ProgressReceiver	getProgressReceiver() Gets the Progress receiver for parallel reporting

Methods inherited from class java.lang.Object

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

Constructor Detail

ParallelTransferOptions

public ParallelTransferOptions(Integer blockSize,
                               Integer numBuffers,
                               ProgressReceiver progressReceiver)

Creates a new ParallelTransferOptions with default parameters applied.

Parameters:

blockSize - The block size. For upload, The block size is the size of each block that will be staged. This value also determines the number of requests that need to be made. If block size is large, upload will make fewer network calls, but each individual call will send more data and will therefore take longer. This parameter also determines the size that each buffer uses when buffering is required and consequently amount of memory consumed by such methods may be up to blockSize * numBuffers.

numBuffers - For buffered upload only, the number of buffers is the maximum number of buffers this method should allocate. Memory will be allocated lazily as needed. Must be at least two. Typically, the larger the number of buffers, the more parallel, and thus faster, the upload portion of this operation will be. The amount of memory consumed by methods using this value may be up to blockSize * numBuffers.

progressReceiver - ProgressReceiver

Method Detail

getBlockSize

public Integer getBlockSize()

Gets the block size (chunk size) to transfer at a time.

Returns:

The block size.

getNumBuffers

public Integer getNumBuffers()

Gets the number of buffers being used for a transfer operation.

Returns:

The number of buffers.

getProgressReceiver

public ProgressReceiver getProgressReceiver()

Gets the Progress receiver for parallel reporting

Returns:

the progress reporter