com.obs.services.model

Class DownloadFileRequest

java.lang.Object

com.obs.services.model.GenericRequest

com.obs.services.model.DownloadFileRequest

public class DownloadFileRequest
extends GenericRequest

下载文件的请求参数

Constructor Summary

Constructors

Constructor and Description
DownloadFileRequest(String bucketName, String objectKey) 构造参数
DownloadFileRequest(String bucketName, String objectKey, String downloadFile) 构造参数
DownloadFileRequest(String bucketName, String objectKey, String downloadFile, long partSize) 构造参数
DownloadFileRequest(String bucketName, String objectKey, String downloadFile, long partSize, int taskNum) 构造参数
DownloadFileRequest(String bucketName, String objectKey, String downloadFile, long partSize, int taskNum, boolean enableCheckpoint) 构造参数
DownloadFileRequest(String bucketName, String objectKey, String downloadFile, long partSize, int taskNum, boolean enableCheckpoint, String checkpointFile) 构造参数
DownloadFileRequest(String bucketName, String objectKey, String downloadFile, long partSize, int taskNum, boolean enableCheckpoint, String checkpointFile, String versionId) 构造参数

Method Summary

Modifier and Type	Method and Description
String	getBucketName() 获取桶名
CacheOptionEnum	getCacheOption() 获取预读缓存的控制选项
String	getCheckpointFile() 获取断点续传模式下，记录下载进度的文件
String	getDownloadFile() 获取下载文件的目标路径
String	getIfMatchTag() 获取下载对象的校验值条件（相等则下载），如果对象的etag校验值与此参数指定的值相等则进行下载。否则返回412（前置条件不满足）
Date	getIfModifiedSince() 获取下载对象的时间条件（修改则下载），如果对象在此参数指定的时间之后有修改则进行下载，否则返回304（Not Modified）
String	getIfNoneMatchTag() 获取下载对象的校验值条件（不相等则下载），如果对象的etag校验值与此参数指定的值不相等则进行下载。否则返回304（Not Modified）
Date	getIfUnmodifiedSince() 获取下载对象的时间条件（未修改则下载），如果对象在此参数指定的时间之后没有修改则进行下载，否则返回412（ 前置条件不满足）
String	getObjectKey() 获取对象名
long	getPartSize() 获取下载时的分段大小
long	getProgressInterval() 获取数据传输监听器回调的阈值，默认为100KB
ProgressListener	getProgressListener() 获取数据传输监听器
int	getTaskNum() 获取用于并发执行下载任务的最大线程数
String	getTempDownloadFile() 获取下载时的临时文件
long	getTtl() 获取缓存数据过期时间
String	getVersionId() 获取对象的版本号
boolean	isEnableCheckpoint() 判断是否开启断点续传模式
void	setBucketName(String bucketName) 设置桶名
void	setCacheOption(CacheOptionEnum cacheOption) 设置预读缓存的控制选项
void	setCheckpointFile(String checkpointFile) 设置断点续传模式下，记录下载进度的文件
void	setDownloadFile(String downloadFile) 设置下载文件的目标路径
void	setEnableCheckpoint(boolean enableCheckpoint) 设置是否开启断点续传模式
void	setIfMatchTag(String ifMatchTag) 设置下载对象的校验值条件（相等则下载），如果对象的etag校验值与此参数指定的值相等则进行下载。否则返回412（前置条件不满足）
void	setIfModifiedSince(Date ifModifiedSince) 设置下载对象的时间条件（修改则下载），如果对象在此参数指定的时间之后有修改则进行下载，否则返回304（Not Modified）
void	setIfNoneMatchTag(String ifNoneMatchTag) 设置下载对象的校验值条件（不相等则下载），如果对象的etag校验值与此参数指定的值不相等则进行下载。否则返回304（Not Modified）
void	setIfUnmodifiedSince(Date ifUnmodifiedSince) 设置下载对象的时间条件（未修改则下载），如果对象在此参数指定的时间之后没有修改则进行下载，否则返回412（ 前置条件不满足）
void	setObjectKey(String objectKey) 设置对象名
void	setPartSize(long partSize) 设置下载时的分段大小
void	setProgressInterval(long progressInterval) 设置数据传输监听器回调的阈值，默认为100KB
void	setProgressListener(ProgressListener progressListener) 设置数据传输监听器
void	setTaskNum(int taskNum) 设置用于并发执行下载任务的最大线程数
void	setTtl(long ttl) 设置缓存数据过期时间
void	setVersionId(String versionId) 设置对象的版本号
String	toString()

