com.ibm.cloud.objectstorage.services.s3.model

Class PresignedUrlDownloadConfig

java.lang.Object

com.ibm.cloud.objectstorage.services.s3.model.PresignedUrlDownloadConfig

public final class PresignedUrlDownloadConfig
extends Object

Configuration options that can be used to control the download behavior in TransferManager when using presigned urls

Constructor Summary

Constructors

Constructor and Description
PresignedUrlDownloadConfig()

Method Summary

Modifier and Type	Method and Description
long	getDownloadSizePerRequest()
S3ProgressListener	getS3progressListener()
long	getTimeoutMillis()
boolean	isResumeOnRetry()
void	setDownloadSizePerRequest(long downloadSizePerRequest)
void	setResumeOnRetry(boolean resumeOnRetry)
void	setS3progressListener(S3ProgressListener s3progressListener)
void	setTimeoutMillis(long timeoutMillis) Sets the timeout, in milliseconds, for waiting for this download to complete.
PresignedUrlDownloadConfig	withDownloadSizePerRequest(long downloadSizePerRequest)
PresignedUrlDownloadConfig	withResumeOnRetry(boolean resumeOnRetry)
PresignedUrlDownloadConfig	withS3progressListener(S3ProgressListener s3progressListener)
PresignedUrlDownloadConfig	withTimeoutMillis(long timeoutMillis) Sets the timeout, in milliseconds, for waiting for this download to complete.

Methods inherited from class java.lang.Object

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

Constructor Detail

PresignedUrlDownloadConfig

public PresignedUrlDownloadConfig()

Method Detail

getS3progressListener

public S3ProgressListener getS3progressListener()

Returns:

the optional callback listener to get the progress of the download

setS3progressListener

public void setS3progressListener(S3ProgressListener s3progressListener)

Parameters:

s3progressListener - sets optional callback listener to get the progress of the download.

withS3progressListener

public PresignedUrlDownloadConfig withS3progressListener(S3ProgressListener s3progressListener)

Parameters:

s3progressListener - sets optional callback listener to get the progress of the download.

Returns:

This object for method chaining

getTimeoutMillis

public long getTimeoutMillis()

Returns:

Timeout, in milliseconds, for waiting for this download to complete.

setTimeoutMillis

public void setTimeoutMillis(long timeoutMillis)

Sets the timeout, in milliseconds, for waiting for this download to complete. Note that the timeout time will be approximate and is not strictly guaranteed. As a result this timeout should not be relied on in cases where exact precision is required.

Parameters:

timeoutMillis - Timeout, in milliseconds, for waiting for this download to complete.

withTimeoutMillis

public PresignedUrlDownloadConfig withTimeoutMillis(long timeoutMillis)

Sets the timeout, in milliseconds, for waiting for this download to complete. Note that the timeout time will be approximate and is not strictly guaranteed. As a result this timeout should not be relied on in cases where exact precision is required.

Parameters:

timeoutMillis - Timeout, in milliseconds, for waiting for this download to complete.

Returns:

This object for method chaining

getDownloadSizePerRequest

public long getDownloadSizePerRequest()

Returns:

the size of each request while downloading object in parallel

setDownloadSizePerRequest

public void setDownloadSizePerRequest(long downloadSizePerRequest)

Parameters:

downloadSizePerRequest - sets the size of each request while downloading object in parallel. The default value is 5 MB

withDownloadSizePerRequest

public PresignedUrlDownloadConfig withDownloadSizePerRequest(long downloadSizePerRequest)

Parameters:

downloadSizePerRequest - sets the size of each request while downloading object in parallel. The default value is 5 MB

Returns:

This object for method chaining

isResumeOnRetry

public boolean isResumeOnRetry()

Returns:

a boolean value indicating if a failed download should be resumed upon an immediate retry. The default value is false.

setResumeOnRetry

public void setResumeOnRetry(boolean resumeOnRetry)

Parameters:

resumeOnRetry - If set to true, upon an immediate retry of a failed object download, the TransferManager will resume the download from the current end of the file on disk. This is a one-time retry mechanism that is different from the default retries provided by sdk.

The default value is false.

Note: This value is only valid for serial downloads and one of the following conditions is true: 1) Download range is set on the request 2) TransferManager is able to find the content-length of the object using presigned url

withResumeOnRetry

public PresignedUrlDownloadConfig withResumeOnRetry(boolean resumeOnRetry)

Parameters:

resumeOnRetry - If set to true, upon an immediate retry of a failed object download, the TransferManager will resume the download from the current end of the file on disk. This is a one-time retry mechanism that is different from the default retries provided by sdk.

The default value is false.

Note: This value is only valid for serial downloads and one of the following conditions is true: 1) Download range is set on the request 2) TransferManager is able to find the content-length of the object using presigned url

Returns:

This object for method chaining