ParallelTransferOptions (Azure SDK for Java Reference Documentation)

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()` Creates a new `ParallelTransferOptions`.
`ParallelTransferOptions(Integer blockSize, Integer maxConcurrency, ProgressReceiver progressReceiver)` Deprecated. Use fluent interface to set properties instead.
`ParallelTransferOptions(Integer blockSize, Integer maxConcurrency, ProgressReceiver progressReceiver, Integer maxSingleUploadSize)` Deprecated. Use fluent interface to set properties instead.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Integer`	`getBlockSize()` Deprecated. Use `ParallelTransferOptions.getBlockSizeLong()`.
`Long`	`getBlockSizeLong()` Gets the block size (chunk size) to transfer at a time.
`Integer`	`getMaxConcurrency()` The maximum number of parallel requests that will be issued at any given time as a part of a single parallel transfer.
`Integer`	`getMaxSingleUploadSize()` Deprecated. Use `ParallelTransferOptions.getMaxSingleUploadSizeLong()`.
`Long`	`getMaxSingleUploadSizeLong()` Gets the value above which the upload will be broken into blocks and parallelized.
`Integer`	`getNumBuffers()` Deprecated. Use `ParallelTransferOptions.getMaxConcurrency()`
`ProgressReceiver`	`getProgressReceiver()` Gets the Progress receiver for parallel reporting
`ParallelTransferOptions`	`setBlockSizeLong(Long blockSize)` Sets the block size (chunk size) to transfer at a time.
`ParallelTransferOptions`	`setMaxConcurrency(Integer maxConcurrency)`
`ParallelTransferOptions`	`setMaxSingleUploadSizeLong(Long maxSingleUploadSize)` If the size of the data is less than or equal to this value, it will be uploaded in a single put rather than broken up into chunks.
`ParallelTransferOptions`	`setProgressReceiver(ProgressReceiver progressReceiver)` Sets the `ProgressReceiver`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ParallelTransferOptions
```
public ParallelTransferOptions()
```
    Creates a new ParallelTransferOptions.
  - ParallelTransferOptions
```
@Deprecated
public ParallelTransferOptions(Integer blockSize,
                                           Integer maxConcurrency,
                                           ProgressReceiver progressReceiver)
```
    Deprecated. Use fluent interface to set properties instead.
    
    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.
    
    maxConcurrency - 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
  - ParallelTransferOptions
```
@Deprecated
public ParallelTransferOptions(Integer blockSize,
                                           Integer maxConcurrency,
                                           ProgressReceiver progressReceiver,
                                           Integer maxSingleUploadSize)
```
    Deprecated. Use fluent interface to set properties instead.
    
    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 * maxConcurrency.
    
    maxConcurrency - The maximum number of parallel requests that will be issued at any given time as a part of a single parallel transfer. This value applies per api. For example, if two calls to uploadFromFile are made at the same time, and each specifies a maxConcurrency of 5, there may be up to 10 outstanding, concurrent requests, up to 5 for each of the upload operations. For buffered uploads only, the maximum number of buffers to be allocated as part of the transfer will be maxConcurrency + 1. In those cases, memory will be allocated lazily as needed. The amount of memory consumed by methods which buffer may be up to blockSize * maxConcurrency. In general, upload methods which do not accept a length parameter must perform some buffering.
    
    progressReceiver - ProgressReceiver
    
    maxSingleUploadSize - If the size of the data is less than or equal to this value, it will be uploaded in a single put rather than broken up into chunks. If the data is uploaded in a single shot, the block size will be ignored. Some constraints to consider are that more requests cost more, but several small or mid-sized requests may sometimes perform better. In the case of buffered upload, up to this amount of data may be buffered before any data is sent. Must be greater than 0. May be null to accept default behavior, which is the maximum value the service accepts for uploading in a single requests and is represented by BlockBlobAsyncClient.MAX_UPLOAD_BLOB_BYTES.
- Method Detail
  - getBlockSize
```
@Deprecated
public Integer getBlockSize()
```
    Deprecated. Use ParallelTransferOptions.getBlockSizeLong().
    
    Gets the block size (chunk size) to transfer at a time.
    
    Returns:
    
    The block size.
  - getBlockSizeLong
