com.obs.services.model

Class UploadFileRequest

java.lang.Object

com.obs.services.model.GenericRequest

com.obs.services.model.BaseObjectRequest

com.obs.services.model.PutObjectBasicRequest

com.obs.services.model.UploadFileRequest

public class UploadFileRequest
extends PutObjectBasicRequest

上传文件的请求参数

Field Summary

Fields inherited from class com.obs.services.model.PutObjectBasicRequest

acl, extensionPermissionMap, sseCHeader, sseKmsHeader, successRedirectLocation

Fields inherited from class com.obs.services.model.BaseObjectRequest

encodeHeaders, objectKey

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

bucketName, httpMethod, userHeaders

Constructor Summary

Constructors

Constructor and Description
UploadFileRequest(String bucketName, String objectKey) 构造函数
UploadFileRequest(String bucketName, String objectKey, String uploadFile) 构造函数
UploadFileRequest(String bucketName, String objectKey, String uploadFile, long partSize) 构造函数
UploadFileRequest(String bucketName, String objectKey, String uploadFile, long partSize, int taskNum) 构造函数
UploadFileRequest(String bucketName, String objectKey, String uploadFile, long partSize, int taskNum, boolean enableCheckpoint) 构造函数
UploadFileRequest(String bucketName, String objectKey, String uploadFile, long partSize, int taskNum, boolean enableCheckpoint, String checkpointFile) 构造函数
UploadFileRequest(String bucketName, String objectKey, String uploadFile, long partSize, int taskNum, boolean enableCheckpoint, String checkpointFile, boolean enableCheckSum) 构造函数
UploadFileRequest(String bucketName, String objectKey, String uploadFile, String encodingType) 构造函数

Method Summary

Modifier and Type	Method and Description
String	getCheckpointFile() 获取断点续传模式下，记录上传进度的文件
String	getEncodingType() 获取对象名 objectKey 的编码方式
ObjectMetadata	getObjectMetadata() 获取对象的属性
long	getPartSize() 获取上传时的分段大小
long	getProgressInterval() 获取数据传输监听器回调的阈值，默认为100KB
ProgressListener	getProgressListener() 获取数据传输监听器
int	getTaskNum() 获取用于并发执行上传任务的最大线程数
String	getUploadFile() 获取待上传的本地文件
boolean	isEnableCheckpoint() 判断是否开启断点续传模式
boolean	isEnableCheckSum() 判断断点续传模式下，是否校验待上传文件的内容
void	setCheckpointFile(String checkpointFile) 设置断点续传模式下，记录上传进度的文件
void	setEnableCheckpoint(boolean enableCheckpoint) 设置是否开启断点续传模式
void	setEnableCheckSum(boolean enableCheckSum) 设置断点续传模式下，是否校验待上传文件的内容
void	setEncodingType(String encodingType) 设置对象名 objectKey 的编码方式，可选 url
void	setObjectMetadata(ObjectMetadata objectMetadata) 设置对象的属性
void	setPartSize(long partSize) 设置上传时的分段大小
void	setProgressInterval(long progressInterval) 设置数据传输监听器回调的阈值，默认为100KB
void	setProgressListener(ProgressListener progressListener) 设置数据传输监听器
void	setTaskNum(int taskNum) 设置用于并发执行上传任务的最大线程数
void	setUploadFile(String uploadFile) 设置待上传的本地文件
String	toString()

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

getAcl, getAllGrantPermissions, getDomainIdsByGrantPermission, getExtensionPermissionMap, getGrantPermissionsByDomainId, getSseCHeader, getSseKmsHeader, getSuccessRedirectLocation, grantExtensionPermission, setAcl, setExtensionPermissionMap, setSseCHeader, setSseKmsHeader, setSuccessRedirectLocation, withdrawExtensionPermission, withdrawExtensionPermissions

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

getObjectKey, isEncodeHeaders, setIsEncodeHeaders, setObjectKey

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

addUserHeaders, getBucketName, getHttpMethod, getUserHeaders, isRequesterPays, setBucketName, setRequesterPays, setUserHeaders

Methods inherited from class java.lang.Object

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

Constructor Detail

UploadFileRequest

