Package 

Object RequestParam

  • All Implemented Interfaces:

    
    public class RequestParam
    
                        

    Index of valid x-amz-* request headers and URI parameters.

    This index may not be complete.

    • Constructor Detail

    • Method Detail

      • getIfMatch

         final String getIfMatch()

        If-Match

        Return 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-Since

        Return 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-Match

        Return 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-Since

        Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.

      • getPartNumber

         final String getPartNumber()

        partNumber

        Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object.

      • getRange

         final String getRange()

        Range

        Downloads 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 GET request.

      • getVersionID

         final String getVersionID()

        versionId

        VersionId used to reference a specific version of the object.

      • getChecksumMode

         final String getChecksumMode()

        x-amz-checksum-mode

        To retrieve the checksum, this mode must be enabled.

        Valid Values:

        • ENABLED

      • getExpectedBucketOwner

         final String getExpectedBucketOwner()

        x-amz-expected-bucket-owner

        The 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-payer

        Confirms 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

      • getServerSideEncryptionCustomerKey

         final String getServerSideEncryptionCustomerKey()

        x-amz-server-side-encryption-customer-key

        Specifies 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-algorithm header.

      • getServerSideEncryptionCustomerKeyMD5

         final String getServerSideEncryptionCustomerKeyMD5()

        x-amz-server-side-encryption-customer-key-MD5

        Specifies 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.