com.obs.services.model.fs

Class DropFolderRequest

java.lang.Object

com.obs.services.model.GenericRequest

com.obs.services.model.AbstractBulkRequest

com.obs.services.model.fs.DropFolderRequest

public class DropFolderRequest
extends AbstractBulkRequest

Request parameters for deleting folders. Deleting a folder will delete all sub-folders and files in the folder. This function does not support buckets with versioning enabled.

Field Summary

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

listener, taskProgressInterval, taskQueueNum, taskThreadNum

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

bucketName, httpMethod, userHeaders

Constructor Summary

Constructors

Constructor and Description
DropFolderRequest()
DropFolderRequest(String bucketName) Constructor
DropFolderRequest(String bucketName, String folderName)
DropFolderRequest(String bucketName, String folderName, String encodingType) Constructor

Method Summary

Modifier and Type	Method and Description
TaskCallback<DeleteObjectResult,String>	getCallback() Obtain the callback object of a batch task.
String	getEncodingType() Obtain the list of to-be-deleted objects.
String	getFolderName() Obtain the folder name.
void	setCallback(TaskCallback<DeleteObjectResult,String> callback) Set the callback object of a batch task.
void	setEncodingType(String encodingType) Set the encoding type that used for encode objectkey
void	setFolderName(String folderName) Set the folder name.
String	toString()

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

getProgressInterval, getProgressListener, getTaskQueueNum, getTaskThreadNum, setProgressInterval, setProgressListener, setTaskQueueNum, setTaskThreadNum

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

DropFolderRequest

public DropFolderRequest()

DropFolderRequest

public DropFolderRequest(String bucketName)

Constructor

Parameters:

bucketName - Bucket name

DropFolderRequest

public DropFolderRequest(String bucketName,
                         String folderName)

DropFolderRequest

public DropFolderRequest(String bucketName,
                         String folderName,
                         String encodingType)

Constructor

Parameters:

bucketName - Bucket name

encodingType - The encoding type use for encode objectKey.

Method Detail

getFolderName

public String getFolderName()

Obtain the folder name.

Returns:

Folder name

setFolderName

public void setFolderName(String folderName)

Set the folder name.

Parameters:

folderName - Folder name

getCallback

public TaskCallback<DeleteObjectResult,String> getCallback()

Obtain the callback object of a batch task.

Returns:

Callback object

setCallback

public void setCallback(TaskCallback<DeleteObjectResult,String> callback)

Set the callback object of a batch task.

Parameters:

callback - Callback object

setEncodingType

public void setEncodingType(String encodingType)

Set the encoding type that used for encode objectkey

Parameters:

encodingType - could chose url.

getEncodingType

public String getEncodingType()

Obtain the list of to-be-deleted objects.

Returns:

List of to-be-deleted objects

toString

public String toString()

Overrides:

toString in class GenericRequest