com.amazonaws.services.s3.model

Class GetObjectMetadataRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.s3.model.GetObjectMetadataRequest

All Implemented Interfaces:

SSECustomerKeyProvider, java.io.Serializable, java.lang.Cloneable

public class GetObjectMetadataRequest
extends AmazonWebServiceRequest
implements SSECustomerKeyProvider, java.io.Serializable

Provides options for obtaining the metadata for the specified Amazon S3 object without actually fetching the object contents. This is useful if obtaining only object metadata, and avoids wasting bandwidth from retrieving the object data.

The object metadata contains information such as content type, content disposition, etc., as well as custom user metadata that can be associated with an object in Amazon S3.

For more information about enabling versioning for a bucket, see AmazonS3.setBucketVersioningConfiguration(SetBucketVersioningConfigurationRequest) .

See Also:

GetObjectMetadataRequest(String, String), GetObjectMetadataRequest(String, String, String), GetObjectRequest, Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetObjectMetadataRequest(java.lang.String bucketName, java.lang.String key) Constructs a new GetObjectMetadataRequest used to retrieve a specified object's metadata.
GetObjectMetadataRequest(java.lang.String bucketName, java.lang.String key, java.lang.String versionId) Constructs a new GetObjectMetadataRequest with basic options.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBucketName() Gets the name of the bucket containing the object whose metadata is being retrieved.
java.lang.String	getKey() Gets the key of the object whose metadata is being retrieved.
java.lang.Integer	getPartNumber() Returns the optional part number that indicates a part in multipart object.
SSECustomerKey	getSSECustomerKey() Returns the optional customer-provided server-side encryption key to use to encrypt the uploaded object.
java.lang.String	getVersionId() Gets the optional version ID of the object version whose metadata is being retrieved.
boolean	isRequesterPays() Returns true if the user has enabled Requester Pays option when downloading the object metadata from Requester Pays Bucket; else false.
void	setBucketName(java.lang.String bucketName) Sets the name of the bucket containing the object whose metadata is being retrieved.
void	setKey(java.lang.String key) Sets the key of the object whose metadata is being retrieved.
void	setPartNumber(java.lang.Integer partNumber) Sets the optional part number to find the number of parts of an object.
void	setRequesterPays(boolean isRequesterPays) Used for downloading an Amazon S3 Object metadata from a Requester Pays Bucket.
void	setSSECustomerKey(SSECustomerKey sseKey) Sets the optional customer-provided server-side encryption key to use when retrieving the metadata of a server-side encrypted object.
void	setVersionId(java.lang.String versionId) Sets the optional version ID of the object version whose metadata is being retrieved.
GetObjectMetadataRequest	withBucketName(java.lang.String bucketName) Sets the name of the bucket containing the object whose metadata is being retrieved.
GetObjectMetadataRequest	withKey(java.lang.String key) Sets the key of the object whose metadata is being retrieved.
GetObjectMetadataRequest	withPartNumber(java.lang.Integer partNumber) Sets the optional part number to find the number of parts of an object.
GetObjectMetadataRequest	withRequesterPays(boolean isRequesterPays) Used for conducting this operation from a Requester Pays Bucket.
GetObjectMetadataRequest	withSSECustomerKey(SSECustomerKey sseKey) Sets the optional customer-provided server-side encryption key to use when retrieving the metadata of a server-side encrypted object, and retuns the updated request object so that additional method calls can be chained together.
GetObjectMetadataRequest	withVersionId(java.lang.String versionId) Sets the optional version ID of the object version whose metadata is being retrieved.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

GetObjectMetadataRequest

public GetObjectMetadataRequest(java.lang.String bucketName,
                                java.lang.String key)

Constructs a new GetObjectMetadataRequest used to retrieve a specified object's metadata.

Parameters:

bucketName - The name of the bucket containing the object whose metadata is being retrieved.

key - The key of the object whose metadata is being retrieved.

See Also:

GetObjectMetadataRequest(String bucketName, String key, String versionId)

GetObjectMetadataRequest

public GetObjectMetadataRequest(java.lang.String bucketName,
                                java.lang.String key,
                                java.lang.String versionId)

Constructs a new GetObjectMetadataRequest with basic options.

Parameters:

bucketName - The name of the bucket containing the object whose metadata is being retrieved.

key - The key of the object whose metadata is being retrieved.

versionId - The version ID of the object version whose metadata is being retrieved.

See Also:

GetObjectMetadataRequest(String bucketName, String key)

Method Detail

getBucketName

public java.lang.String getBucketName()

Gets the name of the bucket containing the object whose metadata is being retrieved.

Returns:

The name of the bucket containing the object whose metadata is being retrieved.

See Also:

setBucketName(String bucketName), withBucketName(String)

setBucketName

public void setBucketName(java.lang.String bucketName)

Sets the name of the bucket containing the object whose metadata is being retrieved.

Parameters:

bucketName - The name of the bucket containing the object's whose metadata is being retrieved.

See Also:

getBucketName(), withBucketName(String)

withBucketName

public GetObjectMetadataRequest withBucketName(java.lang.String bucketName)

Sets the name of the bucket containing the object whose metadata is being retrieved. Returns this GetObjectMetadataRequest, enabling additional method calls to be chained together.

Parameters:

bucketName - The name of the bucket containing the object's whose metadata is being retrieved.

Returns:

This GetObjectMetadataRequest, enabling additional method calls to be chained together.

See Also:

getBucketName(), setBucketName(String bucketName)

getKey

public java.lang.String getKey()

