TransferManagerBuilder (IBM COS SDK for Java 2.13.6 API)

java.lang.Object
- com.ibm.cloud.objectstorage.services.s3.transfer.TransferManagerBuilder

```
@NotThreadSafe
public final class TransferManagerBuilder
extends Object
```
Fluent builder for TransferManager. Use of the builder is preferred over constructors in the TransferManager class. Note that if no AmazonS3 is provided via TransferManagerBuilder.withS3Client(AmazonS3)} or TransferManagerBuilder.setS3Client(AmazonS3) a default client will be created using DefaultAwsRegionProviderChain and DefaultAWSCredentialsProviderChain.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TransferManager`	`build()` Construct a TransferManager with the default ExecutorService.
`static TransferManager`	`defaultTransferManager()`
`TransferManagerBuilder`	`disableParallelDownloads()` Disables parallel downloads, see `TransferManagerBuilder.setDisableParallelDownloads(Boolean)`
`boolean`	`getAlwaysCalculateMultipartMd5()` Returns true if Transfer Manager should calculate MD5 for multipart uploads.
`ExecutorFactory`	`getExecutorFactory()`
`Long`	`getMinimumUploadPartSize()`
`Long`	`getMultipartCopyPartSize()`
`Long`	`getMultipartCopyThreshold()`
`Long`	`getMultipartUploadThreshold()`
`AmazonS3`	`getS3Client()`
`Boolean`	`isDisableParallelDownloads()` Returns if the parallel downloads are disabled or not.
`Boolean`	`isShutDownThreadPools()`
`void`	`setAlwaysCalculateMultipartMd5(boolean alwaysCalculateMultipartMd5)` Set to true if Transfer Manager should calculate MD5 for multipart uploads.
`void`	`setDisableParallelDownloads(Boolean disableParallelDownloads)` Sets the option to disable parallel downloads.
`void`	`setExecutorFactory(ExecutorFactory executorFactory)` Sets a new `ExecutorFactory` for the builder.
`void`	`setMinimumUploadPartSize(Long minimumUploadPartSize)` Sets the minimum part size for upload parts.
`void`	`setMultipartCopyPartSize(Long multipartCopyPartSize)` Sets the minimum size in bytes of each part when a multi-part copy operation is carried out.
`void`	`setMultipartCopyThreshold(Long multipartCopyThreshold)` Sets the size threshold, in bytes, for when to use multi-part copy.
`void`	`setMultipartUploadThreshold(Long multipartUploadThreshold)` Sets the size threshold, in bytes, for when to use multipart uploads.
`void`	`setS3Client(AmazonS3 s3Client)` Sets the low level client used to make the service calls to Amazon S3.
`void`	`setShutDownThreadPools(Boolean shutDownThreadPools)` By default, when the transfer manager is shut down, the underlying `ExecutorService` is also shut down.
`static TransferManagerBuilder`	`standard()`
`TransferManagerBuilder`	`withAlwaysCalculateMultipartMd5(boolean alwaysCalculateMultipartMd5)` Set to true if Transfer Manager should calculate MD5 for multipart uploads.
`TransferManagerBuilder`	`withDisableParallelDownloads(Boolean disableParallelDownloads)` Sets the option to disable parallel downloads.
`TransferManagerBuilder`	`withExecutorFactory(ExecutorFactory executorFactory)` Sets a new `ExecutorFactory` for the builder.
`TransferManagerBuilder`	`withMinimumUploadPartSize(Long minimumUploadPartSize)` Sets the minimum part size for upload parts.
`TransferManagerBuilder`	`withMultipartCopyPartSize(Long multipartCopyPartSize)` Sets the minimum size in bytes of each part when a multi-part copy operation is carried out.
`TransferManagerBuilder`	`withMultipartCopyThreshold(Long multipartCopyThreshold)` Sets the size threshold, in bytes, for when to use multi-part copy.
`TransferManagerBuilder`	`withMultipartUploadThreshold(Long multipartUploadThreshold)` Sets the size threshold, in bytes, for when to use multipart uploads.
`TransferManagerBuilder`	`withS3Client(AmazonS3 s3Client)` Sets the low level client used to make the service calls to Amazon S3.
`TransferManagerBuilder`	`withShutDownThreadPools(Boolean shutDownThreadPools)` By default, when the transfer manager is shut down, the underlying `ExecutorService` is also shut down.

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

- Method Detail
  - standard
```
public static TransferManagerBuilder standard()
```
    Returns:
    
    Create new instance of builder with all defaults set.
  - defaultTransferManager
```
public static TransferManager defaultTransferManager()
```
    Returns:
    
    Default TransferManager with default configuration. Uses AmazonS3ClientBuilder to create a default AmazonS3 client implementation.
  - getS3Client
```
public final AmazonS3 getS3Client()
```
    Returns:
    
    The low level client currently configured in the builder.
  - setS3Client
```
public final void setS3Client(AmazonS3 s3Client)
```
    Sets the low level client used to make the service calls to Amazon S3. If no client is specified, a default client will be created using DefaultAwsRegionProviderChain and DefaultAWSCredentialsProviderChain.
    
    Parameters:
    
    s3Client - Client implementation to use
  - withS3Client
```
public final TransferManagerBuilder withS3Client(AmazonS3 s3Client)
```
    Sets the low level client used to make the service calls to Amazon S3. If no client is specified, a default client will be created using DefaultAwsRegionProviderChain and DefaultAWSCredentialsProviderChain.
    
    Parameters:
    
    s3Client - Client implementation to use
    
    Returns:
    
    This object for method chaining.
  - getExecutorFactory
```
public final ExecutorFactory getExecutorFactory()
```
    Returns:
    
    The ExecutorFactory currently configured in the builder.
  - setExecutorFactory
```
public final void setExecutorFactory(ExecutorFactory executorFactory)
```
    Sets a new ExecutorFactory for the builder. The factory is invoked for each transfer manager created through the builder.
    
    Parameters:
    
    executorFactory - New executor factory to use.
  - withExecutorFactory
```
public final TransferManagerBuilder withExecutorFactory(ExecutorFactory executorFactory)
```
    Sets a new ExecutorFactory for the builder. The factory is invoked for each transfer manager created through the builder.
    
    Parameters:
    
    executorFactory - New executor factory to use.
    
    Returns:
    
    This object for method chaining.
  - isShutDownThreadPools
```
public final Boolean isShutDownThreadPools()
```
    Returns:
    
    Current configured option on how thread pools should be managed when transfer manager is shut down.
  - setShutDownThreadPools
```
public final void setShutDownThreadPools(Boolean shutDownThreadPools)
```
    By default, when the transfer manager is shut down, the underlying ExecutorService is also shut down. For cases where the same thread pool is reused across different workloads you can set this option to false to disable that behavior.
    
    Parameters:
    
    shutDownThreadPools - True to shut down thread pools on transfer manager shutdown, false otherwise.
  - withShutDownThreadPools
```
public final TransferManagerBuilder withShutDownThreadPools(Boolean shutDownThreadPools)
```
    By default, when the transfer manager is shut down, the underlying ExecutorService is also shut down. For cases where the same thread pool is reused across different workloads you can set this option to false to disable that behavior.
    
    Parameters:
    
    shutDownThreadPools - True to shut down thread pools on transfer manager shutdown, false otherwise.
    
    Returns:
    
    This object for method chaining.
  - getMinimumUploadPartSize
```
public final Long getMinimumUploadPartSize()
```
    Returns:
    
    The minimum upload part size currently configured in the builder.
  - setMinimumUploadPartSize
```
public final void setMinimumUploadPartSize(Long minimumUploadPartSize)
```
    Sets the minimum part size for upload parts. Decreasing the minimum part size will cause multipart uploads to be split into a larger number of smaller parts. Setting this value too low can have a negative effect on transfer speeds since it will cause extra latency and network communication for each part.
    
    Parameters:
    
    minimumUploadPartSize - New minimum threshold for upload part size
  - withMinimumUploadPartSize
```
public final TransferManagerBuilder withMinimumUploadPartSize(Long minimumUploadPartSize)
```
    Sets the minimum part size for upload parts. Decreasing the minimum part size will cause multipart uploads to be split into a larger number of smaller parts. Setting this value too low can have a negative effect on transfer speeds since it will cause extra latency and network communication for each part.
    
    Parameters:
    
    minimumUploadPartSize - New minimum threshold for upload part size
    
    Returns:
    
    This object for method chaining.
  - getMultipartUploadThreshold
```
public final Long getMultipartUploadThreshold()
```
    Returns:
    
    The multipart upload threshold currently configured in the builder.
  - setMultipartUploadThreshold
```
public final void setMultipartUploadThreshold(Long multipartUploadThreshold)
```
    Sets the size threshold, in bytes, for when to use multipart uploads. Uploads over this size will automatically use a multipart upload strategy, while uploads smaller than this threshold will use a single connection to upload the whole object.
    Multipart uploads are easier to recover from and also potentially faster than single part uploads, especially when the upload parts can be uploaded in parallel as with files. Because there is additional network communication, small uploads are still recommended to use a single connection for the upload.
    
    Parameters:
    
    multipartUploadThreshold - Threshold in which multipart uploads will be performed.
  - withMultipartUploadThreshold
```
public final TransferManagerBuilder withMultipartUploadThreshold(Long multipartUploadThreshold)
```
    Sets the size threshold, in bytes, for when to use multipart uploads. Uploads over this size will automatically use a multipart upload strategy, while uploads smaller than this threshold will use a single connection to upload the whole object.
    Multipart uploads are easier to recover from and also potentially faster than single part uploads, especially when the upload parts can be uploaded in parallel as with files. Because there is additional network communication, small uploads are still recommended to use a single connection for the upload.
    
    Parameters:
    
    multipartUploadThreshold - Threshold in which multipart uploads will be performed.
    
    Returns:
    
    This object for method chaining.
  - getMultipartCopyThreshold
```
public final Long getMultipartCopyThreshold()
```
    Returns:
    
    The multipart copy threshold currently configured in the builder.
  - setMultipartCopyThreshold
```
public final void setMultipartCopyThreshold(Long multipartCopyThreshold)
```
    Sets the size threshold, in bytes, for when to use multi-part copy. Copy requests for objects over this size will automatically use a multi-part copy strategy, while copy requests for objects smaller than this threshold will use a single connection to copy the whole object.
    
    Parameters:
    
    multipartCopyThreshold - Threshold in which multipart copies will be performed.
  - withMultipartCopyThreshold
```
public final TransferManagerBuilder withMultipartCopyThreshold(Long multipartCopyThreshold)
```
    Sets the size threshold, in bytes, for when to use multi-part copy. Copy requests for objects over this size will automatically use a multi-part copy strategy, while copy requests for objects smaller than this threshold will use a single connection to copy the whole object.
    
    Parameters:
    
    multipartCopyThreshold - Threshold in which multipart copies will be performed.
    
    Returns:
    
    This object for method chaining.
  - getMultipartCopyPartSize
```
public final Long getMultipartCopyPartSize()
```
    Returns:
    
    The multipart copy part size currently configured in the builder.
  - setMultipartCopyPartSize
```
public final void setMultipartCopyPartSize(Long multipartCopyPartSize)
```
    Sets the minimum size in bytes of each part when a multi-part copy operation is carried out. Decreasing the minimum part size will cause a large number of copy part requests being initiated.
    
    Parameters:
    
    multipartCopyPartSize - New minimum threshold for copy part size
  - withMultipartCopyPartSize
```
public final TransferManagerBuilder withMultipartCopyPartSize(Long multipartCopyPartSize)
```
    Sets the minimum size in bytes of each part when a multi-part copy operation is carried out. Decreasing the minimum part size will cause a large number of copy part requests being initiated.
    
    Parameters:
    
    multipartCopyPartSize - New minimum threshold for copy part size
    
    Returns:
    
    This object for method chaining.
  - isDisableParallelDownloads
```
public Boolean isDisableParallelDownloads()
```
    Returns if the parallel downloads are disabled or not. By default, the value is set to false.
    TransferManager automatically detects and downloads a multipart object in parallel. Setting this option to true will disable parallel downloads.
    
    Disabling parallel downloads might reduce performance for large files.
    
    Returns:
    
    true if parallel downloads are disabled, otherwise false.
  - setDisableParallelDownloads
```
public void setDisableParallelDownloads(Boolean disableParallelDownloads)
```
    Sets the option to disable parallel downloads. By default, the value is set to false.
    TransferManager automatically detects and downloads a multipart object in parallel. Setting this option to true will disable parallel downloads.
    
    Disabling parallel downloads might reduce performance for large files.
    
    Parameters:
    
    disableParallelDownloads - boolean value to disable parallel downloads.
  - withDisableParallelDownloads
```
public TransferManagerBuilder withDisableParallelDownloads(Boolean disableParallelDownloads)
```
    Sets the option to disable parallel downloads. By default, the value is set to false.
    TransferManager automatically detects and downloads a multipart object in parallel. Setting this option to true will disable parallel downloads.
    
    Disabling parallel downloads might reduce performance for large files.
    
    Parameters:
    
    disableParallelDownloads - boolean value to disable parallel downloads.
    
    Returns:
    
    this object for method changing
  - disableParallelDownloads
```
public TransferManagerBuilder disableParallelDownloads()
```
    Disables parallel downloads, see TransferManagerBuilder.setDisableParallelDownloads(Boolean)
    Disabling parallel downloads might reduce performance for large files.
    
    Returns:
    
    This object for method chaining
  - getAlwaysCalculateMultipartMd5
```
public boolean getAlwaysCalculateMultipartMd5()
```
    Returns true if Transfer Manager should calculate MD5 for multipart uploads.
    For instance, if a bucket is enabled for Object Locking, put requests for objects and object parts must contain an MD5 digest. Since Transfer Manager operates on a whole object, the user cannot supply the MD5 digest directly if multipart uploads are in effect.
    Supplying any object locking parameter also instructs Transfer Manager to calculate MD5 for parts. This flag should be used in instances where they are not present.
  - setAlwaysCalculateMultipartMd5
```
public void setAlwaysCalculateMultipartMd5(boolean alwaysCalculateMultipartMd5)
```
    Set to true if Transfer Manager should calculate MD5 for multipart uploads.
    For instance, if a bucket is enabled for Object Locking, put requests for objects and object parts must contain an MD5 digest. Since Transfer Manager operates on a whole object, the user cannot supply the MD5 digest directly if multipart uploads are in effect.
    Supplying any object locking parameter also instructs Transfer Manager to calculate MD5 for parts. This flag should be used in instances where they are not present.
  - withAlwaysCalculateMultipartMd5
```
public TransferManagerBuilder withAlwaysCalculateMultipartMd5(boolean alwaysCalculateMultipartMd5)
```
    Set to true if Transfer Manager should calculate MD5 for multipart uploads.
    For instance, if a bucket is enabled for Object Locking, put requests for objects and object parts must contain an MD5 digest. Since Transfer Manager operates on a whole object, the user cannot supply the MD5 digest directly if multipart uploads are in effect.
    Supplying any object locking parameter also instructs Transfer Manager to calculate MD5 for parts. This flag should be used in instances where they are not present.
  - build
```
public final TransferManager build()
```
    Construct a TransferManager with the default ExecutorService.
    
    Returns:
    
    TransferManager with configured AmazonS3 client.

Class TransferManagerBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

standard

defaultTransferManager

getS3Client

setS3Client

withS3Client

getExecutorFactory

setExecutorFactory

withExecutorFactory

isShutDownThreadPools

setShutDownThreadPools

withShutDownThreadPools

getMinimumUploadPartSize

setMinimumUploadPartSize

withMinimumUploadPartSize

getMultipartUploadThreshold

setMultipartUploadThreshold

withMultipartUploadThreshold

getMultipartCopyThreshold

setMultipartCopyThreshold

withMultipartCopyThreshold

getMultipartCopyPartSize

setMultipartCopyPartSize

withMultipartCopyPartSize

isDisableParallelDownloads

setDisableParallelDownloads

withDisableParallelDownloads

disableParallelDownloads

getAlwaysCalculateMultipartMd5

setAlwaysCalculateMultipartMd5

withAlwaysCalculateMultipartMd5

build