com.obs.services.model

Class RestoreObjectsRequest

java.lang.Object

com.obs.services.model.AbstractBulkRequest

com.obs.services.model.RestoreObjectsRequest

public class RestoreObjectsRequest
extends AbstractBulkRequest

Request parameters of restoring Archive objects in a batch. The "prefix" and "keyAndVersions" parameters cannot be set in the same request. If both parameters are empty, all Archive objects in the bucket are restored.

Field Summary

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

bucketName, listener, taskProgressInterval, taskQueueNum, taskThreadNum

Constructor Summary

Constructors

Constructor and Description
RestoreObjectsRequest()
RestoreObjectsRequest(String bucketName) Constructor
RestoreObjectsRequest(String bucketName, int days, RestoreTierEnum tier) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
KeyAndVersion	addKeyAndVersion(String objectKey) Add an object to be restored.
KeyAndVersion	addKeyAndVersion(String objectKey, String versionId) Add an object to be restored.
TaskCallback<RestoreObjectResult,RestoreObjectRequest>	getCallback() Obtain the callback object of a batch task.
int	getDays() Obtain the retention period of the restored objects.
List<KeyAndVersion>	getKeyAndVersions() Obtain the list of objects to be restored.
String	getPrefix() Obtain the name prefix of the objects to be restored in a batch.
RestoreTierEnum	getRestoreTier() Obtain the restore option.
boolean	isVersionRestored() Obtain whether to restore all versions of Archive objects.
void	setCallback(TaskCallback<RestoreObjectResult,RestoreObjectRequest> callback) Set the callback object of a batch task.
void	setDays(int days) Set the retention period of the restored objects.
void	setKeyAndVersions(List<KeyAndVersion> keyAndVersions) Set the list of objects to be restored.
void	setPrefix(String prefix) Set the name prefix of the objects to be restored in a batch.
void	setRestoreTier(RestoreTierEnum tier) Set the restore option.
void	setVersionRestored(boolean versionRestored) Set whether to restore all versions of Archive objects.
String	toString()

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

RestoreObjectsRequest

public RestoreObjectsRequest()

RestoreObjectsRequest

public RestoreObjectsRequest(String bucketName)

Constructor

Parameters:

bucketName - Bucket name

RestoreObjectsRequest

public RestoreObjectsRequest(String bucketName,
                     int days,
                     RestoreTierEnum tier)

Constructor

Parameters:

bucketName - Bucket name

days - Retention period of the restored objects

tier - Restore option

Method Detail

getDays

public int getDays()

Obtain the retention period of the restored objects. The value ranges from 1 to 30 (in days).

Returns:

Retention period of the restored objects

setDays

public void setDays(int days)

Set the retention period of the restored objects. The value ranges from 1 to 30 (in days).

Parameters:

days - Retention period of the restored objects

getRestoreTier

public RestoreTierEnum getRestoreTier()

Obtain the restore option.

Returns:

Restore option

setRestoreTier

public void setRestoreTier(RestoreTierEnum tier)

Set the restore option.

Parameters:

tier - Restore option

setPrefix

public void setPrefix(String prefix)

Set the name prefix of the objects to be restored in a batch.

Parameters:

prefix - Object name prefix

getPrefix

public String getPrefix()

Obtain the name prefix of the objects to be restored in a batch.

Returns:

Object name prefix

isVersionRestored

public boolean isVersionRestored()

Obtain whether to restore all versions of Archive objects. The default value is "false", indicating that only latest versions of Archive objects are restored.

Returns:

Identifier of version restore

setVersionRestored

public void setVersionRestored(boolean versionRestored)

Set whether to restore all versions of Archive objects.

Parameters:

versionRestored - Identifier of version restore

setKeyAndVersions

public void setKeyAndVersions(List<KeyAndVersion> keyAndVersions)

Set the list of objects to be restored.

Parameters:

keyAndVersions - List of objects to be restored

getKeyAndVersions

public List<KeyAndVersion> getKeyAndVersions()

Obtain the list of objects to be restored.

Returns:

List of objects to be restored

addKeyAndVersion

public KeyAndVersion addKeyAndVersion(String objectKey,
                             String versionId)

Add an object to be restored.

Parameters:

objectKey - Object name

versionId - Object version

Returns:

Object that has been added to be restored

addKeyAndVersion

public KeyAndVersion addKeyAndVersion(String objectKey)

Add an object to be restored.

Parameters:

objectKey - Object name

Returns:

Object that has been added to be restored

getCallback

public TaskCallback<RestoreObjectResult,RestoreObjectRequest> getCallback()

Obtain the callback object of a batch task.

Returns:

Callback object

setCallback

public void setCallback(TaskCallback<RestoreObjectResult,RestoreObjectRequest> callback)

Set the callback object of a batch task.

Parameters:

callback - Callback object

toString

public String toString()

Overrides:

toString in class Object