```
public Long getBlockSizeLong()
```
    Gets the block size (chunk size) to transfer at a time.
    
    Returns:
    
    The block size.
  - setBlockSizeLong
```
public ParallelTransferOptions setBlockSizeLong(Long blockSize)
```
    Sets the block size (chunk size) to transfer at a time. 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.
    
    Parameters:
    
    blockSize - The block size.
    
    Returns:
    
    The ParallelTransferOptions object itself.
  - getNumBuffers
```
@Deprecated
public Integer getNumBuffers()
```
    Deprecated. Use ParallelTransferOptions.getMaxConcurrency()
    
    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
  - setProgressReceiver
```
public ParallelTransferOptions setProgressReceiver(ProgressReceiver progressReceiver)
```
    Sets the ProgressReceiver.
    
    Parameters:
    
    progressReceiver - The ProgressReceiver.
    
    Returns:
    
    The ParallelTransferOptions object itself.
  - getMaxSingleUploadSize
```
@Deprecated
public Integer getMaxSingleUploadSize()
```
    Deprecated. Use ParallelTransferOptions.getMaxSingleUploadSizeLong().
    
    Gets the value above which the upload will be broken into blocks and parallelized.
    
    Returns:
    
    The threshold value.
  - getMaxSingleUploadSizeLong
```
public Long getMaxSingleUploadSizeLong()
```
    Gets the value above which the upload will be broken into blocks and parallelized.
    
    Returns:
    
    The threshold value.
  - setMaxSingleUploadSizeLong
```
public ParallelTransferOptions setMaxSingleUploadSizeLong(Long maxSingleUploadSize)
```
    If the size of the data is less than or equal to this value, it will be uploaded in a single put rather than broken up into chunks. If the data is uploaded in a single shot, the block size will be ignored. Some constraints to consider are that more requests cost more, but several small or mid-sized requests may sometimes perform better. In the case of buffered upload, up to this amount of data may be buffered before any data is sent. Must be greater than 0. May be null to accept default behavior, which is the maximum value the service accepts for uploading in a single requests and is represented by BlockBlobAsyncClient.MAX_UPLOAD_BLOB_BYTES_LONG.
    
    Parameters:
    
    maxSingleUploadSize - The threshold value.
    
    Returns:
    
    The ParallelTransferOptions object itself.
  - getMaxConcurrency
```
public Integer getMaxConcurrency()
```
    The maximum number of parallel requests that will be issued at any given time as a part of a single parallel transfer. This value applies per api. For example, if two calls to uploadFromFile are made at the same time, and each specifies a maxConcurrency of 5, there may be up to 10 outstanding, concurrent requests, up to 5 for each of the upload operations. For buffered uploads only, the maximum number of buffers to be allocated as part of the transfer will be maxConcurrency + 1. In those cases, memory will be allocated lazily as needed. The amount of memory consumed by methods which buffer may be up to blockSize * maxConcurrency. In general, upload methods which do not accept a length parameter must perform some buffering.
    
    Returns:
    
    The max concurrency value.
  - setMaxConcurrency
```
public ParallelTransferOptions setMaxConcurrency(Integer maxConcurrency)
```
    Parameters:
    
    maxConcurrency - The maximum number of parallel requests that will be issued at any given time as a part of a single parallel transfer. This value applies per api. For example, if two calls to uploadFromFile are made at the same time, and each specifies a maxConcurrency of 5, there may be up to 10 outstanding, concurrent requests, up to 5 for each of the upload operations. For buffered uploads only, the maximum number of buffers to be allocated as part of the transfer will be maxConcurrency + 1. In those cases, memory will be allocated lazily as needed. The amount of memory consumed by methods which buffer may be up to blockSize * maxConcurrency. In general, upload methods which do not accept a length parameter must perform some buffering.
    
    Returns:
    
    The ParallelTransferOptions object itself.

Class ParallelTransferOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ParallelTransferOptions

ParallelTransferOptions

ParallelTransferOptions

Method Detail

getBlockSize

getBlockSizeLong

setBlockSizeLong

getNumBuffers

getProgressReceiver

setProgressReceiver

getMaxSingleUploadSize

getMaxSingleUploadSizeLong

setMaxSingleUploadSizeLong

getMaxConcurrency

setMaxConcurrency