com.microsoft.azure.storage.blob

Class TransferManager

java.lang.Object

com.microsoft.azure.storage.blob.TransferManager

public final 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.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BLOB_DEFAULT_DOWNLOAD_BLOCK_SIZE The default size of a download chunk for download large blobs.

Constructor Summary

Constructors

Constructor and Description
TransferManager()

Method Summary

Modifier and Type	Method and Description
static io.reactivex.Single<BlobDownloadHeaders>	downloadBlobToFile(AsynchronousFileChannel file, BlobURL blobURL, BlobRange range, TransferManagerDownloadFromBlobOptions options) Downloads a file directly into a file, splitting the download into chunks and parallelizing as necessary.
static io.reactivex.Single<CommonRestResponse>	uploadFileToBlockBlob(AsynchronousFileChannel file, BlockBlobURL blockBlobURL, int blockLength, TransferManagerUploadToBlockBlobOptions 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

Field Detail

BLOB_DEFAULT_DOWNLOAD_BLOCK_SIZE

public static final int BLOB_DEFAULT_DOWNLOAD_BLOCK_SIZE

The default size of a download chunk for download large blobs.

See Also:

Constant Field Values

Constructor Detail

TransferManager

public TransferManager()

Method Detail

uploadFileToBlockBlob

public static io.reactivex.Single<CommonRestResponse> uploadFileToBlockBlob(AsynchronousFileChannel file,
                                                                            BlockBlobURL blockBlobURL,
                                                                            int blockLength,
                                                                            TransferManagerUploadToBlockBlobOptions options)
                                                                     throws IOException

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 as each REST request uploads exactly one block in full. 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 - TransferManagerUploadToBlockBlobOptions

Returns:

Emits the successful response.

Throws:

IOException

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/master/src/test/java/com/microsoft/azure/storage/Samples.java)

downloadBlobToFile

public static io.reactivex.Single<BlobDownloadHeaders> downloadBlobToFile(AsynchronousFileChannel file,
                                                                          BlobURL blobURL,
                                                                          BlobRange range,
                                                                          TransferManagerDownloadFromBlobOptions options)

Downloads a file directly into a file, splitting the download into chunks and parallelizing as necessary.

Parameters:

file - The destination file to which the blob will be written.

blobURL - The URL to the blob to download.

range - BlobRange

options - TransferManagerDownloadFromBlobOptions

Returns:

A Completable that will signal when the download is complete.

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.downloadBlobToFile")] \n For more samples, please see the [Samples file](%https://github.com/Azure/azure-storage-java/blob/master/src/test/java/com/microsoft/azure/storage/Samples.java)