Interface TransferManager (2.41.0)

Version 2.41.0

• 2.44.1 (latest)
• 2.43.2
• 2.42.0
• 2.41.0
• 2.40.1
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.1
• 2.34.0
• 2.33.0
• 2.32.1
• 2.30.1
• 2.29.1
• 2.28.0
• 2.27.1
• 2.24.0
• 2.23.0
• 2.22.6
• 2.21.0
• 2.20.2
• 2.19.0
• 2.18.0
• 2.17.2
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.1
• 2.12.0
• 2.11.3
• 2.10.0
• 2.9.3
• 2.8.1
• 2.7.1
• 2.6.1
• 2.5.1
• 2.4.5
• 2.3.0
• 2.2.3
• 2.1.10

public interface TransferManager extends AutoCloseable

An interface for a Transfer Manager.

Transfer Manager handles Parallel Uploads and Parallel Downloads.

Implements

AutoCloseable

Methods

downloadBlobs(List<BlobInfo> blobs, ParallelDownloadConfig config)

public abstract @NonNull DownloadJob downloadBlobs(List<BlobInfo> blobs, ParallelDownloadConfig config)

Downloads a list of blobs in parallel. This operation will not block the invoking thread, awaiting results should be done on the returned DownloadJob.

Accepts a ParallelDownloadConfig which defines the constraints of parallel downloads or predefined defaults.

Example of creating a parallel download with Transfer Manager.

 String bucketName = "my-unique-bucket";
 String blobName = "my-blob-name";
 BlobId blobId = BlobId.of(bucketName, blobName);
 BlobInfo blobInfo = BlobInfo.newBuilder(blobId).setContentType("text/plain").build();
 Path baseDir = Paths.get("/path/to/directory/");

 ParallelDownloadConfig parallelDownloadConfig =
           ParallelDownloadConfig.newBuilder()
               .setBucketName(bucketName)
               .setDownloadDirectory(baseDir)
               .build();

 DownloadJob downloadedBlobs = transferManager.downloadBlobs(files, config);

 

Parameters
Name	Description
blobs	List<BlobInfo>
config	ParallelDownloadConfig

Returns
Type	Description
@org.checkerframework.checker.nullness.qual.NonNull com.google.cloud.storage.transfermanager.DownloadJob	a DownloadJob

uploadFiles(List<Path> files, ParallelUploadConfig config)

public abstract @NonNull UploadJob uploadFiles(List<Path> files, ParallelUploadConfig config)

Uploads a list of files in parallel. This operation will not block the invoking thread, awaiting results should be done on the returned UploadJob.

Accepts a ParallelUploadConfig which defines the constraints of parallel uploads or predefined defaults.

Example of creating a parallel upload with Transfer Manager.

 String bucketName = "my-unique-bucket";
 Path filePath = Paths.get("/path/to/my/file.txt");
 Path anotherFilePath = Paths.get("/path/to/another/file.txt");
 List<Path> files = List.of(filePath, anotherFilePath);

 ParallelUploadConfig parallelUploadConfig =
           ParallelUploadConfig.newBuilder()
               .setBucketName(bucketName)
               .build();

 UploadJob uploadedFiles = transferManager.uploadFiles(files, config);

 

Parameters
Name	Description
files	List<Path>
config	ParallelUploadConfig

Returns
Type	Description
@org.checkerframework.checker.nullness.qual.NonNull com.google.cloud.storage.transfermanager.UploadJob	an UploadJob

Exceptions
Type	Description
IOException