Methods inherited from class com.obs.services.model.GenericRequest

isRequesterPays, setRequesterPays

Methods inherited from class java.lang.Object

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

Constructor Detail

DownloadFileRequest

public DownloadFileRequest(String bucketName,
                           String objectKey)

构造参数

Parameters:

bucketName - 桶名

objectKey - 对象名

DownloadFileRequest

public DownloadFileRequest(String bucketName,
                           String objectKey,
                           String downloadFile)

构造参数

Parameters:

bucketName - 桶名

objectKey - 对象名

downloadFile - 下载文件的目标路径

DownloadFileRequest

public DownloadFileRequest(String bucketName,
                           String objectKey,
                           String downloadFile,
                           long partSize)

构造参数

Parameters:

bucketName - 桶名

objectKey - 对象名

downloadFile - 下载文件的目标路径

partSize - 下载时的分段大小

DownloadFileRequest

public DownloadFileRequest(String bucketName,
                           String objectKey,
                           String downloadFile,
                           long partSize,
                           int taskNum)

构造参数

Parameters:

bucketName - 桶名

objectKey - 对象名

downloadFile - 下载文件的目标路径

partSize - 下载时的分段大小

taskNum - 用于并发执行下载任务的最大线程数

DownloadFileRequest

public DownloadFileRequest(String bucketName,
                           String objectKey,
                           String downloadFile,
                           long partSize,
                           int taskNum,
                           boolean enableCheckpoint)

构造参数

Parameters:

bucketName - 桶名

objectKey - 对象名

downloadFile - 下载文件的目标路径

partSize - 下载时的分段大小

taskNum - 用于并发执行下载任务的最大线程数

enableCheckpoint - 是否开启断点续传模式

DownloadFileRequest

public DownloadFileRequest(String bucketName,
                           String objectKey,
                           String downloadFile,
                           long partSize,
                           int taskNum,
                           boolean enableCheckpoint,
                           String checkpointFile)

构造参数

Parameters:

bucketName - 桶名

objectKey - 对象名

downloadFile - 下载文件的目标路径

partSize - 下载时的分段大小

taskNum - 用于并发执行下载任务的最大线程数

enableCheckpoint - 是否开启断点续传模式

checkpointFile - 断点续传模式下，记录下载进度的文件

DownloadFileRequest

public DownloadFileRequest(String bucketName,
                           String objectKey,
                           String downloadFile,
                           long partSize,
                           int taskNum,
                           boolean enableCheckpoint,
                           String checkpointFile,
                           String versionId)

构造参数

Parameters:

bucketName - 桶名

objectKey - 对象名

downloadFile - 下载文件的目标路径

partSize - 下载时的分段大小

taskNum - 用于并发执行下载任务的最大线程数

enableCheckpoint - 是否开启断点续传模式

checkpointFile - 断点续传模式下，记录下载进度的文件

versionId - 对象的版本号

Method Detail

getBucketName

public String getBucketName()

获取桶名

Returns:

桶名

setBucketName

public void setBucketName(String bucketName)

设置桶名

Parameters:

bucketName - 桶名

getObjectKey

public String getObjectKey()

获取对象名

Returns:

对象名

setObjectKey

public void setObjectKey(String objectKey)

设置对象名

Parameters:

objectKey - 对象名

getDownloadFile

public String getDownloadFile()

获取下载文件的目标路径

Returns:

下载文件的目标路径

setDownloadFile

public void setDownloadFile(String downloadFile)

设置下载文件的目标路径

Parameters:

downloadFile - 下载文件的目标路径

getPartSize

public long getPartSize()

获取下载时的分段大小

Returns:

下载时的分段大小

setPartSize

public void setPartSize(long partSize)

设置下载时的分段大小

Parameters:

partSize - 下载时的分段大小

getTaskNum

public int getTaskNum()

获取用于并发执行下载任务的最大线程数

Returns:

用于并发执行下载任务的最大线程数

setTaskNum

public void setTaskNum(int taskNum)

设置用于并发执行下载任务的最大线程数

Parameters:

taskNum - 用于并发执行下载任务的最大线程数

isEnableCheckpoint

public boolean isEnableCheckpoint()

判断是否开启断点续传模式

