com.ibm.cloud.objectstorage.services.s3.model

Class RestoreObjectRequest

java.lang.Object

com.ibm.cloud.objectstorage.AmazonWebServiceRequest

com.ibm.cloud.objectstorage.services.s3.model.RestoreObjectRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

public class RestoreObjectRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Request object containing all the options for restoring an object, which was transitioned to the Amazon Glacier from S3 when it was expired.

All RestoreObjectRequest must specify a bucket name and key, along with expiration time.

See Also:

RestoreObjectRequest(String, String, int), RestoreObjectRequest(String, String), Serialized Form

Field Summary

Fields inherited from class com.ibm.cloud.objectstorage.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
RestoreObjectRequest(String bucketName, String key) Constructs a new RestoreObjectRequest.
RestoreObjectRequest(String bucketName, String key, int expirationInDays) Constructs a new RestoreObjectRequest.

Method Summary

Modifier and Type	Method and Description
String	getBucketName() Returns the name of the bucket containing the reference to the object to restore which is now stored in Amazon Glacier.
int	getExpirationInDays() Returns the lifetime of the active copy in days.
GlacierJobParameters	getGlacierJobParameters()
String	getKey() Gets the key, the name of the reference to the object to restore, which is now stored in Amazon Glacier.
String	getVersionId() Returns the id of the version to be restored.
boolean	isRequesterPays() Returns true if the user has enabled Requester Pays option when conducting this operation from Requester Pays Bucket; else false.
void	setBucketName(String bucketName) Sets the name of the bucket containing the reference to the object to restore which is now stored in Amazon Glacier.
void	setExpirationInDays(int expirationInDays) Set the lifetime of the active copy in days.
void	setGlacierJobParameters(GlacierJobParameters glacierJobParameters) Sets Glacier related parameters pertaining to this job.
void	setKey(String key) Sets the key, the name of the reference to the object to restore, which is now stored in Amazon Glacier.
void	setRequesterPays(boolean isRequesterPays) Used for conducting this operation from a Requester Pays Bucket.
void	setVersionId(String versionId) Sets the id of the version to be restored.
RestoreObjectRequest	withBucketName(String bucketName) Sets the name of the bucket containing the reference to the object to restore which is now stored in Amazon Glacier, and returns a reference to this object(RestoreObjectRequest) for method chaining.
RestoreObjectRequest	withExpirationInDays(int expirationInDays) Set the lifetime of the active copy in days.
RestoreObjectRequest	withGlacierJobParameters(GlacierJobParameters glacierJobParameters) Sets Glacier related parameters pertaining to this job.
RestoreObjectRequest	withKey(String key) Sets the key, the name of the reference to the object to restore, which is now stored in Amazon Glacier.
RestoreObjectRequest	withRequesterPays(boolean isRequesterPays) Used for conducting this operation from a Requester Pays Bucket.
RestoreObjectRequest	withVersionId(String versionId) Sets the id of the version to be restored and returns a reference to this object for method chaining.

Methods inherited from class com.ibm.cloud.objectstorage.AmazonWebServiceRequest

addHandlerContext, clone, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

RestoreObjectRequest

public RestoreObjectRequest(String bucketName,
                            String key)

Constructs a new RestoreObjectRequest.

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.

When using this operation using an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon Simple Storage Service Developer Guide.

Parameters:

bucketName - The name of the bucket, or access point ARN, containing the reference to the object to restore which is now stored in Amazon Glacier.

key - The key, the name of the reference to the object to restore, which is now stored in Amazon Glacier.

See Also:

RestoreObjectRequest(String, String, int)

RestoreObjectRequest

public RestoreObjectRequest(String bucketName,
                            String key,
                            int expirationInDays)

Constructs a new RestoreObjectRequest.

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.

When using this operation using an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon Simple Storage Service Developer Guide.

Parameters:

bucketName - The name of the bucket, or access point ARN, containing the reference to the object to restore which is now stored in Amazon Glacier.

key - The key, the name of the reference to the object to restore, which is now stored in Amazon Glacier.

expirationInDays - The time, in days, between when an object is restored to the bucket and when it expires

See Also:

RestoreObjectRequest(String, String)

Method Detail

getBucketName

public String getBucketName()

Returns the name of the bucket containing the reference to the object to restore which is now stored in Amazon Glacier.

See Also:

RestoreObjectRequest.setBucketName(String), RestoreObjectRequest.withBucketName(String)

withBucketName

public RestoreObjectRequest withBucketName(String bucketName)

Sets the name of the bucket containing the reference to the object to restore which is now stored in Amazon Glacier, and returns a reference to this object(RestoreObjectRequest) for method chaining.

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.

