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

Class HeadObjectRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.s3.model.S3Request
software.amazon.awssdk.services.s3.model.HeadObjectRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<HeadObjectRequest.Builder,HeadObjectRequest>
@Generated("software.amazon.awssdk:codegen") public final class HeadObjectRequest extends S3Request implements ToCopyableBuilder<HeadObjectRequest.Builder,HeadObjectRequest>

  • Method Details

    • bucket

      public final String bucket()

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

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

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

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

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

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

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

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

    • 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()

      VersionId used to reference a specific version of the object.

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

    • sseCustomerAlgorithm

      public final String sseCustomerAlgorithm()

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

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

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

      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.

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

      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.

    • requestPayer

      public final RequestPayer requestPayer()
      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:

    • 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:

    • 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 bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

      Returns:
      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).

    • 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:

    • 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:

    • toBuilder

      public HeadObjectRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<HeadObjectRequest.Builder,HeadObjectRequest>
      Specified by:
      toBuilder in class S3Request
      Returns:
      a builder for type T

    • builder

      public static HeadObjectRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends HeadObjectRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.