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

Interface HeadObjectResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<HeadObjectResponse.Builder,HeadObjectResponse>, S3Response.Builder, SdkBuilder<HeadObjectResponse.Builder,HeadObjectResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
HeadObjectResponse
public static interface HeadObjectResponse.Builder extends S3Response.Builder, SdkPojo, CopyableBuilder<HeadObjectResponse.Builder,HeadObjectResponse>

  • Method Details

    • deleteMarker

      HeadObjectResponse.Builder deleteMarker(Boolean deleteMarker)

      Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.

      Parameters:
      deleteMarker - Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • acceptRanges

      HeadObjectResponse.Builder acceptRanges(String acceptRanges)

      Indicates that a range of bytes was specified.

      Parameters:
      acceptRanges - Indicates that a range of bytes was specified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • expiration

      HeadObjectResponse.Builder expiration(String expiration)

      If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL-encoded.

      Parameters:
      expiration - If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL-encoded.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • restore

      HeadObjectResponse.Builder restore(String restore)

      If the object is an archived object (an object whose storage class is GLACIER), the response includes this header if either the archive restoration is in progress (see RestoreObject or an archive copy is already restored.

      If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:

      x-amz-restore: ongoing-request="false", expiry-date="Fri, 21 Dec 2012 00:00:00 GMT"

      If the object restoration is in progress, the header returns the value ongoing-request="true".

      For more information about archiving objects, see Transitioning Objects: General Considerations.

      Parameters:
      restore - If the object is an archived object (an object whose storage class is GLACIER), the response includes this header if either the archive restoration is in progress (see RestoreObject or an archive copy is already restored.

      If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:

      x-amz-restore: ongoing-request="false", expiry-date="Fri, 21 Dec 2012 00:00:00 GMT"

      If the object restoration is in progress, the header returns the value ongoing-request="true".

      For more information about archiving objects, see Transitioning Objects: General Considerations.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • archiveStatus

      HeadObjectResponse.Builder archiveStatus(String archiveStatus)

      The archive state of the head object.

      Parameters:
      archiveStatus - The archive state of the head object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • archiveStatus

      HeadObjectResponse.Builder archiveStatus(ArchiveStatus archiveStatus)

      The archive state of the head object.

      Parameters:
      archiveStatus - The archive state of the head object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • lastModified

      HeadObjectResponse.Builder lastModified(Instant lastModified)

      Creation date of the object.

      Parameters:
      lastModified - Creation date of the object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • contentLength

      HeadObjectResponse.Builder contentLength(Long contentLength)

      Size of the body in bytes.

      Parameters:
      contentLength - Size of the body in bytes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • checksumCRC32

      HeadObjectResponse.Builder checksumCRC32(String checksumCRC32)

      The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

      Parameters:
      checksumCRC32 - The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • checksumCRC32C

      HeadObjectResponse.Builder checksumCRC32C(String checksumCRC32C)

      The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

      Parameters:
      checksumCRC32C - The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • checksumSHA1

      HeadObjectResponse.Builder checksumSHA1(String checksumSHA1)

      The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

      Parameters:
      checksumSHA1 - The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • checksumSHA256

      HeadObjectResponse.Builder checksumSHA256(String checksumSHA256)

      The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

      Parameters:
      checksumSHA256 - The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • eTag

      HeadObjectResponse.Builder eTag(String eTag)

      An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.

      Parameters:
      eTag - An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • missingMeta

      HeadObjectResponse.Builder missingMeta(Integer missingMeta)

      This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.

      Parameters:
      missingMeta - This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • versionId

      HeadObjectResponse.Builder versionId(String versionId)

      Version of the object.

      Parameters:
      versionId - Version of the object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cacheControl

      HeadObjectResponse.Builder cacheControl(String cacheControl)

      Specifies caching behavior along the request/reply chain.

      Parameters:
      cacheControl - Specifies caching behavior along the request/reply chain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • contentDisposition

      HeadObjectResponse.Builder contentDisposition(String contentDisposition)

      Specifies presentational information for the object.

      Parameters:
      contentDisposition - Specifies presentational information for the object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • contentEncoding

      HeadObjectResponse.Builder contentEncoding(String contentEncoding)

      Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

      Parameters:
      contentEncoding - Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • contentLanguage

      HeadObjectResponse.Builder contentLanguage(String contentLanguage)

      The language the content is in.

      Parameters:
      contentLanguage - The language the content is in.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • contentType

      HeadObjectResponse.Builder contentType(String contentType)

      A standard MIME type describing the format of the object data.

      Parameters:
      contentType - A standard MIME type describing the format of the object data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • expires

      HeadObjectResponse.Builder expires(Instant expires)

      The date and time at which the object is no longer cacheable.

      Parameters:
      expires - The date and time at which the object is no longer cacheable.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • websiteRedirectLocation

      HeadObjectResponse.Builder websiteRedirectLocation(String websiteRedirectLocation)

      If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.

      Parameters:
      websiteRedirectLocation - If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serverSideEncryption

      HeadObjectResponse.Builder serverSideEncryption(String serverSideEncryption)

      The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).

      Parameters:
      serverSideEncryption - The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • serverSideEncryption

      HeadObjectResponse.Builder serverSideEncryption(ServerSideEncryption serverSideEncryption)

      The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).

      Parameters:
      serverSideEncryption - The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • metadata

      HeadObjectResponse.Builder metadata(Map<String,String> metadata)

      A map of metadata to store with the object in S3.

      Parameters:
      metadata - A map of metadata to store with the object in S3.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sseCustomerAlgorithm

      HeadObjectResponse.Builder sseCustomerAlgorithm(String sseCustomerAlgorithm)

      If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

      Parameters:
      sseCustomerAlgorithm - If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sseCustomerKeyMD5

      HeadObjectResponse.Builder sseCustomerKeyMD5(String sseCustomerKeyMD5)

      If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.

      Parameters:
      sseCustomerKeyMD5 - If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ssekmsKeyId

      HeadObjectResponse.Builder ssekmsKeyId(String ssekmsKeyId)

      If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

      Parameters:
      ssekmsKeyId - If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • bucketKeyEnabled

      HeadObjectResponse.Builder bucketKeyEnabled(Boolean bucketKeyEnabled)

      Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

      Parameters:
      bucketKeyEnabled - Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • storageClass

      HeadObjectResponse.Builder storageClass(String storageClass)

      Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

      For more information, see Storage Classes.

      Parameters:
      storageClass - Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

      For more information, see Storage Classes.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • storageClass

      HeadObjectResponse.Builder storageClass(StorageClass storageClass)

      Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

      For more information, see Storage Classes.

      Parameters:
      storageClass - Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

      For more information, see Storage Classes.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • requestCharged

      HeadObjectResponse.Builder requestCharged(String requestCharged)
      Sets the value of the RequestCharged property for this object.
      Parameters:
      requestCharged - The new value for the RequestCharged property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • requestCharged

      HeadObjectResponse.Builder requestCharged(RequestCharged requestCharged)
      Sets the value of the RequestCharged property for this object.
      Parameters:
      requestCharged - The new value for the RequestCharged property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • replicationStatus

      HeadObjectResponse.Builder replicationStatus(String replicationStatus)

      Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule.

      In replication, you have a source bucket on which you configure replication and destination bucket or buckets where Amazon S3 stores object replicas. When you request an object (GetObject) or object metadata (HeadObject) from these buckets, Amazon S3 will return the x-amz-replication-status header in the response as follows:

      • If requesting an object from the source bucket, Amazon S3 will return the x-amz-replication-status header if the object in your request is eligible for replication.

        For example, suppose that in your replication configuration, you specify object prefix TaxDocs requesting Amazon S3 to replicate objects with key prefix TaxDocs. Any objects you upload with this key name prefix, for example TaxDocs/document1.pdf, are eligible for replication. For any object request with this key name prefix, Amazon S3 will return the x-amz-replication-status header with value PENDING, COMPLETED or FAILED indicating object replication status.

      • If requesting an object from a destination bucket, Amazon S3 will return the x-amz-replication-status header with value REPLICA if the object in your request is a replica that Amazon S3 created and there is no replica modification replication in progress.

      • When replicating objects to multiple destination buckets, the x-amz-replication-status header acts differently. The header of the source object will only return a value of COMPLETED when replication is successful to all destinations. The header will remain at value PENDING until replication has completed for all destinations. If one or more destinations fails replication the header will return FAILED.

      For more information, see Replication.

      Parameters:
      replicationStatus - Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule.

      In replication, you have a source bucket on which you configure replication and destination bucket or buckets where Amazon S3 stores object replicas. When you request an object (GetObject) or object metadata (HeadObject) from these buckets, Amazon S3 will return the x-amz-replication-status header in the response as follows:

      • If requesting an object from the source bucket, Amazon S3 will return the x-amz-replication-status header if the object in your request is eligible for replication.

        For example, suppose that in your replication configuration, you specify object prefix TaxDocs requesting Amazon S3 to replicate objects with key prefix TaxDocs. Any objects you upload with this key name prefix, for example TaxDocs/document1.pdf, are eligible for replication. For any object request with this key name prefix, Amazon S3 will return the x-amz-replication-status header with value PENDING, COMPLETED or FAILED indicating object replication status.

      • If requesting an object from a destination bucket, Amazon S3 will return the x-amz-replication-status header with value REPLICA if the object in your request is a replica that Amazon S3 created and there is no replica modification replication in progress.

      • When replicating objects to multiple destination buckets, the x-amz-replication-status header acts differently. The header of the source object will only return a value of COMPLETED when replication is successful to all destinations. The header will remain at value PENDING until replication has completed for all destinations. If one or more destinations fails replication the header will return FAILED.

      For more information, see Replication.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • replicationStatus

      HeadObjectResponse.Builder replicationStatus(ReplicationStatus replicationStatus)

      Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule.

      In replication, you have a source bucket on which you configure replication and destination bucket or buckets where Amazon S3 stores object replicas. When you request an object (GetObject) or object metadata (HeadObject) from these buckets, Amazon S3 will return the x-amz-replication-status header in the response as follows:

      • If requesting an object from the source bucket, Amazon S3 will return the x-amz-replication-status header if the object in your request is eligible for replication.

        For example, suppose that in your replication configuration, you specify object prefix TaxDocs requesting Amazon S3 to replicate objects with key prefix TaxDocs. Any objects you upload with this key name prefix, for example TaxDocs/document1.pdf, are eligible for replication. For any object request with this key name prefix, Amazon S3 will return the x-amz-replication-status header with value PENDING, COMPLETED or FAILED indicating object replication status.

      • If requesting an object from a destination bucket, Amazon S3 will return the x-amz-replication-status header with value REPLICA if the object in your request is a replica that Amazon S3 created and there is no replica modification replication in progress.

      • When replicating objects to multiple destination buckets, the x-amz-replication-status header acts differently. The header of the source object will only return a value of COMPLETED when replication is successful to all destinations. The header will remain at value PENDING until replication has completed for all destinations. If one or more destinations fails replication the header will return FAILED.

      For more information, see Replication.

      Parameters:
      replicationStatus - Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule.

      In replication, you have a source bucket on which you configure replication and destination bucket or buckets where Amazon S3 stores object replicas. When you request an object (GetObject) or object metadata (HeadObject) from these buckets, Amazon S3 will return the x-amz-replication-status header in the response as follows:

      • If requesting an object from the source bucket, Amazon S3 will return the x-amz-replication-status header if the object in your request is eligible for replication.

        For example, suppose that in your replication configuration, you specify object prefix TaxDocs requesting Amazon S3 to replicate objects with key prefix TaxDocs. Any objects you upload with this key name prefix, for example TaxDocs/document1.pdf, are eligible for replication. For any object request with this key name prefix, Amazon S3 will return the x-amz-replication-status header with value PENDING, COMPLETED or FAILED indicating object replication status.

      • If requesting an object from a destination bucket, Amazon S3 will return the x-amz-replication-status header with value REPLICA if the object in your request is a replica that Amazon S3 created and there is no replica modification replication in progress.

      • When replicating objects to multiple destination buckets, the x-amz-replication-status header acts differently. The header of the source object will only return a value of COMPLETED when replication is successful to all destinations. The header will remain at value PENDING until replication has completed for all destinations. If one or more destinations fails replication the header will return FAILED.

      For more information, see Replication.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • partsCount

      HeadObjectResponse.Builder partsCount(Integer partsCount)

      The count of parts this object has. This value is only returned if you specify partNumber in your request and the object was uploaded as a multipart upload.

      Parameters:
      partsCount - The count of parts this object has. This value is only returned if you specify partNumber in your request and the object was uploaded as a multipart upload.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • objectLockMode

      HeadObjectResponse.Builder objectLockMode(String objectLockMode)

      The Object Lock mode, if any, that's in effect for this object. This header is only returned if the requester has the s3:GetObjectRetention permission. For more information about S3 Object Lock, see Object Lock.

      Parameters:
      objectLockMode - The Object Lock mode, if any, that's in effect for this object. This header is only returned if the requester has the s3:GetObjectRetention permission. For more information about S3 Object Lock, see Object Lock.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • objectLockMode

      HeadObjectResponse.Builder objectLockMode(ObjectLockMode objectLockMode)

      The Object Lock mode, if any, that's in effect for this object. This header is only returned if the requester has the s3:GetObjectRetention permission. For more information about S3 Object Lock, see Object Lock.

      Parameters:
      objectLockMode - The Object Lock mode, if any, that's in effect for this object. This header is only returned if the requester has the s3:GetObjectRetention permission. For more information about S3 Object Lock, see Object Lock.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • objectLockRetainUntilDate

      HeadObjectResponse.Builder objectLockRetainUntilDate(Instant objectLockRetainUntilDate)

      The date and time when the Object Lock retention period expires. This header is only returned if the requester has the s3:GetObjectRetention permission.

      Parameters:
      objectLockRetainUntilDate - The date and time when the Object Lock retention period expires. This header is only returned if the requester has the s3:GetObjectRetention permission.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • objectLockLegalHoldStatus

      HeadObjectResponse.Builder objectLockLegalHoldStatus(String objectLockLegalHoldStatus)

      Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has the s3:GetObjectLegalHold permission. This header is not returned if the specified version of this object has never had a legal hold applied. For more information about S3 Object Lock, see Object Lock.

      Parameters:
      objectLockLegalHoldStatus - Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has the s3:GetObjectLegalHold permission. This header is not returned if the specified version of this object has never had a legal hold applied. For more information about S3 Object Lock, see Object Lock.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • objectLockLegalHoldStatus

      HeadObjectResponse.Builder objectLockLegalHoldStatus(ObjectLockLegalHoldStatus objectLockLegalHoldStatus)

      Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has the s3:GetObjectLegalHold permission. This header is not returned if the specified version of this object has never had a legal hold applied. For more information about S3 Object Lock, see Object Lock.

      Parameters:
      objectLockLegalHoldStatus - Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has the s3:GetObjectLegalHold permission. This header is not returned if the specified version of this object has never had a legal hold applied. For more information about S3 Object Lock, see Object Lock.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: