-
- All Implemented Interfaces:
public class RequestParamIndex of valid
x-amz-*request headers and URI parameters.This index may not be complete.
-
-
Field Summary
Fields Modifier and Type Field Description private final StringIfMatchprivate final StringIfModifiedSinceprivate final StringIfNoneMatchprivate final StringIfUnmodifiedSinceprivate final StringPartNumberprivate final StringRangeprivate final StringResponseCacheControlprivate final StringResponseContentDispositionprivate final StringResponseContentEncodingprivate final StringResponseContentLengthprivate final StringResponseContentTypeprivate final StringResponseExpiresprivate final StringVersionIDprivate final StringChecksumModeprivate final StringExpectedBucketOwnerprivate final StringRequestPayerprivate final StringServerSideEncryptionCustomerAlgorithmprivate final StringServerSideEncryptionCustomerKeyprivate final StringServerSideEncryptionCustomerKeyMD5public final static RequestParamINSTANCE
-
Method Summary
Modifier and Type Method Description final StringgetIfMatch()If-MatchReturn the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error.final StringgetIfModifiedSince()If-Modified-SinceReturn the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.final StringgetIfNoneMatch()If-None-MatchReturn the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.final StringgetIfUnmodifiedSince()If-Unmodified-SinceReturn the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.final StringgetPartNumber()partNumberPart number of the object being read.final StringgetRange()RangeDownloads the specified range bytes of an object.final StringgetResponseCacheControl()response-cache-controlSets the Cache-Control header of the response.final StringgetResponseContentDisposition()response-content-dispositionSets the Content-Disposition header of the responsefinal StringgetResponseContentEncoding()response-content-encodingSets the Content-Encoding header of the response.final StringgetResponseContentLength()response-content-languageSets the Content-Language header of the response.final StringgetResponseContentType()response-content-typeSets the Content-Type header of the response.final StringgetResponseExpires()response-expiresSets the Expires header of the response.final StringgetVersionID()versionIdVersionId used to reference a specific version of the object.final StringgetChecksumMode()x-amz-checksum-modeTo retrieve the checksum, this mode must be enabled.final StringgetExpectedBucketOwner()x-amz-expected-bucket-ownerThe account ID of the expected bucket owner.final StringgetRequestPayer()x-amz-request-payerConfirms that the requester knows that they will be charged for the request.final StringgetServerSideEncryptionCustomerAlgorithm()x-amz-server-side-encryption-customer-algorithmSpecifies the algorithm to use to when decrypting the object (for example, AES256).final StringgetServerSideEncryptionCustomerKey()x-amz-server-side-encryption-customer-keySpecifies the customer-provided encryption key for Amazon S3 used to encrypt the data.final StringgetServerSideEncryptionCustomerKeyMD5()x-amz-server-side-encryption-customer-key-MD5Specifies the 128-bit MD5 digest of the encryption key according to RFCAmazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
-
-
Method Detail
-
getIfMatch
final String getIfMatch()
If-MatchReturn the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error.
-
getIfModifiedSince
final String getIfModifiedSince()
If-Modified-SinceReturn the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.
-
getIfNoneMatch
final String getIfNoneMatch()
If-None-MatchReturn the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.
-
getIfUnmodifiedSince
final String getIfUnmodifiedSince()
If-Unmodified-SinceReturn the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.
-
getPartNumber
final String getPartNumber()
partNumberPart number of the object being read. This is a positive integer between
1and10,000. Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object.
-
getRange
final String getRange()
RangeDownloads the specified range bytes of an object. For more information about the HTTP Range header, see https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
Note: Amazon S3 doesn't support retrieving multiple ranges of data per
GETrequest.
-
getResponseCacheControl
final String getResponseCacheControl()
response-cache-controlSets the Cache-Control header of the response.
-
getResponseContentDisposition
final String getResponseContentDisposition()
response-content-dispositionSets the Content-Disposition header of the response
-
getResponseContentEncoding
final String getResponseContentEncoding()
response-content-encodingSets the Content-Encoding header of the response.
-
getResponseContentLength
final String getResponseContentLength()
response-content-languageSets the Content-Language header of the response.
-
getResponseContentType
final String getResponseContentType()
response-content-typeSets the Content-Type header of the response.
-
getResponseExpires
final String getResponseExpires()
response-expiresSets the Expires header of the response.
-
getVersionID
final String getVersionID()
versionIdVersionId used to reference a specific version of the object.
-
getChecksumMode
final String getChecksumMode()
x-amz-checksum-modeTo retrieve the checksum, this mode must be enabled.
Valid Values:
ENABLED
-
getExpectedBucketOwner
final String getExpectedBucketOwner()
x-amz-expected-bucket-ownerThe account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
-
getRequestPayer
final String getRequestPayer()
x-amz-request-payerConfirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from Requester Pays buckets, see "Downloading Objects in Requester Pays Buckets" in the Amazon S3 User Guide.
Valid Values:
requester
-
getServerSideEncryptionCustomerAlgorithm
final String getServerSideEncryptionCustomerAlgorithm()
x-amz-server-side-encryption-customer-algorithmSpecifies the algorithm to use to when decrypting the object (for example, AES256).
-
getServerSideEncryptionCustomerKey
final String getServerSideEncryptionCustomerKey()
x-amz-server-side-encryption-customer-keySpecifies the customer-provided encryption key for Amazon S3 used to encrypt the data. This value is used to decrypt the object when recovering it and must match the one used when storing the data. The key must be appropriate for use with the algorithm specified in the
x-amz-server-side-encryption-customer-algorithmheader.
-
getServerSideEncryptionCustomerKeyMD5
final String getServerSideEncryptionCustomerKeyMD5()
x-amz-server-side-encryption-customer-key-MD5Specifies the 128-bit MD5 digest of the encryption key according to RFC
Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
-
-
-