public UploadFileRequest(String bucketName,
                         String objectKey)

构造函数

Parameters:

bucketName - 桶名

objectKey - 对象名

UploadFileRequest

public UploadFileRequest(String bucketName,
                         String objectKey,
                         String uploadFile)

构造函数

Parameters:

bucketName - 桶名

objectKey - 对象名

uploadFile - 待上传的本地文件

UploadFileRequest

public UploadFileRequest(String bucketName,
                         String objectKey,
                         String uploadFile,
                         String encodingType)

构造函数

Parameters:

bucketName - 桶名

objectKey - 对象名

uploadFile - 待上传的本地文件

encodingType - 对响应中的 Key 进行指定类型的编码。如果 Key 包含 xml 1.0标准不支持的控制字符， 可通过设置 encoding-type 对响应中的Key进行编码，可选值 "url"

UploadFileRequest

public UploadFileRequest(String bucketName,
                         String objectKey,
                         String uploadFile,
                         long partSize)

构造函数

Parameters:

bucketName - 桶名

objectKey - 对象名

uploadFile - 待上传的本地文件

partSize - 上传时的分段大小

UploadFileRequest

public UploadFileRequest(String bucketName,
                         String objectKey,
                         String uploadFile,
                         long partSize,
                         int taskNum)

构造函数

Parameters:

bucketName - 桶名

objectKey - 对象名

uploadFile - 待上传的本地文件

partSize - 上传时的分段大小

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

UploadFileRequest

public UploadFileRequest(String bucketName,
                         String objectKey,
                         String uploadFile,
                         long partSize,
                         int taskNum,
                         boolean enableCheckpoint)

构造函数

Parameters:

bucketName - 桶名

objectKey - 对象名

uploadFile - 待上传的本地文件

partSize - 上传时的分段大小

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

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

UploadFileRequest

public UploadFileRequest(String bucketName,
                         String objectKey,
                         String uploadFile,
                         long partSize,
                         int taskNum,
                         boolean enableCheckpoint,
                         String checkpointFile)

构造函数

Parameters:

bucketName - 桶名

objectKey - 对象名

uploadFile - 待上传的本地文件

partSize - 上传时的分段大小

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

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

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

UploadFileRequest

public UploadFileRequest(String bucketName,
                         String objectKey,
                         String uploadFile,
                         long partSize,
                         int taskNum,
                         boolean enableCheckpoint,
                         String checkpointFile,
                         boolean enableCheckSum)

构造函数

Parameters:

bucketName - 桶名

objectKey - 对象名

uploadFile - 需上传的本地文件

partSize - 上传时的分段大小

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

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

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

enableCheckSum - 断点续传模式下，非首次上传时是否校验待上传文件的内容

Method Detail

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 - 用于并发执行上传任务的最大线程数

getUploadFile

public String getUploadFile()

获取待上传的本地文件

Returns:

待上传的本地文件

setUploadFile

public void setUploadFile(String uploadFile)

设置待上传的本地文件

Parameters:

uploadFile - 待上传的本地文件

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 - 记录上传进度的文件

getObjectMetadata

public ObjectMetadata getObjectMetadata()

获取对象的属性

Returns:

对象的属性

setObjectMetadata

public void setObjectMetadata(ObjectMetadata objectMetadata)

设置对象的属性

Parameters:

objectMetadata - 对象的属性

isEnableCheckSum

public boolean isEnableCheckSum()

判断断点续传模式下，是否校验待上传文件的内容

Returns:

是否校验待上传文件的内容标识

setEnableCheckSum

public void setEnableCheckSum(boolean enableCheckSum)

设置断点续传模式下，是否校验待上传文件的内容

Parameters:

enableCheckSum - 是否校验待上传文件的内容标识

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 - 数据传输监听器回调的阈值

setEncodingType

public void setEncodingType(String encodingType)

设置对象名 objectKey 的编码方式，可选 url

Parameters:

encodingType - 对象名 objectKey 的编码方式

getEncodingType

public String getEncodingType()

获取对象名 objectKey 的编码方式

Returns:

对象名 objectKey 的编码方式

toString

public String toString()

Overrides:

toString in class BaseObjectRequest