Did this page help you?

   Yes   No   Tell us about it...

com.amazonaws.services.s3.model
Class RestoreObjectRequest

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceRequest
      extended by com.amazonaws.services.s3.model.RestoreObjectRequest

public class RestoreObjectRequest
extends AmazonWebServiceRequest

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)

Constructor Summary
RestoreObjectRequest(String bucketName, String key)
           Constructs a new RestoreObjectRequest.
RestoreObjectRequest(String bucketName, String key, int expirationInDays)
           Constructs a new RestoreObjectRequest.
 
Method Summary
 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 time in days from an object's creation to its expiration.
 String getKey()
          Gets the key, the name of the reference to the object to restore, which is now stored in Amazon Glacier.
 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)
          Sets the time, in days, between when an object is uploaded to the bucket and when it expires.
 void setKey(String key)
          Sets the key, the name of the reference to the object to restore, which is now stored in Amazon Glacier.
 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)
          Sets the time, in days, between when an object is uploaded to the bucket and when it expires, and returns a reference to this object(RestoreObjectRequest) for method chaining.
 RestoreObjectRequest withKey(String key)
          Sets the key, the name of the reference to the object to restore, which is now stored in Amazon Glacier.
 
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RestoreObjectRequest

public RestoreObjectRequest(String bucketName,
                            String key)

Constructs a new RestoreObjectRequest.

Parameters:
bucketName - The name of the bucket 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.

Parameters:
bucketName - The name of the bucket 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:
setBucketName(String), 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.

See Also:
setBucketName(String), 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.

See Also:
getBucketName(), 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:
setKey(String), 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:
getKey(), 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:
getKey(), setKey(String)

setExpirationInDays

public void setExpirationInDays(int expirationInDays)
Sets the time, in days, between when an object is uploaded to the bucket and when it expires.


getExpirationInDays

public int getExpirationInDays()
Returns the time in days from an object's creation to its expiration.


withExpirationInDays

public RestoreObjectRequest withExpirationInDays(int expirationInDays)
Sets the time, in days, between when an object is uploaded to the bucket and when it expires, and returns a reference to this object(RestoreObjectRequest) for method chaining.



Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.