Returns:

是否开启断点续传模式标识

setEnableCheckpoint

public void setEnableCheckpoint(boolean enableCheckpoint)

设置是否开启断点续传模式

Parameters:

enableCheckpoint - 是否开启断点续传模式标识

getCheckpointFile

public String getCheckpointFile()

获取断点续传模式下，记录下载进度的文件

Returns:

记录下载进度的文件

setCheckpointFile

public void setCheckpointFile(String checkpointFile)

设置断点续传模式下，记录下载进度的文件

Parameters:

checkpointFile - 记录下载进度的文件

getTempDownloadFile

public String getTempDownloadFile()

获取下载时的临时文件

Returns:

下载时的临时文件

getIfModifiedSince

public Date getIfModifiedSince()

获取下载对象的时间条件（修改则下载），如果对象在此参数指定的时间之后有修改则进行下载，否则返回304（Not Modified）

Returns:

下载对象的时间条件

setIfModifiedSince

public void setIfModifiedSince(Date ifModifiedSince)

设置下载对象的时间条件（修改则下载），如果对象在此参数指定的时间之后有修改则进行下载，否则返回304（Not Modified）

Parameters:

ifModifiedSince - 下载对象的时间条件

getIfUnmodifiedSince

public Date getIfUnmodifiedSince()

获取下载对象的时间条件（未修改则下载），如果对象在此参数指定的时间之后没有修改则进行下载，否则返回412（ 前置条件不满足）

Returns:

下载对象的时间条件

setIfUnmodifiedSince

public void setIfUnmodifiedSince(Date ifUnmodifiedSince)

设置下载对象的时间条件（未修改则下载），如果对象在此参数指定的时间之后没有修改则进行下载，否则返回412（ 前置条件不满足）

Parameters:

ifUnmodifiedSince - 下载对象的时间条件

getIfMatchTag

public String getIfMatchTag()

获取下载对象的校验值条件（相等则下载），如果对象的etag校验值与此参数指定的值相等则进行下载。否则返回412（前置条件不满足）

Returns:

下载对象的校验值条件

setIfMatchTag

public void setIfMatchTag(String ifMatchTag)

设置下载对象的校验值条件（相等则下载），如果对象的etag校验值与此参数指定的值相等则进行下载。否则返回412（前置条件不满足）

Parameters:

ifMatchTag - 下载对象的校验值条件

getIfNoneMatchTag

public String getIfNoneMatchTag()

获取下载对象的校验值条件（不相等则下载），如果对象的etag校验值与此参数指定的值不相等则进行下载。否则返回304（Not Modified）

Returns:

下载对象的校验值条件

setIfNoneMatchTag

public void setIfNoneMatchTag(String ifNoneMatchTag)

设置下载对象的校验值条件（不相等则下载），如果对象的etag校验值与此参数指定的值不相等则进行下载。否则返回304（Not Modified）

Parameters:

ifNoneMatchTag - 下载对象的校验值条件

getVersionId

public String getVersionId()

获取对象的版本号

Returns:

对象的版本号

setVersionId

public void setVersionId(String versionId)

设置对象的版本号

Parameters:

versionId - 对象的版本号

getProgressListener

public ProgressListener getProgressListener()

获取数据传输监听器

Returns:

数据传输监听器

setProgressListener

public void setProgressListener(ProgressListener progressListener)

设置数据传输监听器

Parameters:

progressListener - 数据传输监听器

getProgressInterval

public long getProgressInterval()

获取数据传输监听器回调的阈值，默认为100KB

Returns:

数据传输监听器回调的阈值

setProgressInterval

public void setProgressInterval(long progressInterval)

设置数据传输监听器回调的阈值，默认为100KB

Parameters:

progressInterval - 数据传输监听器回调的阈值

getCacheOption

public CacheOptionEnum getCacheOption()

获取预读缓存的控制选项

Returns:

预读缓存的控制选项

setCacheOption

public void setCacheOption(CacheOptionEnum cacheOption)

设置预读缓存的控制选项

Parameters:

cacheOption - 预读缓存的控制选项

getTtl

public long getTtl()

获取缓存数据过期时间

Returns:

缓存数据过期时间

setTtl

public void setTtl(long ttl)

设置缓存数据过期时间

Parameters:

ttl - 缓存数据过期时间

toString

public String toString()

Overrides:

toString in class GenericRequest