Java tutorial
/* * Copyright 2010-2019 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; /** * <p> * 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. * </p> * <p> * 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. * </p> * <p> * For more information about enabling versioning for a bucket, see * {@link AmazonS3Client#setBucketVersioningConfiguration(SetBucketVersioningConfigurationRequest)} * . * </p> * * @see GetObjectMetadataRequest#GetObjectMetadataRequest(String, String) * @see GetObjectMetadataRequest#GetObjectMetadataRequest(String, String, String) * @see GetObjectRequest */ public class GetObjectMetadataRequest extends AmazonWebServiceRequest implements SSECustomerKeyProvider, Serializable { /** * The name of the bucket containing the object's whose metadata is being * retrieved. */ 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; /** * 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); } /** * Gets the name of the bucket containing the object whose metadata is * being retrieved. * * @return The name of the bucket containing the object whose metadata is * being retrieved. * * @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. * * @param bucketName * The name of the bucket containing the object's whose metadata * is being retrieved. * * @see GetObjectMetadataRequest#getBucketName() * @see GetObjectMetadataRequest#withBucketName(String) */ public void setBucketName(String bucketName) { this.bucketName = bucketName; } /** * Sets the name of the bucket containing the object whose metadata is * being retrieved. * Returns this {@link GetObjectMetadataRequest}, enabling additional method * calls to be chained together. * * @param bucketName * The name of the bucket containing the object's whose metadata * is being retrieved. * * @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. * * <p> * 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. * * <p> * 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. * * <p> * 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. * * <p> * 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. * * <p> * 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. * * <p> * 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; } /** * <p> * Returns the optional part number that indicates a part in multipart object. * </p> * * @return The part number representing a part in a multipart object. * * @see GetObjectMetadataRequest#setPartNumber(Integer) * @see GetObjectMetadataRequest#withPartNumber(Integer) */ public Integer getPartNumber() { return partNumber; } /** * <p> * Sets the optional part number to find the number of parts of an object. * </p> * <p> * 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. * </p> * <p> * 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 * </p> * * @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; } /** * <p> * Sets the optional part number to find the number of parts of an object. * </p> * <p> * 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. * </p> * <p> * 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 * </p> * * @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; } }