Package software.amazon.awssdk.services.s3.model

Class HeadObjectRequest

    • Method Detail

      • bucket

        public final String bucket()

        The name of the bucket that contains the object.

        Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

        Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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.

        Access points and Object Lambda access points are not supported by directory buckets.

        S3 on Outposts - 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 with 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.

        Returns:
        The name of the bucket that contains the object.

        Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

        Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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.

        Access points and Object Lambda access points are not supported by directory buckets.

        S3 on Outposts - 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 with 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.

      • ifMatch

        public final String ifMatch()

        Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error.

        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.

        For more information about conditional requests, see RFC 7232.

        Returns:
        Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error.

        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.

        For more information about conditional requests, see RFC 7232.

      • ifModifiedSince

        public final Instant ifModifiedSince()

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

        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.

        Returns:
        Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.

        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.

      • ifNoneMatch

        public final String ifNoneMatch()

        Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.

        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.

        Returns:
        Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.

        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.

      • ifUnmodifiedSince

        public final Instant ifUnmodifiedSince()

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

        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.

        For more information about conditional requests, see RFC 7232.

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

        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.

        For more information about conditional requests, see RFC 7232.

      • key

        public final String key()

        The object key.

        Returns:
        The object key.

      • range

        public final String range()

        HeadObject returns only the metadata for an object. If the Range is satisfiable, only the ContentLength is affected in the response. If the Range is not satisfiable, S3 returns a 416 - Requested Range Not Satisfiable error.

        Returns:
        HeadObject returns only the metadata for an object. If the Range is satisfiable, only the ContentLength is affected in the response. If the Range is not satisfiable, S3 returns a 416 - Requested Range Not Satisfiable error.

      • versionId

        public final String versionId()

        Version ID used to reference a specific version of the object.

        For directory buckets in this API operation, only the null value of the version ID is supported.

        Returns:
        Version ID used to reference a specific version of the object.

        For directory buckets in this API operation, only the null value of the version ID is supported.

      • sseCustomerAlgorithm

        public final String sseCustomerAlgorithm()

        Specifies the algorithm to use when encrypting the object (for example, AES256).

        This functionality is not supported for directory buckets.

        Returns:
        Specifies the algorithm to use when encrypting the object (for example, AES256).

        This functionality is not supported for directory buckets.

      • sseCustomerKey

        public final String sseCustomerKey()

        Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

        This functionality is not supported for directory buckets.

        Returns:
        Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

        This functionality is not supported for directory buckets.

      • sseCustomerKeyMD5

        public final String sseCustomerKeyMD5()

        Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

        This functionality is not supported for directory buckets.

        Returns:
        Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

        This functionality is not supported for directory buckets.

      • requestPayerAsString

        public final String requestPayerAsString()
        Returns the value of the RequestPayer property for this object.

        If the service returns an enum value that is not available in the current SDK version, requestPayer will return RequestPayer.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requestPayerAsString().

        Returns:
        The value of the RequestPayer property for this object.
        See Also:
        RequestPayer

      • partNumber

        public final Integer partNumber()

        Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object.

        Returns:
        Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object.

      • expectedBucketOwner

        public final String expectedBucketOwner()

        The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

        Returns:
        The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

      • checksumMode

        public final ChecksumMode checksumMode()

        To retrieve the checksum, this parameter must be enabled.

        In addition, if you enable ChecksumMode and the object is encrypted with Amazon Web Services Key Management Service (Amazon Web Services KMS), you must have permission to use the kms:Decrypt action for the request to succeed.

        If the service returns an enum value that is not available in the current SDK version, checksumMode will return ChecksumMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from checksumModeAsString().

        Returns:
        To retrieve the checksum, this parameter must be enabled.

        In addition, if you enable ChecksumMode and the object is encrypted with Amazon Web Services Key Management Service (Amazon Web Services KMS), you must have permission to use the kms:Decrypt action for the request to succeed.

        See Also:
        ChecksumMode

      • checksumModeAsString

        public final String checksumModeAsString()

        To retrieve the checksum, this parameter must be enabled.

        In addition, if you enable ChecksumMode and the object is encrypted with Amazon Web Services Key Management Service (Amazon Web Services KMS), you must have permission to use the kms:Decrypt action for the request to succeed.

        If the service returns an enum value that is not available in the current SDK version, checksumMode will return ChecksumMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from checksumModeAsString().

        Returns:
        To retrieve the checksum, this parameter must be enabled.

        In addition, if you enable ChecksumMode and the object is encrypted with Amazon Web Services Key Management Service (Amazon Web Services KMS), you must have permission to use the kms:Decrypt action for the request to succeed.

        See Also:
        ChecksumMode

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object