com.amazonaws.services.s3.model.GetObjectMetadataRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-s3 Show documentation
/*
* Copyright 2010-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.s3.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.services.s3.AmazonS3Client;
/**
* The HEAD action retrieves metadata from an object without returning the object itself. This action is useful if
* you're only interested in an object's metadata. To use HEAD, you must have READ access to the object.
*
* A HEAD request has the same options as a GET action on an object. The response is identical
* to the GET response except that there is no response body. Because of this, if the HEAD request
* generates an error, it returns a generic 404 Not Found or 403 Forbidden code. It is not possible
* to retrieve the exact exception beyond these error codes.
*
* If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store
* the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers:
*
*
* -
x-amz-server-side-encryption-customer-algorithm
* -
x-amz-server-side-encryption-customer-key
-
*
x-amz-server-side-encryption-customer-key-MD5
*
*
*
* For more information about SSE-C, see
* Server-Side Encryption
* (Using Customer-Provided Encryption Keys).
*
*
*
* -
Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET
* requests if your object uses server-side encryption with CMKs stored in Amazon Web Services KMS (SSE-KMS) or
* server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of
* keys, you’ll get an HTTP 400 BadRequest error.
* -
The last modified property in this case is the creation date of the object.
*
*
*
* Request headers are limited to 8 KB in size. For more information, see
* Common Request Headers.
*
* Consider the following when using request headers:
*
*
* -
Consideration 1 – If both of the If-Match and If-Unmodified-Since headers are
* present in the request as follows:
*
* -
If-Match condition evaluates to true, and;
* -
If-Unmodified-Since condition evaluates to false;
*
*
* Then Amazon S3 returns 200 OK and the data requested.
* -
Consideration 2 – If both of the If-None-Match and If-Modified-Since headers are
* present in the request as follows:
*
* -
If-None-Match condition evaluates to false, and;
* -
If-Modified-Since condition evaluates to true;
*
*
* Then Amazon S3 returns the 304 Not Modified response code.
*
*
* For more information about conditional requests, see RFC 7232.
*
* Permissions
<
*
* p>You need the relevant read object (or version) permission for this operation. For more information, see
* Specifying
* Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether
* you also have the s3:ListBucket permission.
*
*
* -
If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code
* 404 (\"no such key\") error.
* -
If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403
* (\"access denied\") error.
*
*
* The following action is related to HeadObject:
*
*
* -
*
*
* @see GetObjectMetadataRequest#GetObjectMetadataRequest(String, String)
* @see GetObjectMetadataRequest#GetObjectMetadataRequest(String, String, String)
* @see GetObjectRequest
*/
public class GetObjectMetadataRequest extends AmazonWebServiceRequest implements
SSECustomerKeyProvider, Serializable, ExpectedBucketOwnerRequest {
/**
* The name of the bucket containing the object's whose metadata is being
* retrieved.
*
*
* When using this action 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 action
* with 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 S3 User Guide.
*
*
* When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The
* S3 on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
* When you use this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
* access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the
* Amazon S3 User Guide.
*
*/
private String bucketName;
/**
* The key of the object whose metadata is being retrieved.
*/
private String key;
/**
* The optional version ID of the object version whose metadata is being
* retrieved. If not specified, the latest version will be used.
*/
private String versionId;
/**
* If enabled, the requester is charged for downloading the metadata from
* Requester Pays Buckets.
*/
private boolean isRequesterPays;
/**
* The optional customer-provided server-side encryption key to use when
* retrieving the metadata of a server-side encrypted object.
*/
private SSECustomerKey sseCustomerKey;
/**
* The optional part number to find the number of parts of an object.
*/
private Integer partNumber;
private String expectedBucketOwner;
/**
* Constructs a new
* {@link GetObjectMetadataRequest}
* used to retrieve a specified
* object's metadata.
*
* @param bucketName
* The name of the bucket containing the object whose metadata
* is being retrieved.
* @param key
* The key of the object whose metadata is being retrieved.
*
* @see GetObjectMetadataRequest#GetObjectMetadataRequest(String bucketName, String key, String versionId)
*/
public GetObjectMetadataRequest(String bucketName, String key) {
setBucketName(bucketName);
setKey(key);
}
/**
* Constructs a new
* {@link GetObjectMetadataRequest}
* with basic options.
*
* @param bucketName
* The name of the bucket containing the object whose metadata
* is being retrieved.
* @param key
* The key of the object whose metadata is being retrieved.
* @param versionId
* The version ID of the object version whose metadata is being
* retrieved.
*
* @see GetObjectMetadataRequest#GetObjectMetadataRequest(String bucketName, String key)
*/
public GetObjectMetadataRequest(String bucketName, String key, String versionId) {
this(bucketName, key);
setVersionId(versionId);
}
public String getExpectedBucketOwner() {
return expectedBucketOwner;
}
public GetObjectMetadataRequest withExpectedBucketOwner(String expectedBucketOwner) {
this.expectedBucketOwner = expectedBucketOwner;
return this;
}
public void setExpectedBucketOwner(String expectedBucketOwner) {
withExpectedBucketOwner(expectedBucketOwner);
}
/**
*
* The name of the bucket containing the object.
*
*
* When using this action 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 action with 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 S3 User Guide.
*
*
* When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The
* S3 on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
* When you use this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
* access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the
* Amazon S3 User Guide.
*
*
* @return The name of the bucket containing the object.
*
* When using this action 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
* action with 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 S3 User Guide.
*
*
* When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts
* hostname. The S3 on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
* When you use this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
* access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts
* in the Amazon S3 User Guide.
*
* @see GetObjectMetadataRequest#setBucketName(String bucketName)
* @see GetObjectMetadataRequest#withBucketName(String)
*/
public String getBucketName() {
return bucketName;
}
/**
* Sets the name of the bucket containing the object whose metadata is
* being retrieved.
*
*
* When using this action 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 action with 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 S3 User Guide.
*
*
* When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The
* S3 on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
* When you use this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
* access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the
* Amazon S3 User Guide.
*
*
* @param bucketName
* The name of the bucket, or access point ARN, containing the object's whose metadata
* is being retrieved.
*
* When using this action 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
* action with 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 S3 User Guide.
*
*
* When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts
* hostname. The S3 on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
* When you use this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
* access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts
* in the Amazon S3 User Guide.
*
* @see GetObjectMetadataRequest#getBucketName()
* @see GetObjectMetadataRequest#withBucketName(String)
*/
public void setBucketName(String bucketName) {
this.bucketName = bucketName;
}
/**
*
* The name of the bucket containing the object.
*
*
* When using this action 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 action
* with 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 S3 User Guide.
*
*
* When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The
* S3 on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
* When you use this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
* access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the
* Amazon S3 User Guide.
*
*
* @param bucketName
* The name of the bucket containing the object.
*
* When using this action 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
* action with 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 S3 User Guide.
*
*
* When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts
* hostname. The S3 on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
* When you use this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
* access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts
* in the Amazon S3 User Guide.
*
* @return This {@link GetObjectMetadataRequest}, enabling additional method
* calls to be chained together.
*
* @see GetObjectMetadataRequest#getBucketName()
* @see GetObjectMetadataRequest#setBucketName(String bucketName)
*/
public GetObjectMetadataRequest withBucketName(String bucketName) {
setBucketName(bucketName);
return this;
}
/**
* Gets the key of the object whose metadata is being retrieved.
*
* @return The key of the object whose metadata is being retrieved.
*
* @see GetObjectMetadataRequest#setKey(String)
* @see GetObjectMetadataRequest#withKey(String)
*/
public String getKey() {
return key;
}
/**
* Sets the key of the object whose metadata is being retrieved.
*
* @param key
* The key of the object whose metadata is being retrieved.
*
* @see GetObjectMetadataRequest#getKey()
* @see GetObjectMetadataRequest#withKey(String)
*/
public void setKey(String key) {
this.key = key;
}
/**
* Sets the key of the object whose metadata is being retrieved.
* Returns this {@link GetObjectMetadataRequest}, enabling additional method
* calls to be chained together.
*
* @param key
* The key of the object whose metadata is being retrieved.
*
* @return This {@link GetObjectMetadataRequest}, enabling additional method
* calls to be chained together.
*
* @see GetObjectMetadataRequest#getKey()
* @see GetObjectMetadataRequest#setKey(String)
*/
public GetObjectMetadataRequest withKey(String key) {
setKey(key);
return this;
}
/**
* Gets the optional version ID of the object version whose metadata is
* being retrieved. If not specified, the latest version will be used.
*
* @return The optional version ID of the object version whose metadata is
* being retrieved. If not specified, the latest version will be
* used.
*
* @see GetObjectMetadataRequest#setVersionId(String)
* @see GetObjectMetadataRequest#withVersionId(String)
*/
public String getVersionId() {
return versionId;
}
/**
* Sets the optional version ID of the object version whose metadata is
* being retrieved. If not specified, the latest version will be used.
*
* @param versionId
* The optional version ID of the object version whose metadata
* is being retrieved. If not specified, the latest version will
* be used.
*
* @see GetObjectMetadataRequest#getVersionId()
* @see GetObjectMetadataRequest#withVersionId(String)
*/
public void setVersionId(String versionId) {
this.versionId = versionId;
}
/**
* Sets the optional version ID of the object version whose metadata is
* being retrieved.
* Returns this {@link GetObjectMetadataRequest}, enabling additional method
* calls to be chained together.
* If not specified, the latest version will be used.
*
* @param versionId
* The optional version ID of the object version whose metadata
* is being retrieved.
*
* @return This {@link GetObjectMetadataRequest}, enabling additional method
* calls to be chained together.
*
* @see GetObjectMetadataRequest#getVersionId()
* @see GetObjectMetadataRequest#setVersionId(String)
*/
public GetObjectMetadataRequest withVersionId(String versionId) {
setVersionId(versionId);
return this;
}
/**
* 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
*
* @return true if the user has enabled Requester Pays option for
* downloading the object metadata from Requester Pays Bucket.
*/
public boolean isRequesterPays() {
return 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
*
* @param isRequesterPays
* Enable Requester Pays option for the operation.
*/
public void setRequesterPays(boolean isRequesterPays) {
this.isRequesterPays = 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.
*
* @param isRequesterPays
* Enable Requester Pays option for the operation.
*
* @return The updated GetObjectMetadataRequest object.
*/
public GetObjectMetadataRequest withRequesterPays(boolean isRequesterPays) {
setRequesterPays(isRequesterPays);
return this;
}
@Override
public SSECustomerKey getSSECustomerKey() {
return sseCustomerKey;
}
/**
* Sets the optional customer-provided server-side encryption key to use
* when retrieving the metadata of a server-side encrypted object.
*
* @param sseKey
* The optional customer-provided server-side encryption key to
* use when retrieving the metadata of a server-side encrypted
* object.
*/
public void setSSECustomerKey(SSECustomerKey sseKey) {
this.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.
*
* @param sseKey
* The optional customer-provided server-side encryption key to
* use when retrieving the metadata of a server-side encrypted
* object.
*
* @return This updated request object so that additional method calls can
* be chained together.
*/
public GetObjectMetadataRequest withSSECustomerKey(SSECustomerKey sseKey) {
setSSECustomerKey(sseKey);
return this;
}
/**
*
* Returns the optional part number that indicates a part in multipart object.
*
*
* @return The part number representing a part in a multipart object.
*
* @see GetObjectMetadataRequest#setPartNumber(Integer)
* @see GetObjectMetadataRequest#withPartNumber(Integer)
*/
public Integer getPartNumber() {
return 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
*
*
* @param partNumber
* The part number representing a part in a multipart object.
*
* @see GetObjectMetadataRequest#getPartNumber()
* @see GetObjectMetadataRequest#withPartNumber(Integer)
*/
public void setPartNumber(Integer partNumber) {
this.partNumber = 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
*
*
* @param partNumber
* The part number representing a part in a multipart object.
*
* @return This {@link GetObjectRequest}, enabling additional method
* calls to be chained together.
*
* @see GetObjectMetadataRequest#getPartNumber()
* @see GetObjectMetadataRequest#setPartNumber(Integer)
*/
public GetObjectMetadataRequest withPartNumber(Integer partNumber) {
setPartNumber(partNumber);
return this;
}
}