When using this operation using an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon Simple Storage Service Developer Guide.

See Also:

RestoreObjectRequest.setBucketName(String), RestoreObjectRequest.getBucketName()

setBucketName

public void setBucketName(String bucketName)

Sets the name of the bucket containing the reference to the object to restore which is now stored in Amazon Glacier.

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.

When using this operation using an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon Simple Storage Service Developer Guide.

See Also:

RestoreObjectRequest.getBucketName(), RestoreObjectRequest.withBucketName(String)

getKey

public String getKey()

Gets the key, the name of the reference to the object to restore, which is now stored in Amazon Glacier.

See Also:

RestoreObjectRequest.setKey(String), RestoreObjectRequest.withKey(String)

setKey

public void setKey(String key)

Sets the key, the name of the reference to the object to restore, which is now stored in Amazon Glacier.

See Also:

RestoreObjectRequest.getKey(), RestoreObjectRequest.withKey(String)

withKey

public RestoreObjectRequest withKey(String key)

Sets the key, the name of the reference to the object to restore, which is now stored in Amazon Glacier. returns a reference to this object(RestoreObjectRequest) for method chaining.

See Also:

RestoreObjectRequest.getKey(), RestoreObjectRequest.setKey(String)

getVersionId

public String getVersionId()

Returns the id of the version to be restored.

setVersionId

public void setVersionId(String versionId)

Sets the id of the version to be restored.

withVersionId

public RestoreObjectRequest withVersionId(String versionId)

Sets the id of the version to be restored and returns a reference to this object for method chaining.

setExpirationInDays

public void setExpirationInDays(int expirationInDays)

Set the lifetime of the active copy in days. Do not use with restores that specify OutputLocation.

The Days element is required for regular restores, and must not be provided for select requests.

getExpirationInDays

public int getExpirationInDays()

Returns the lifetime of the active copy in days. Do not use with restores that specify OutputLocation.

The Days element is required for regular restores, and must not be provided for select requests.

withExpirationInDays

public RestoreObjectRequest withExpirationInDays(int expirationInDays)

Set the lifetime of the active copy in days. Do not use with restores that specify OutputLocation.

The Days element is required for regular restores, and must not be provided for select requests.

isRequesterPays

public boolean isRequesterPays()

Returns true if the user has enabled Requester Pays option when conducting this operation from Requester Pays Bucket; else false.

If a bucket is enabled for Requester Pays, then any attempt to upload or download an object from it without Requester Pays enabled will result in a 403 error and the bucket owner will be charged for the request.

Enabling Requester Pays disables the ability to have anonymous access to this bucket

Returns:

true if the user has enabled Requester Pays option for conducting this operation from Requester Pays Bucket.

setRequesterPays

public void setRequesterPays(boolean isRequesterPays)

Used for conducting this operation from a Requester Pays Bucket. If set the requester is charged for requests from the bucket.

If a bucket is enabled for Requester Pays, then any attempt to upload or download an object from it without Requester Pays enabled will result in a 403 error and the bucket owner will be charged for the request.

Enabling Requester Pays disables the ability to have anonymous access to this bucket.

Parameters:

isRequesterPays - Enable Requester Pays option for the operation.

withRequesterPays

public RestoreObjectRequest withRequesterPays(boolean isRequesterPays)

Used for conducting this operation from a Requester Pays Bucket. If set the requester is charged for requests from the bucket. It returns this updated RestoreObjectRequest object so that additional method calls can be chained together.

If a bucket is enabled for Requester Pays, then any attempt to upload or download an object from it without Requester Pays enabled will result in a 403 error and the bucket owner will be charged for the request.

Enabling Requester Pays disables the ability to have anonymous access to this bucket.

Parameters:

isRequesterPays - Enable Requester Pays option for the operation.

Returns:

The updated RestoreObjectRequest object.

getGlacierJobParameters

public GlacierJobParameters getGlacierJobParameters()

Returns:

Glacier related parameters pertaining to this job.

setGlacierJobParameters

public void setGlacierJobParameters(GlacierJobParameters glacierJobParameters)

Sets Glacier related parameters pertaining to this job.

This should not be used for restores with a specified OutputLocation.

Parameters:

glacierJobParameters - New value for Glacier job parameters.

withGlacierJobParameters

public RestoreObjectRequest withGlacierJobParameters(GlacierJobParameters glacierJobParameters)

Sets Glacier related parameters pertaining to this job.

This should not be used for restores with a specified OutputLocation.

Parameters:

glacierJobParameters - New value for Glacier job parameters.

Returns:

This object for method chaining.