com.microsoft.azure.storage.blob

Class TransferManager

java.lang.Object

com.microsoft.azure.storage.blob.TransferManager

public class TransferManager
extends Object

This class contains a collection of methods (and structures associated with those methods) which perform higher-level operations. Whereas operations on the URL types guarantee a single REST request and make no assumptions on desired behavior, these methods will often compose several requests to provide a convenient way of performing more complex operations. Further, we will make our own assumptions and optimizations for common cases that may not be ideal for rarer cases.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TransferManager.UploadToBlockBlobOptions

Constructor Summary

Constructors

Constructor and Description
TransferManager()

Method Summary

Modifier and Type	Method and Description
static io.reactivex.Single<CommonRestResponse>	uploadByteBuffersToBlockBlob(Iterable<ByteBuffer> data, BlockBlobURL blockBlobURL, TransferManager.UploadToBlockBlobOptions options) Uploads an iterable of ByteBuffers to a block blob.
static io.reactivex.Single<CommonRestResponse>	uploadByteBufferToBlockBlob(ByteBuffer data, BlockBlobURL blockBlobURL, int blockLength, TransferManager.UploadToBlockBlobOptions options) Uploads a large ByteBuffer to a block blob in parallel, breaking it up into block-size chunks if necessary.
static io.reactivex.Single<CommonRestResponse>	uploadFileToBlockBlob(FileChannel file, BlockBlobURL blockBlobURL, int blockLength, TransferManager.UploadToBlockBlobOptions options) Uploads the contents of a file to a block blob in parallel, breaking it into block-size chunks if necessary.

Methods inherited from class java.lang.Object

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

Constructor Detail

TransferManager

public TransferManager()

Method Detail

uploadFileToBlockBlob

public static io.reactivex.Single<CommonRestResponse> uploadFileToBlockBlob(FileChannel file,
                                                                            BlockBlobURL blockBlobURL,
                                                                            int blockLength,
                                                                            TransferManager.UploadToBlockBlobOptions options)

Uploads the contents of a file to a block blob in parallel, breaking it into block-size chunks if necessary.

Parameters:

file - The file to upload.

blockBlobURL - Points to the blob to which the data should be uploaded.

blockLength - If the data must be broken up into blocks, this value determines what size those blocks will be. This will affect the total number of service requests made. This value will be ignored if the data can be uploaded in a single put-blob operation. Must be between 1 and BlockBlobURL.MAX_STAGE_BLOCK_BYTES. Note as well that fileLength/blockLength must be less than or equal to BlockBlobURL.MAX_BLOCKS.

options - TransferManager.UploadToBlockBlobOptions

Returns:

Emits the successful response.

API Note:

## Sample Code \n [!code-java[Sample_Code](../azure-storage-java/src/test/java/com/microsoft/azure/storage/Samples.java?name=tm_file "Sample code for TransferManager.uploadFileToBlockBlob")] \n For more samples, please see the [Samples file](https://github.com/Azure/azure-storage-java/blob/New-Storage-SDK-V10-Preview/src/test/java/com/microsoft/azure/storage/Samples.java)

uploadByteBufferToBlockBlob

public static io.reactivex.Single<CommonRestResponse> uploadByteBufferToBlockBlob(ByteBuffer data,
                                                                                  BlockBlobURL blockBlobURL,
                                                                                  int blockLength,
                                                                                  TransferManager.UploadToBlockBlobOptions options)

Uploads a large ByteBuffer to a block blob in parallel, breaking it up into block-size chunks if necessary.

Parameters:

data - The buffer to upload.

blockBlobURL - A BlockBlobURL that points to the blob to which the data should be uploaded.

blockLength - If the data must be broken up into blocks, this value determines what size those blocks will be. This will affect the total number of service requests made. This value will be ignored if the data can be uploaded in a single put-blob operation.

options - TransferManager.UploadToBlockBlobOptions

Returns:

Emits the successful response.

API Note:

## Sample Code \n [!code-java[Sample_Code](../azure-storage-java/src/test/java/com/microsoft/azure/storage/Samples.java?name=tm_buffer "Sample code for TransferManager.uploadByteBufferToBlockBlob")] \n For more samples, please see the [Samples file](https://github.com/Azure/azure-storage-java/blob/New-Storage-SDK-V10-Preview/src/test/java/com/microsoft/azure/storage/Samples.java)

uploadByteBuffersToBlockBlob

public static io.reactivex.Single<CommonRestResponse> uploadByteBuffersToBlockBlob(Iterable<ByteBuffer> data,
                                                                                   BlockBlobURL blockBlobURL,
                                                                                   TransferManager.UploadToBlockBlobOptions options)

Uploads an iterable of ByteBuffers to a block blob. The data will first data will first be examined to check the size and validate the number of blocks. If the total amount of data in all the buffers is small enough (i.e. less than or equal to BlockBlobURL.MAX_PUT_BLOB_BYTES, this method will perform a single upload operation. Otherwise, each ByteBuffer in the iterable is assumed to be its own discreet block of data for the block blob and will be uploaded as such. Note that in this case, each ByteBuffer must be less than or equal to BlockBlobURL.MAX_STAGE_BLOCK_BYTES. Note as well that there can only be up to BlockBlobURL.MAX_BLOCKS ByteBuffers in the list.

Parameters:

data - The data to upload.

blockBlobURL - A BlockBlobURL that points to the blob to which the data should be uploaded.

options - TransferManager.UploadToBlockBlobOptions

Returns:

Emits the successful response.

API Note:

## Sample Code \n [!code-java[Sample_Code](../azure-storage-java/src/test/java/com/microsoft/azure/storage/Samples.java?name=tm_buffers "Sample code for TransferManager.uploadByteBuffersToBlockBlob")] \n For more samples, please see the [Samples file](https://github.com/Azure/azure-storage-java/blob/New-Storage-SDK-V10-Preview/src/test/java/com/microsoft/azure/storage/Samples.java)