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

Parameters in a file upload request

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) Constructor
UploadFileRequest(String bucketName, String objectKey, String uploadFile) Constructor
UploadFileRequest(String bucketName, String objectKey, String uploadFile, long partSize) Constructor
UploadFileRequest(String bucketName, String objectKey, String uploadFile, long partSize, int taskNum) Constructor
UploadFileRequest(String bucketName, String objectKey, String uploadFile, long partSize, int taskNum, boolean enableCheckpoint) Constructor
UploadFileRequest(String bucketName, String objectKey, String uploadFile, long partSize, int taskNum, boolean enableCheckpoint, String checkpointFile) Constructor
UploadFileRequest(String bucketName, String objectKey, String uploadFile, long partSize, int taskNum, boolean enableCheckpoint, String checkpointFile, boolean enableCheckSum) Constructor
UploadFileRequest(String bucketName, String objectKey, String uploadFile, String encodingType) Constructor

Method Summary

Modifier and Type	Method and Description
String	getCheckpointFile() Obtain the file used to record resumable upload progresses.
String	getEncodingType() Get encoding type for encoding objectKey
ObjectMetadata	getObjectMetadata() Obtain object properties.
long	getPartSize() Obtain the part size set for uploading the object.
long	getProgressInterval() Obtain the callback threshold of the data transfer listener.
ProgressListener	getProgressListener() Obtain the data transfer listener.
int	getTaskNum() Obtain the maximum number of threads used for processing upload tasks concurrently.
String	getUploadFile() Obtain the to-be-uploaded local file.
boolean	isEnableCheckpoint() Identify whether the resumable mode is enabled.
boolean	isEnableCheckSum() Identify whether the file to be uploaded in resumable mode will be verified.
void	setCheckpointFile(String checkpointFile) Specify a file used to record resumable upload progresses.
void	setEnableCheckpoint(boolean enableCheckpoint) Specify whether to enable the resumable mode.
void	setEnableCheckSum(boolean enableCheckSum) Specify whether to verify the file to be uploaded in resumable mode.
void	setEncodingType(String encodingType) Set encoding type for encoding objectKey, could choose "url"
void	setObjectMetadata(ObjectMetadata objectMetadata) Set object properties.
void	setPartSize(long partSize) Set the part size for uploading the object.
void	setProgressInterval(long progressInterval) Set the callback threshold of the data transfer listener.
void	setProgressListener(ProgressListener progressListener) Set the data transfer listener.
void	setTaskNum(int taskNum) Set the maximum number of threads used for executing upload tasks concurrently.
void	setUploadFile(String uploadFile) Specify the local file to be uploaded.
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)

Constructor

Parameters:

bucketName - Bucket name

objectKey - Object name

UploadFileRequest

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

Constructor

Parameters:

bucketName - Bucket name

objectKey - Object name

uploadFile - To-be-uploaded local file

UploadFileRequest

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

Constructor

Parameters:

bucketName - Bucket name

objectKey - Object name

uploadFile - To-be-uploaded local file

encodingType - Encoding type used for encoding objectKey

UploadFileRequest

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

Constructor

Parameters:

bucketName - Bucket name

objectKey - Object name

uploadFile - To-be-uploaded local file

partSize - Part size

UploadFileRequest

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

Constructor

Parameters:

bucketName - Bucket name

objectKey - Object name

uploadFile - To-be-uploaded local file

partSize - Part size

taskNum - Maximum number of threads used for processing upload tasks concurrently

UploadFileRequest

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

Constructor

Parameters:

bucketName - Bucket name

objectKey - Object name

uploadFile - To-be-uploaded local file

partSize - Part size

taskNum - Maximum number of threads used for processing upload tasks concurrently

enableCheckpoint - Whether to enable the resumable mode

UploadFileRequest

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

Constructor

Parameters:

bucketName - Bucket name

objectKey - Object name

uploadFile - To-be-uploaded local file

partSize - Part size