Gets the key of the object whose metadata is being retrieved.

Returns:

The key of the object whose metadata is being retrieved.

See Also:

setKey(String), withKey(String)

setKey

public void setKey(java.lang.String key)

Sets the key of the object whose metadata is being retrieved.

Parameters:

key - The key of the object whose metadata is being retrieved.

See Also:

getKey(), withKey(String)

withKey

public GetObjectMetadataRequest withKey(java.lang.String key)

Sets the key of the object whose metadata is being retrieved. Returns this GetObjectMetadataRequest, enabling additional method calls to be chained together.

Parameters:

key - The key of the object whose metadata is being retrieved.

Returns:

This GetObjectMetadataRequest, enabling additional method calls to be chained together.

See Also:

getKey(), setKey(String)

getVersionId

public java.lang.String getVersionId()

Gets the optional version ID of the object version whose metadata is being retrieved. If not specified, the latest version will be used.

Returns:

The optional version ID of the object version whose metadata is being retrieved. If not specified, the latest version will be used.

See Also:

setVersionId(String), withVersionId(String)

setVersionId

public void setVersionId(java.lang.String versionId)

Sets the optional version ID of the object version whose metadata is being retrieved. If not specified, the latest version will be used.

Parameters:

versionId - The optional version ID of the object version whose metadata is being retrieved. If not specified, the latest version will be used.

See Also:

getVersionId(), withVersionId(String)

withVersionId

public GetObjectMetadataRequest withVersionId(java.lang.String versionId)

Sets the optional version ID of the object version whose metadata is being retrieved. Returns this GetObjectMetadataRequest, enabling additional method calls to be chained together. If not specified, the latest version will be used.

Parameters:

versionId - The optional version ID of the object version whose metadata is being retrieved.

Returns:

This GetObjectMetadataRequest, enabling additional method calls to be chained together.

See Also:

getVersionId(), setVersionId(String)

isRequesterPays

public boolean isRequesterPays()

Returns true if the user has enabled Requester Pays option when downloading the object metadata from Requester Pays Bucket; else false.

If a bucket is enabled for Requester Pays, then any attempt to read 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 downloading the object metadata from Requester Pays Bucket.

setRequesterPays

public void setRequesterPays(boolean isRequesterPays)

Used for downloading an Amazon S3 Object metadata from a Requester Pays Bucket. If set the requester is charged for downloading the data from the bucket.

If a bucket is enabled for Requester Pays, then any attempt to read an object metadata 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 GetObjectMetadataRequest 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 GetObjectMetadataRequest 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 GetObjectMetadataRequest object.

getSSECustomerKey

public SSECustomerKey getSSECustomerKey()

Description copied from interface: SSECustomerKeyProvider

Returns the optional customer-provided server-side encryption key to use to encrypt the uploaded object.

Specified by:

getSSECustomerKey in interface SSECustomerKeyProvider

Returns:

The optional customer-provided server-side encryption key to use to encrypt the uploaded object.

setSSECustomerKey

public void setSSECustomerKey(SSECustomerKey sseKey)

Sets the optional customer-provided server-side encryption key to use when retrieving the metadata of a server-side encrypted object.

Parameters:

sseKey - The optional customer-provided server-side encryption key to use when retrieving the metadata of a server-side encrypted object.

withSSECustomerKey

public GetObjectMetadataRequest withSSECustomerKey(SSECustomerKey sseKey)

Sets the optional customer-provided server-side encryption key to use when retrieving the metadata of a server-side encrypted object, and retuns the updated request object so that additional method calls can be chained together.

Parameters:

sseKey - The optional customer-provided server-side encryption key to use when retrieving the metadata of a server-side encrypted object.

Returns:

This updated request object so that additional method calls can be chained together.

getPartNumber

public java.lang.Integer getPartNumber()

Returns the optional part number that indicates a part in multipart object.

Returns:

The part number representing a part in a multipart object.

See Also:

setPartNumber(Integer), withPartNumber(Integer)

setPartNumber

public void setPartNumber(java.lang.Integer partNumber)

Sets the optional part number to find the number of parts of an object.

To find the number of parts of an object, set partNumber to 1 and observe the x-amz-mp-parts-count response. If the object exists and x-amz-mp-parts-count is missing it's implicitly 1. Otherwise number of parts is equal to the value returned by x-amz-mp-parts-count.

The valid range for part number is 1 - 10000 inclusive. For partNumber < 1, an AmazonS3Exception is thrown with response code 400 bad request For partNumber larger than actual part count, an AmazonS3Exception is thrown with response code 416 Request Range Not Satisfiable

Parameters:

partNumber - The part number representing a part in a multipart object.

See Also:

getPartNumber(), withPartNumber(Integer)

withPartNumber

public GetObjectMetadataRequest withPartNumber(java.lang.Integer partNumber)

Sets the optional part number to find the number of parts of an object.

To find the number of parts of an object, set partNumber to 1 and observe the x-amz-mp-parts-count response. If the object exists and x-amz-mp-parts-count is missing it's implicitly 1. Otherwise number of parts is equal to the value returned by x-amz-mp-parts-count.

The valid range for part number is 1 - 10000 inclusive. For partNumber < 1, an AmazonS3Exception is thrown with response code 400 bad request For partNumber larger than actual part count, an AmazonS3Exception is thrown with response code 416 Request Range Not Satisfiable

Parameters:

partNumber - The part number representing a part in a multipart object.

Returns:

This GetObjectRequest, enabling additional method calls to be chained together.

See Also:

getPartNumber(), setPartNumber(Integer)