taskNum - Maximum number of threads used for processing upload tasks concurrently

enableCheckpoint - Whether to enable the resumable mode

checkpointFile - File used to record resumable upload progresses

UploadFileRequest

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

Constructor

Parameters:

bucketName - Bucket name

objectKey - Object name

uploadFile - To-be-uploaded local file

partSize - Part size

taskNum - Maximum number of threads used for processing upload tasks concurrently

enableCheckpoint - Whether to enable the resumable mode

checkpointFile - File used to record resumable upload progresses

enableCheckSum - Whether to verify the to-be-uploaded file upon non-initial uploads in resumable upload mode

Method Detail

getPartSize

public long getPartSize()

Obtain the part size set for uploading the object.

Returns:

Part size

setPartSize

public void setPartSize(long partSize)

Set the part size for uploading the object.

Parameters:

partSize - Part size

getTaskNum

public int getTaskNum()

Obtain the maximum number of threads used for processing upload tasks concurrently.

Returns:

Maximum number of threads used for processing upload tasks concurrently

setTaskNum

public void setTaskNum(int taskNum)

Set the maximum number of threads used for executing upload tasks concurrently.

Parameters:

taskNum - Maximum number of threads used for processing upload tasks concurrently

getUploadFile

public String getUploadFile()

Obtain the to-be-uploaded local file.

Returns:

To-be-uploaded local file

setUploadFile

public void setUploadFile(String uploadFile)

Specify the local file to be uploaded.

Parameters:

uploadFile - To-be-uploaded local file

isEnableCheckpoint

public boolean isEnableCheckpoint()

Identify whether the resumable mode is enabled.

Returns:

Identifier specifying whether the resumable mode is enabled

setEnableCheckpoint

public void setEnableCheckpoint(boolean enableCheckpoint)

Specify whether to enable the resumable mode.

Parameters:

enableCheckpoint - Identifier specifying whether the resumable mode is enabled

getCheckpointFile

public String getCheckpointFile()

Obtain the file used to record resumable upload progresses.

Returns:

File used to record upload progresses

setCheckpointFile

public void setCheckpointFile(String checkpointFile)

Specify a file used to record resumable upload progresses.

Parameters:

checkpointFile - File used to record upload progresses

getObjectMetadata

public ObjectMetadata getObjectMetadata()

Obtain object properties.

Returns:

Object properties

setObjectMetadata

public void setObjectMetadata(ObjectMetadata objectMetadata)

Set object properties.

Parameters:

objectMetadata - Object properties

isEnableCheckSum

public boolean isEnableCheckSum()

Identify whether the file to be uploaded in resumable mode will be verified.

Returns:

Identifier specifying whether to verify the to-be-uploaded file

setEnableCheckSum

public void setEnableCheckSum(boolean enableCheckSum)

Specify whether to verify the file to be uploaded in resumable mode.

Parameters:

enableCheckSum - Identifier specifying whether to verify the to-be-uploaded file

getProgressListener

public ProgressListener getProgressListener()

Obtain the data transfer listener.

Returns:

Data transfer listener

setProgressListener

public void setProgressListener(ProgressListener progressListener)

Set the data transfer listener.

Parameters:

progressListener - Data transfer listener

getProgressInterval

public long getProgressInterval()

Obtain the callback threshold of the data transfer listener. The default value is 100 KB.

Returns:

Callback threshold of the data transfer listener

setProgressInterval

public void setProgressInterval(long progressInterval)

Set the callback threshold of the data transfer listener. The default value is 100 KB.

Parameters:

progressInterval - Callback threshold of the data transfer listener

setEncodingType

public void setEncodingType(String encodingType)

Set encoding type for encoding objectKey, could choose "url"

Parameters:

encodingType - encoding type for encoding objectKey

getEncodingType

public String getEncodingType()

Get encoding type for encoding objectKey

Returns:

encodingType

toString

public String toString()

Overrides:

toString in class BaseObjectRequest