// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq)]
pub struct HeadObjectOutput {
/// <p>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.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub delete_marker: ::std::option::Option<bool>,
/// <p>Indicates that a range of bytes was specified.</p>
pub accept_ranges: ::std::option::Option<::std::string::String>,
/// <p>If the object expiration is configured (see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html"> <code>PutBucketLifecycleConfiguration</code> </a>), the response includes this header. It includes the <code>expiry-date</code> and <code>rule-id</code> key-value pairs providing object expiration information. The value of the <code>rule-id</code> is URL-encoded.</p><note>
/// <p>Object expiration information is not returned in directory buckets and this header returns the value "<code>NotImplemented</code>" in all responses for directory buckets.</p>
/// </note>
pub expiration: ::std::option::Option<::std::string::String>,
/// <p>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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html">RestoreObject</a> or an archive copy is already restored.</p>
/// <p>If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:</p>
/// <p><code>x-amz-restore: ongoing-request="false", expiry-date="Fri, 21 Dec 2012 00:00:00 GMT"</code></p>
/// <p>If the object restoration is in progress, the header returns the value <code>ongoing-request="true"</code>.</p>
/// <p>For more information about archiving objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-transition-general-considerations">Transitioning Objects: General Considerations</a>.</p><note>
/// <p>This functionality is not supported for directory buckets. Directory buckets only support <code>EXPRESS_ONEZONE</code> (the S3 Express One Zone storage class) in Availability Zones and <code>ONEZONE_IA</code> (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.</p>
/// </note>
pub restore: ::std::option::Option<::std::string::String>,
/// <p>The archive state of the head object.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub archive_status: ::std::option::Option<crate::types::ArchiveStatus>,
/// <p>Date and time when the object was last modified.</p>
pub last_modified: ::std::option::Option<::aws_smithy_types::DateTime>,
/// <p>Size of the body in bytes.</p>
pub content_length: ::std::option::Option<i64>,
/// <p>The Base64 encoded, 32-bit <code>CRC32 checksum</code> of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub checksum_crc32: ::std::option::Option<::std::string::String>,
/// <p>The Base64 encoded, 32-bit <code>CRC32C</code> checksum of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub checksum_crc32_c: ::std::option::Option<::std::string::String>,
/// <p>The Base64 encoded, 64-bit <code>CRC64NVME</code> checksum of the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity in the Amazon S3 User Guide</a>.</p>
pub checksum_crc64_nvme: ::std::option::Option<::std::string::String>,
/// <p>The Base64 encoded, 160-bit <code>SHA1</code> digest of the object. This checksum is only present if the checksum was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub checksum_sha1: ::std::option::Option<::std::string::String>,
/// <p>The Base64 encoded, 256-bit <code>SHA256</code> digest of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub checksum_sha256: ::std::option::Option<::std::string::String>,
/// <p>The checksum type, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. You can use this header response to verify that the checksum type that is received is the same checksum type that was specified in <code>CreateMultipartUpload</code> request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity in the Amazon S3 User Guide</a>.</p>
pub checksum_type: ::std::option::Option<crate::types::ChecksumType>,
/// <p>An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.</p>
pub e_tag: ::std::option::Option<::std::string::String>,
/// <p>This is set to the number of metadata entries not returned in <code>x-amz-meta</code> 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.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub missing_meta: ::std::option::Option<i32>,
/// <p>Version ID of the object.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub version_id: ::std::option::Option<::std::string::String>,
/// <p>Specifies caching behavior along the request/reply chain.</p>
pub cache_control: ::std::option::Option<::std::string::String>,
/// <p>Specifies presentational information for the object.</p>
pub content_disposition: ::std::option::Option<::std::string::String>,
/// <p>Indicates 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.</p>
pub content_encoding: ::std::option::Option<::std::string::String>,
/// <p>The language the content is in.</p>
pub content_language: ::std::option::Option<::std::string::String>,
/// <p>A standard MIME type describing the format of the object data.</p>
pub content_type: ::std::option::Option<::std::string::String>,
/// <p>The portion of the object returned in the response for a <code>GET</code> request.</p>
pub content_range: ::std::option::Option<::std::string::String>,
/// <p>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.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub website_redirect_location: ::std::option::Option<::std::string::String>,
/// <p>The server-side encryption algorithm used when you store this object in Amazon S3 or Amazon FSx.</p><note>
/// <p>When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side encryption option is <code>aws:fsx</code>.</p>
/// </note>
pub server_side_encryption: ::std::option::Option<crate::types::ServerSideEncryption>,
/// <p>A map of metadata to store with the object in S3.</p>
pub metadata: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
/// <p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub sse_customer_algorithm: ::std::option::Option<::std::string::String>,
/// <p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub sse_customer_key_md5: ::std::option::Option<::std::string::String>,
/// <p>If present, indicates the ID of the KMS key that was used for object encryption.</p>
pub ssekms_key_id: ::std::option::Option<::std::string::String>,
/// <p>Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).</p>
pub bucket_key_enabled: ::std::option::Option<bool>,
/// <p>Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a>.</p><note>
/// <p><b>Directory buckets </b> - Directory buckets only support <code>EXPRESS_ONEZONE</code> (the S3 Express One Zone storage class) in Availability Zones and <code>ONEZONE_IA</code> (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.</p>
/// </note>
pub storage_class: ::std::option::Option<crate::types::StorageClass>,
/// <p>If present, indicates that the requester was successfully charged for the request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html">Using Requester Pays buckets for storage transfers and usage</a> in the <i>Amazon Simple Storage Service user guide</i>.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub request_charged: ::std::option::Option<crate::types::RequestCharged>,
/// <p>Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule.</p>
/// <p>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 (<code>GetObject</code>) or object metadata (<code>HeadObject</code>) from these buckets, Amazon S3 will return the <code>x-amz-replication-status</code> header in the response as follows:</p>
/// <ul>
/// <li>
/// <p><b>If requesting an object from the source bucket</b>, Amazon S3 will return the <code>x-amz-replication-status</code> header if the object in your request is eligible for replication.</p>
/// <p>For example, suppose that in your replication configuration, you specify object prefix <code>TaxDocs</code> requesting Amazon S3 to replicate objects with key prefix <code>TaxDocs</code>. Any objects you upload with this key name prefix, for example <code>TaxDocs/document1.pdf</code>, are eligible for replication. For any object request with this key name prefix, Amazon S3 will return the <code>x-amz-replication-status</code> header with value PENDING, COMPLETED or FAILED indicating object replication status.</p></li>
/// <li>
/// <p><b>If requesting an object from a destination bucket</b>, Amazon S3 will return the <code>x-amz-replication-status</code> 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.</p></li>
/// <li>
/// <p><b>When replicating objects to multiple destination buckets</b>, the <code>x-amz-replication-status</code> 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.</p></li>
/// </ul>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Replication</a>.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub replication_status: ::std::option::Option<crate::types::ReplicationStatus>,
/// <p>The count of parts this object has. This value is only returned if you specify <code>partNumber</code> in your request and the object was uploaded as a multipart upload.</p>
pub parts_count: ::std::option::Option<i32>,
/// <p>The number of tags, if any, on the object, when you have the relevant permission to read object tags.</p>
/// <p>You can use <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html">GetObjectTagging</a> to retrieve the tag set associated with an object.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub tag_count: ::std::option::Option<i32>,
/// <p>The Object Lock mode, if any, that's in effect for this object. This header is only returned if the requester has the <code>s3:GetObjectRetention</code> permission. For more information about S3 Object Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Object Lock</a>.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub object_lock_mode: ::std::option::Option<crate::types::ObjectLockMode>,
/// <p>The date and time when the Object Lock retention period expires. This header is only returned if the requester has the <code>s3:GetObjectRetention</code> permission.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub object_lock_retain_until_date: ::std::option::Option<::aws_smithy_types::DateTime>,
/// <p>Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has the <code>s3:GetObjectLegalHold</code> 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Object Lock</a>.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub object_lock_legal_hold_status: ::std::option::Option<crate::types::ObjectLockLegalHoldStatus>,
/// <p>The date and time at which the object is no longer cacheable.</p>
#[deprecated(note = "Please use `expires_string` which contains the raw, unparsed value of this field.")]
pub expires: ::std::option::Option<::aws_smithy_types::DateTime>,
/// <p>The date and time at which the object is no longer cacheable.</p>
pub expires_string: ::std::option::Option<::std::string::String>,
_extended_request_id: Option<String>,
_request_id: Option<String>,
}
impl HeadObjectOutput {
/// <p>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.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn delete_marker(&self) -> ::std::option::Option<bool> {
self.delete_marker
}
/// <p>Indicates that a range of bytes was specified.</p>
pub fn accept_ranges(&self) -> ::std::option::Option<&str> {
self.accept_ranges.as_deref()
}
/// <p>If the object expiration is configured (see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html"> <code>PutBucketLifecycleConfiguration</code> </a>), the response includes this header. It includes the <code>expiry-date</code> and <code>rule-id</code> key-value pairs providing object expiration information. The value of the <code>rule-id</code> is URL-encoded.</p><note>
/// <p>Object expiration information is not returned in directory buckets and this header returns the value "<code>NotImplemented</code>" in all responses for directory buckets.</p>
/// </note>
pub fn expiration(&self) -> ::std::option::Option<&str> {
self.expiration.as_deref()
}
/// <p>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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html">RestoreObject</a> or an archive copy is already restored.</p>
/// <p>If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:</p>
/// <p><code>x-amz-restore: ongoing-request="false", expiry-date="Fri, 21 Dec 2012 00:00:00 GMT"</code></p>
/// <p>If the object restoration is in progress, the header returns the value <code>ongoing-request="true"</code>.</p>
/// <p>For more information about archiving objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-transition-general-considerations">Transitioning Objects: General Considerations</a>.</p><note>
/// <p>This functionality is not supported for directory buckets. Directory buckets only support <code>EXPRESS_ONEZONE</code> (the S3 Express One Zone storage class) in Availability Zones and <code>ONEZONE_IA</code> (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.</p>
/// </note>
pub fn restore(&self) -> ::std::option::Option<&str> {
self.restore.as_deref()
}
/// <p>The archive state of the head object.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn archive_status(&self) -> ::std::option::Option<&crate::types::ArchiveStatus> {
self.archive_status.as_ref()
}
/// <p>Date and time when the object was last modified.</p>
pub fn last_modified(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
self.last_modified.as_ref()
}
/// <p>Size of the body in bytes.</p>
pub fn content_length(&self) -> ::std::option::Option<i64> {
self.content_length
}
/// <p>The Base64 encoded, 32-bit <code>CRC32 checksum</code> of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub fn checksum_crc32(&self) -> ::std::option::Option<&str> {
self.checksum_crc32.as_deref()
}
/// <p>The Base64 encoded, 32-bit <code>CRC32C</code> checksum of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub fn checksum_crc32_c(&self) -> ::std::option::Option<&str> {
self.checksum_crc32_c.as_deref()
}
/// <p>The Base64 encoded, 64-bit <code>CRC64NVME</code> checksum of the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity in the Amazon S3 User Guide</a>.</p>
pub fn checksum_crc64_nvme(&self) -> ::std::option::Option<&str> {
self.checksum_crc64_nvme.as_deref()
}
/// <p>The Base64 encoded, 160-bit <code>SHA1</code> digest of the object. This checksum is only present if the checksum was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub fn checksum_sha1(&self) -> ::std::option::Option<&str> {
self.checksum_sha1.as_deref()
}
/// <p>The Base64 encoded, 256-bit <code>SHA256</code> digest of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub fn checksum_sha256(&self) -> ::std::option::Option<&str> {
self.checksum_sha256.as_deref()
}
/// <p>The checksum type, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. You can use this header response to verify that the checksum type that is received is the same checksum type that was specified in <code>CreateMultipartUpload</code> request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity in the Amazon S3 User Guide</a>.</p>
pub fn checksum_type(&self) -> ::std::option::Option<&crate::types::ChecksumType> {
self.checksum_type.as_ref()
}
/// <p>An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.</p>
pub fn e_tag(&self) -> ::std::option::Option<&str> {
self.e_tag.as_deref()
}
/// <p>This is set to the number of metadata entries not returned in <code>x-amz-meta</code> 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.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn missing_meta(&self) -> ::std::option::Option<i32> {
self.missing_meta
}
/// <p>Version ID of the object.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn version_id(&self) -> ::std::option::Option<&str> {
self.version_id.as_deref()
}
/// <p>Specifies caching behavior along the request/reply chain.</p>
pub fn cache_control(&self) -> ::std::option::Option<&str> {
self.cache_control.as_deref()
}
/// <p>Specifies presentational information for the object.</p>
pub fn content_disposition(&self) -> ::std::option::Option<&str> {
self.content_disposition.as_deref()
}
/// <p>Indicates 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.</p>
pub fn content_encoding(&self) -> ::std::option::Option<&str> {
self.content_encoding.as_deref()
}
/// <p>The language the content is in.</p>
pub fn content_language(&self) -> ::std::option::Option<&str> {
self.content_language.as_deref()
}
/// <p>A standard MIME type describing the format of the object data.</p>
pub fn content_type(&self) -> ::std::option::Option<&str> {
self.content_type.as_deref()
}
/// <p>The portion of the object returned in the response for a <code>GET</code> request.</p>
pub fn content_range(&self) -> ::std::option::Option<&str> {
self.content_range.as_deref()
}
/// <p>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.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn website_redirect_location(&self) -> ::std::option::Option<&str> {
self.website_redirect_location.as_deref()
}
/// <p>The server-side encryption algorithm used when you store this object in Amazon S3 or Amazon FSx.</p><note>
/// <p>When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side encryption option is <code>aws:fsx</code>.</p>
/// </note>
pub fn server_side_encryption(&self) -> ::std::option::Option<&crate::types::ServerSideEncryption> {
self.server_side_encryption.as_ref()
}
/// <p>A map of metadata to store with the object in S3.</p>
pub fn metadata(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
self.metadata.as_ref()
}
/// <p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn sse_customer_algorithm(&self) -> ::std::option::Option<&str> {
self.sse_customer_algorithm.as_deref()
}
/// <p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn sse_customer_key_md5(&self) -> ::std::option::Option<&str> {
self.sse_customer_key_md5.as_deref()
}
/// <p>If present, indicates the ID of the KMS key that was used for object encryption.</p>
pub fn ssekms_key_id(&self) -> ::std::option::Option<&str> {
self.ssekms_key_id.as_deref()
}
/// <p>Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).</p>
pub fn bucket_key_enabled(&self) -> ::std::option::Option<bool> {
self.bucket_key_enabled
}
/// <p>Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a>.</p><note>
/// <p><b>Directory buckets </b> - Directory buckets only support <code>EXPRESS_ONEZONE</code> (the S3 Express One Zone storage class) in Availability Zones and <code>ONEZONE_IA</code> (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.</p>
/// </note>
pub fn storage_class(&self) -> ::std::option::Option<&crate::types::StorageClass> {
self.storage_class.as_ref()
}
/// <p>If present, indicates that the requester was successfully charged for the request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html">Using Requester Pays buckets for storage transfers and usage</a> in the <i>Amazon Simple Storage Service user guide</i>.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn request_charged(&self) -> ::std::option::Option<&crate::types::RequestCharged> {
self.request_charged.as_ref()
}
/// <p>Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule.</p>
/// <p>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 (<code>GetObject</code>) or object metadata (<code>HeadObject</code>) from these buckets, Amazon S3 will return the <code>x-amz-replication-status</code> header in the response as follows:</p>
/// <ul>
/// <li>
/// <p><b>If requesting an object from the source bucket</b>, Amazon S3 will return the <code>x-amz-replication-status</code> header if the object in your request is eligible for replication.</p>
/// <p>For example, suppose that in your replication configuration, you specify object prefix <code>TaxDocs</code> requesting Amazon S3 to replicate objects with key prefix <code>TaxDocs</code>. Any objects you upload with this key name prefix, for example <code>TaxDocs/document1.pdf</code>, are eligible for replication. For any object request with this key name prefix, Amazon S3 will return the <code>x-amz-replication-status</code> header with value PENDING, COMPLETED or FAILED indicating object replication status.</p></li>
/// <li>
/// <p><b>If requesting an object from a destination bucket</b>, Amazon S3 will return the <code>x-amz-replication-status</code> 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.</p></li>
/// <li>
/// <p><b>When replicating objects to multiple destination buckets</b>, the <code>x-amz-replication-status</code> 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.</p></li>
/// </ul>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Replication</a>.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn replication_status(&self) -> ::std::option::Option<&crate::types::ReplicationStatus> {
self.replication_status.as_ref()
}
/// <p>The count of parts this object has. This value is only returned if you specify <code>partNumber</code> in your request and the object was uploaded as a multipart upload.</p>
pub fn parts_count(&self) -> ::std::option::Option<i32> {
self.parts_count
}
/// <p>The number of tags, if any, on the object, when you have the relevant permission to read object tags.</p>
/// <p>You can use <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html">GetObjectTagging</a> to retrieve the tag set associated with an object.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn tag_count(&self) -> ::std::option::Option<i32> {
self.tag_count
}
/// <p>The Object Lock mode, if any, that's in effect for this object. This header is only returned if the requester has the <code>s3:GetObjectRetention</code> permission. For more information about S3 Object Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Object Lock</a>.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn object_lock_mode(&self) -> ::std::option::Option<&crate::types::ObjectLockMode> {
self.object_lock_mode.as_ref()
}
/// <p>The date and time when the Object Lock retention period expires. This header is only returned if the requester has the <code>s3:GetObjectRetention</code> permission.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn object_lock_retain_until_date(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
self.object_lock_retain_until_date.as_ref()
}
/// <p>Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has the <code>s3:GetObjectLegalHold</code> 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Object Lock</a>.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn object_lock_legal_hold_status(&self) -> ::std::option::Option<&crate::types::ObjectLockLegalHoldStatus> {
self.object_lock_legal_hold_status.as_ref()
}
/// <p>The date and time at which the object is no longer cacheable.</p>
#[deprecated(note = "Please use `expires_string` which contains the raw, unparsed value of this field.")]
pub fn expires(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
self.expires.as_ref()
}
/// <p>The date and time at which the object is no longer cacheable.</p>
pub fn expires_string(&self) -> ::std::option::Option<&str> {
self.expires_string.as_deref()
}
}
impl ::std::fmt::Debug for HeadObjectOutput {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
let mut formatter = f.debug_struct("HeadObjectOutput");
formatter.field("delete_marker", &self.delete_marker);
formatter.field("accept_ranges", &self.accept_ranges);
formatter.field("expiration", &self.expiration);
formatter.field("restore", &self.restore);
formatter.field("archive_status", &self.archive_status);
formatter.field("last_modified", &self.last_modified);
formatter.field("content_length", &self.content_length);
formatter.field("checksum_crc32", &self.checksum_crc32);
formatter.field("checksum_crc32_c", &self.checksum_crc32_c);
formatter.field("checksum_crc64_nvme", &self.checksum_crc64_nvme);
formatter.field("checksum_sha1", &self.checksum_sha1);
formatter.field("checksum_sha256", &self.checksum_sha256);
formatter.field("checksum_type", &self.checksum_type);
formatter.field("e_tag", &self.e_tag);
formatter.field("missing_meta", &self.missing_meta);
formatter.field("version_id", &self.version_id);
formatter.field("cache_control", &self.cache_control);
formatter.field("content_disposition", &self.content_disposition);
formatter.field("content_encoding", &self.content_encoding);
formatter.field("content_language", &self.content_language);
formatter.field("content_type", &self.content_type);
formatter.field("content_range", &self.content_range);
formatter.field("website_redirect_location", &self.website_redirect_location);
formatter.field("server_side_encryption", &self.server_side_encryption);
formatter.field("metadata", &self.metadata);
formatter.field("sse_customer_algorithm", &self.sse_customer_algorithm);
formatter.field("sse_customer_key_md5", &self.sse_customer_key_md5);
formatter.field("ssekms_key_id", &"*** Sensitive Data Redacted ***");
formatter.field("bucket_key_enabled", &self.bucket_key_enabled);
formatter.field("storage_class", &self.storage_class);
formatter.field("request_charged", &self.request_charged);
formatter.field("replication_status", &self.replication_status);
formatter.field("parts_count", &self.parts_count);
formatter.field("tag_count", &self.tag_count);
formatter.field("object_lock_mode", &self.object_lock_mode);
formatter.field("object_lock_retain_until_date", &self.object_lock_retain_until_date);
formatter.field("object_lock_legal_hold_status", &self.object_lock_legal_hold_status);
formatter.field("expires", &self.expires);
formatter.field("expires_string", &self.expires_string);
formatter.field("_extended_request_id", &self._extended_request_id);
formatter.field("_request_id", &self._request_id);
formatter.finish()
}
}
impl crate::s3_request_id::RequestIdExt for HeadObjectOutput {
fn extended_request_id(&self) -> Option<&str> {
self._extended_request_id.as_deref()
}
}
impl ::aws_types::request_id::RequestId for HeadObjectOutput {
fn request_id(&self) -> Option<&str> {
self._request_id.as_deref()
}
}
impl HeadObjectOutput {
/// Creates a new builder-style object to manufacture [`HeadObjectOutput`](crate::operation::head_object::HeadObjectOutput).
pub fn builder() -> crate::operation::head_object::builders::HeadObjectOutputBuilder {
crate::operation::head_object::builders::HeadObjectOutputBuilder::default()
}
}
/// A builder for [`HeadObjectOutput`](crate::operation::head_object::HeadObjectOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default)]
#[non_exhaustive]
pub struct HeadObjectOutputBuilder {
pub(crate) delete_marker: ::std::option::Option<bool>,
pub(crate) accept_ranges: ::std::option::Option<::std::string::String>,
pub(crate) expiration: ::std::option::Option<::std::string::String>,
pub(crate) restore: ::std::option::Option<::std::string::String>,
pub(crate) archive_status: ::std::option::Option<crate::types::ArchiveStatus>,
pub(crate) last_modified: ::std::option::Option<::aws_smithy_types::DateTime>,
pub(crate) content_length: ::std::option::Option<i64>,
pub(crate) checksum_crc32: ::std::option::Option<::std::string::String>,
pub(crate) checksum_crc32_c: ::std::option::Option<::std::string::String>,
pub(crate) checksum_crc64_nvme: ::std::option::Option<::std::string::String>,
pub(crate) checksum_sha1: ::std::option::Option<::std::string::String>,
pub(crate) checksum_sha256: ::std::option::Option<::std::string::String>,
pub(crate) checksum_type: ::std::option::Option<crate::types::ChecksumType>,
pub(crate) e_tag: ::std::option::Option<::std::string::String>,
pub(crate) missing_meta: ::std::option::Option<i32>,
pub(crate) version_id: ::std::option::Option<::std::string::String>,
pub(crate) cache_control: ::std::option::Option<::std::string::String>,
pub(crate) content_disposition: ::std::option::Option<::std::string::String>,
pub(crate) content_encoding: ::std::option::Option<::std::string::String>,
pub(crate) content_language: ::std::option::Option<::std::string::String>,
pub(crate) content_type: ::std::option::Option<::std::string::String>,
pub(crate) content_range: ::std::option::Option<::std::string::String>,
pub(crate) website_redirect_location: ::std::option::Option<::std::string::String>,
pub(crate) server_side_encryption: ::std::option::Option<crate::types::ServerSideEncryption>,
pub(crate) metadata: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
pub(crate) sse_customer_algorithm: ::std::option::Option<::std::string::String>,
pub(crate) sse_customer_key_md5: ::std::option::Option<::std::string::String>,
pub(crate) ssekms_key_id: ::std::option::Option<::std::string::String>,
pub(crate) bucket_key_enabled: ::std::option::Option<bool>,
pub(crate) storage_class: ::std::option::Option<crate::types::StorageClass>,
pub(crate) request_charged: ::std::option::Option<crate::types::RequestCharged>,
pub(crate) replication_status: ::std::option::Option<crate::types::ReplicationStatus>,
pub(crate) parts_count: ::std::option::Option<i32>,
pub(crate) tag_count: ::std::option::Option<i32>,
pub(crate) object_lock_mode: ::std::option::Option<crate::types::ObjectLockMode>,
pub(crate) object_lock_retain_until_date: ::std::option::Option<::aws_smithy_types::DateTime>,
pub(crate) object_lock_legal_hold_status: ::std::option::Option<crate::types::ObjectLockLegalHoldStatus>,
pub(crate) expires: ::std::option::Option<::aws_smithy_types::DateTime>,
pub(crate) expires_string: ::std::option::Option<::std::string::String>,
_extended_request_id: Option<String>,
_request_id: Option<String>,
}
impl HeadObjectOutputBuilder {
/// <p>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.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn delete_marker(mut self, input: bool) -> Self {
self.delete_marker = ::std::option::Option::Some(input);
self
}
/// <p>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.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn set_delete_marker(mut self, input: ::std::option::Option<bool>) -> Self {
self.delete_marker = input;
self
}
/// <p>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.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn get_delete_marker(&self) -> &::std::option::Option<bool> {
&self.delete_marker
}
/// <p>Indicates that a range of bytes was specified.</p>
pub fn accept_ranges(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.accept_ranges = ::std::option::Option::Some(input.into());
self
}
/// <p>Indicates that a range of bytes was specified.</p>
pub fn set_accept_ranges(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.accept_ranges = input;
self
}
/// <p>Indicates that a range of bytes was specified.</p>
pub fn get_accept_ranges(&self) -> &::std::option::Option<::std::string::String> {
&self.accept_ranges
}
/// <p>If the object expiration is configured (see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html"> <code>PutBucketLifecycleConfiguration</code> </a>), the response includes this header. It includes the <code>expiry-date</code> and <code>rule-id</code> key-value pairs providing object expiration information. The value of the <code>rule-id</code> is URL-encoded.</p><note>
/// <p>Object expiration information is not returned in directory buckets and this header returns the value "<code>NotImplemented</code>" in all responses for directory buckets.</p>
/// </note>
pub fn expiration(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.expiration = ::std::option::Option::Some(input.into());
self
}
/// <p>If the object expiration is configured (see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html"> <code>PutBucketLifecycleConfiguration</code> </a>), the response includes this header. It includes the <code>expiry-date</code> and <code>rule-id</code> key-value pairs providing object expiration information. The value of the <code>rule-id</code> is URL-encoded.</p><note>
/// <p>Object expiration information is not returned in directory buckets and this header returns the value "<code>NotImplemented</code>" in all responses for directory buckets.</p>
/// </note>
pub fn set_expiration(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.expiration = input;
self
}
/// <p>If the object expiration is configured (see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html"> <code>PutBucketLifecycleConfiguration</code> </a>), the response includes this header. It includes the <code>expiry-date</code> and <code>rule-id</code> key-value pairs providing object expiration information. The value of the <code>rule-id</code> is URL-encoded.</p><note>
/// <p>Object expiration information is not returned in directory buckets and this header returns the value "<code>NotImplemented</code>" in all responses for directory buckets.</p>
/// </note>
pub fn get_expiration(&self) -> &::std::option::Option<::std::string::String> {
&self.expiration
}
/// <p>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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html">RestoreObject</a> or an archive copy is already restored.</p>
/// <p>If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:</p>
/// <p><code>x-amz-restore: ongoing-request="false", expiry-date="Fri, 21 Dec 2012 00:00:00 GMT"</code></p>
/// <p>If the object restoration is in progress, the header returns the value <code>ongoing-request="true"</code>.</p>
/// <p>For more information about archiving objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-transition-general-considerations">Transitioning Objects: General Considerations</a>.</p><note>
/// <p>This functionality is not supported for directory buckets. Directory buckets only support <code>EXPRESS_ONEZONE</code> (the S3 Express One Zone storage class) in Availability Zones and <code>ONEZONE_IA</code> (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.</p>
/// </note>
pub fn restore(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.restore = ::std::option::Option::Some(input.into());
self
}
/// <p>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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html">RestoreObject</a> or an archive copy is already restored.</p>
/// <p>If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:</p>
/// <p><code>x-amz-restore: ongoing-request="false", expiry-date="Fri, 21 Dec 2012 00:00:00 GMT"</code></p>
/// <p>If the object restoration is in progress, the header returns the value <code>ongoing-request="true"</code>.</p>
/// <p>For more information about archiving objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-transition-general-considerations">Transitioning Objects: General Considerations</a>.</p><note>
/// <p>This functionality is not supported for directory buckets. Directory buckets only support <code>EXPRESS_ONEZONE</code> (the S3 Express One Zone storage class) in Availability Zones and <code>ONEZONE_IA</code> (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.</p>
/// </note>
pub fn set_restore(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.restore = input;
self
}
/// <p>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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html">RestoreObject</a> or an archive copy is already restored.</p>
/// <p>If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:</p>
/// <p><code>x-amz-restore: ongoing-request="false", expiry-date="Fri, 21 Dec 2012 00:00:00 GMT"</code></p>
/// <p>If the object restoration is in progress, the header returns the value <code>ongoing-request="true"</code>.</p>
/// <p>For more information about archiving objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-transition-general-considerations">Transitioning Objects: General Considerations</a>.</p><note>
/// <p>This functionality is not supported for directory buckets. Directory buckets only support <code>EXPRESS_ONEZONE</code> (the S3 Express One Zone storage class) in Availability Zones and <code>ONEZONE_IA</code> (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.</p>
/// </note>
pub fn get_restore(&self) -> &::std::option::Option<::std::string::String> {
&self.restore
}
/// <p>The archive state of the head object.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn archive_status(mut self, input: crate::types::ArchiveStatus) -> Self {
self.archive_status = ::std::option::Option::Some(input);
self
}
/// <p>The archive state of the head object.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn set_archive_status(mut self, input: ::std::option::Option<crate::types::ArchiveStatus>) -> Self {
self.archive_status = input;
self
}
/// <p>The archive state of the head object.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn get_archive_status(&self) -> &::std::option::Option<crate::types::ArchiveStatus> {
&self.archive_status
}
/// <p>Date and time when the object was last modified.</p>
pub fn last_modified(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.last_modified = ::std::option::Option::Some(input);
self
}
/// <p>Date and time when the object was last modified.</p>
pub fn set_last_modified(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.last_modified = input;
self
}
/// <p>Date and time when the object was last modified.</p>
pub fn get_last_modified(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
&self.last_modified
}
/// <p>Size of the body in bytes.</p>
pub fn content_length(mut self, input: i64) -> Self {
self.content_length = ::std::option::Option::Some(input);
self
}
/// <p>Size of the body in bytes.</p>
pub fn set_content_length(mut self, input: ::std::option::Option<i64>) -> Self {
self.content_length = input;
self
}
/// <p>Size of the body in bytes.</p>
pub fn get_content_length(&self) -> &::std::option::Option<i64> {
&self.content_length
}
/// <p>The Base64 encoded, 32-bit <code>CRC32 checksum</code> of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub fn checksum_crc32(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.checksum_crc32 = ::std::option::Option::Some(input.into());
self
}
/// <p>The Base64 encoded, 32-bit <code>CRC32 checksum</code> of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub fn set_checksum_crc32(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.checksum_crc32 = input;
self
}
/// <p>The Base64 encoded, 32-bit <code>CRC32 checksum</code> of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub fn get_checksum_crc32(&self) -> &::std::option::Option<::std::string::String> {
&self.checksum_crc32
}
/// <p>The Base64 encoded, 32-bit <code>CRC32C</code> checksum of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub fn checksum_crc32_c(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.checksum_crc32_c = ::std::option::Option::Some(input.into());
self
}
/// <p>The Base64 encoded, 32-bit <code>CRC32C</code> checksum of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub fn set_checksum_crc32_c(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.checksum_crc32_c = input;
self
}
/// <p>The Base64 encoded, 32-bit <code>CRC32C</code> checksum of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub fn get_checksum_crc32_c(&self) -> &::std::option::Option<::std::string::String> {
&self.checksum_crc32_c
}
/// <p>The Base64 encoded, 64-bit <code>CRC64NVME</code> checksum of the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity in the Amazon S3 User Guide</a>.</p>
pub fn checksum_crc64_nvme(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.checksum_crc64_nvme = ::std::option::Option::Some(input.into());
self
}
/// <p>The Base64 encoded, 64-bit <code>CRC64NVME</code> checksum of the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity in the Amazon S3 User Guide</a>.</p>
pub fn set_checksum_crc64_nvme(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.checksum_crc64_nvme = input;
self
}
/// <p>The Base64 encoded, 64-bit <code>CRC64NVME</code> checksum of the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity in the Amazon S3 User Guide</a>.</p>
pub fn get_checksum_crc64_nvme(&self) -> &::std::option::Option<::std::string::String> {
&self.checksum_crc64_nvme
}
/// <p>The Base64 encoded, 160-bit <code>SHA1</code> digest of the object. This checksum is only present if the checksum was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub fn checksum_sha1(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.checksum_sha1 = ::std::option::Option::Some(input.into());
self
}
/// <p>The Base64 encoded, 160-bit <code>SHA1</code> digest of the object. This checksum is only present if the checksum was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub fn set_checksum_sha1(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.checksum_sha1 = input;
self
}
/// <p>The Base64 encoded, 160-bit <code>SHA1</code> digest of the object. This checksum is only present if the checksum was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub fn get_checksum_sha1(&self) -> &::std::option::Option<::std::string::String> {
&self.checksum_sha1
}
/// <p>The Base64 encoded, 256-bit <code>SHA256</code> digest of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub fn checksum_sha256(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.checksum_sha256 = ::std::option::Option::Some(input.into());
self
}
/// <p>The Base64 encoded, 256-bit <code>SHA256</code> digest of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub fn set_checksum_sha256(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.checksum_sha256 = input;
self
}
/// <p>The Base64 encoded, 256-bit <code>SHA256</code> digest of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
pub fn get_checksum_sha256(&self) -> &::std::option::Option<::std::string::String> {
&self.checksum_sha256
}
/// <p>The checksum type, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. You can use this header response to verify that the checksum type that is received is the same checksum type that was specified in <code>CreateMultipartUpload</code> request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity in the Amazon S3 User Guide</a>.</p>
pub fn checksum_type(mut self, input: crate::types::ChecksumType) -> Self {
self.checksum_type = ::std::option::Option::Some(input);
self
}
/// <p>The checksum type, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. You can use this header response to verify that the checksum type that is received is the same checksum type that was specified in <code>CreateMultipartUpload</code> request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity in the Amazon S3 User Guide</a>.</p>
pub fn set_checksum_type(mut self, input: ::std::option::Option<crate::types::ChecksumType>) -> Self {
self.checksum_type = input;
self
}
/// <p>The checksum type, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. You can use this header response to verify that the checksum type that is received is the same checksum type that was specified in <code>CreateMultipartUpload</code> request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity in the Amazon S3 User Guide</a>.</p>
pub fn get_checksum_type(&self) -> &::std::option::Option<crate::types::ChecksumType> {
&self.checksum_type
}
/// <p>An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.</p>
pub fn e_tag(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.e_tag = ::std::option::Option::Some(input.into());
self
}
/// <p>An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.</p>
pub fn set_e_tag(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.e_tag = input;
self
}
/// <p>An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.</p>
pub fn get_e_tag(&self) -> &::std::option::Option<::std::string::String> {
&self.e_tag
}
/// <p>This is set to the number of metadata entries not returned in <code>x-amz-meta</code> 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.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn missing_meta(mut self, input: i32) -> Self {
self.missing_meta = ::std::option::Option::Some(input);
self
}
/// <p>This is set to the number of metadata entries not returned in <code>x-amz-meta</code> 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.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn set_missing_meta(mut self, input: ::std::option::Option<i32>) -> Self {
self.missing_meta = input;
self
}
/// <p>This is set to the number of metadata entries not returned in <code>x-amz-meta</code> 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.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn get_missing_meta(&self) -> &::std::option::Option<i32> {
&self.missing_meta
}
/// <p>Version ID of the object.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn version_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.version_id = ::std::option::Option::Some(input.into());
self
}
/// <p>Version ID of the object.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn set_version_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.version_id = input;
self
}
/// <p>Version ID of the object.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn get_version_id(&self) -> &::std::option::Option<::std::string::String> {
&self.version_id
}
/// <p>Specifies caching behavior along the request/reply chain.</p>
pub fn cache_control(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.cache_control = ::std::option::Option::Some(input.into());
self
}
/// <p>Specifies caching behavior along the request/reply chain.</p>
pub fn set_cache_control(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.cache_control = input;
self
}
/// <p>Specifies caching behavior along the request/reply chain.</p>
pub fn get_cache_control(&self) -> &::std::option::Option<::std::string::String> {
&self.cache_control
}
/// <p>Specifies presentational information for the object.</p>
pub fn content_disposition(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.content_disposition = ::std::option::Option::Some(input.into());
self
}
/// <p>Specifies presentational information for the object.</p>
pub fn set_content_disposition(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.content_disposition = input;
self
}
/// <p>Specifies presentational information for the object.</p>
pub fn get_content_disposition(&self) -> &::std::option::Option<::std::string::String> {
&self.content_disposition
}
/// <p>Indicates 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.</p>
pub fn content_encoding(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.content_encoding = ::std::option::Option::Some(input.into());
self
}
/// <p>Indicates 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.</p>
pub fn set_content_encoding(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.content_encoding = input;
self
}
/// <p>Indicates 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.</p>
pub fn get_content_encoding(&self) -> &::std::option::Option<::std::string::String> {
&self.content_encoding
}
/// <p>The language the content is in.</p>
pub fn content_language(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.content_language = ::std::option::Option::Some(input.into());
self
}
/// <p>The language the content is in.</p>
pub fn set_content_language(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.content_language = input;
self
}
/// <p>The language the content is in.</p>
pub fn get_content_language(&self) -> &::std::option::Option<::std::string::String> {
&self.content_language
}
/// <p>A standard MIME type describing the format of the object data.</p>
pub fn content_type(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.content_type = ::std::option::Option::Some(input.into());
self
}
/// <p>A standard MIME type describing the format of the object data.</p>
pub fn set_content_type(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.content_type = input;
self
}
/// <p>A standard MIME type describing the format of the object data.</p>
pub fn get_content_type(&self) -> &::std::option::Option<::std::string::String> {
&self.content_type
}
/// <p>The portion of the object returned in the response for a <code>GET</code> request.</p>
pub fn content_range(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.content_range = ::std::option::Option::Some(input.into());
self
}
/// <p>The portion of the object returned in the response for a <code>GET</code> request.</p>
pub fn set_content_range(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.content_range = input;
self
}
/// <p>The portion of the object returned in the response for a <code>GET</code> request.</p>
pub fn get_content_range(&self) -> &::std::option::Option<::std::string::String> {
&self.content_range
}
/// <p>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.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn website_redirect_location(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.website_redirect_location = ::std::option::Option::Some(input.into());
self
}
/// <p>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.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn set_website_redirect_location(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.website_redirect_location = input;
self
}
/// <p>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.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn get_website_redirect_location(&self) -> &::std::option::Option<::std::string::String> {
&self.website_redirect_location
}
/// <p>The server-side encryption algorithm used when you store this object in Amazon S3 or Amazon FSx.</p><note>
/// <p>When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side encryption option is <code>aws:fsx</code>.</p>
/// </note>
pub fn server_side_encryption(mut self, input: crate::types::ServerSideEncryption) -> Self {
self.server_side_encryption = ::std::option::Option::Some(input);
self
}
/// <p>The server-side encryption algorithm used when you store this object in Amazon S3 or Amazon FSx.</p><note>
/// <p>When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side encryption option is <code>aws:fsx</code>.</p>
/// </note>
pub fn set_server_side_encryption(mut self, input: ::std::option::Option<crate::types::ServerSideEncryption>) -> Self {
self.server_side_encryption = input;
self
}
/// <p>The server-side encryption algorithm used when you store this object in Amazon S3 or Amazon FSx.</p><note>
/// <p>When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side encryption option is <code>aws:fsx</code>.</p>
/// </note>
pub fn get_server_side_encryption(&self) -> &::std::option::Option<crate::types::ServerSideEncryption> {
&self.server_side_encryption
}
/// Adds a key-value pair to `metadata`.
///
/// To override the contents of this collection use [`set_metadata`](Self::set_metadata).
///
/// <p>A map of metadata to store with the object in S3.</p>
pub fn metadata(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut hash_map = self.metadata.unwrap_or_default();
hash_map.insert(k.into(), v.into());
self.metadata = ::std::option::Option::Some(hash_map);
self
}
/// <p>A map of metadata to store with the object in S3.</p>
pub fn set_metadata(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
self.metadata = input;
self
}
/// <p>A map of metadata to store with the object in S3.</p>
pub fn get_metadata(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
&self.metadata
}
/// <p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn sse_customer_algorithm(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.sse_customer_algorithm = ::std::option::Option::Some(input.into());
self
}
/// <p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn set_sse_customer_algorithm(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.sse_customer_algorithm = input;
self
}
/// <p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn get_sse_customer_algorithm(&self) -> &::std::option::Option<::std::string::String> {
&self.sse_customer_algorithm
}
/// <p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn sse_customer_key_md5(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.sse_customer_key_md5 = ::std::option::Option::Some(input.into());
self
}
/// <p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn set_sse_customer_key_md5(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.sse_customer_key_md5 = input;
self
}
/// <p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn get_sse_customer_key_md5(&self) -> &::std::option::Option<::std::string::String> {
&self.sse_customer_key_md5
}
/// <p>If present, indicates the ID of the KMS key that was used for object encryption.</p>
pub fn ssekms_key_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.ssekms_key_id = ::std::option::Option::Some(input.into());
self
}
/// <p>If present, indicates the ID of the KMS key that was used for object encryption.</p>
pub fn set_ssekms_key_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.ssekms_key_id = input;
self
}
/// <p>If present, indicates the ID of the KMS key that was used for object encryption.</p>
pub fn get_ssekms_key_id(&self) -> &::std::option::Option<::std::string::String> {
&self.ssekms_key_id
}
/// <p>Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).</p>
pub fn bucket_key_enabled(mut self, input: bool) -> Self {
self.bucket_key_enabled = ::std::option::Option::Some(input);
self
}
/// <p>Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).</p>
pub fn set_bucket_key_enabled(mut self, input: ::std::option::Option<bool>) -> Self {
self.bucket_key_enabled = input;
self
}
/// <p>Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).</p>
pub fn get_bucket_key_enabled(&self) -> &::std::option::Option<bool> {
&self.bucket_key_enabled
}
/// <p>Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a>.</p><note>
/// <p><b>Directory buckets </b> - Directory buckets only support <code>EXPRESS_ONEZONE</code> (the S3 Express One Zone storage class) in Availability Zones and <code>ONEZONE_IA</code> (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.</p>
/// </note>
pub fn storage_class(mut self, input: crate::types::StorageClass) -> Self {
self.storage_class = ::std::option::Option::Some(input);
self
}
/// <p>Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a>.</p><note>
/// <p><b>Directory buckets </b> - Directory buckets only support <code>EXPRESS_ONEZONE</code> (the S3 Express One Zone storage class) in Availability Zones and <code>ONEZONE_IA</code> (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.</p>
/// </note>
pub fn set_storage_class(mut self, input: ::std::option::Option<crate::types::StorageClass>) -> Self {
self.storage_class = input;
self
}
/// <p>Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a>.</p><note>
/// <p><b>Directory buckets </b> - Directory buckets only support <code>EXPRESS_ONEZONE</code> (the S3 Express One Zone storage class) in Availability Zones and <code>ONEZONE_IA</code> (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.</p>
/// </note>
pub fn get_storage_class(&self) -> &::std::option::Option<crate::types::StorageClass> {
&self.storage_class
}
/// <p>If present, indicates that the requester was successfully charged for the request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html">Using Requester Pays buckets for storage transfers and usage</a> in the <i>Amazon Simple Storage Service user guide</i>.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn request_charged(mut self, input: crate::types::RequestCharged) -> Self {
self.request_charged = ::std::option::Option::Some(input);
self
}
/// <p>If present, indicates that the requester was successfully charged for the request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html">Using Requester Pays buckets for storage transfers and usage</a> in the <i>Amazon Simple Storage Service user guide</i>.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn set_request_charged(mut self, input: ::std::option::Option<crate::types::RequestCharged>) -> Self {
self.request_charged = input;
self
}
/// <p>If present, indicates that the requester was successfully charged for the request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html">Using Requester Pays buckets for storage transfers and usage</a> in the <i>Amazon Simple Storage Service user guide</i>.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn get_request_charged(&self) -> &::std::option::Option<crate::types::RequestCharged> {
&self.request_charged
}
/// <p>Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule.</p>
/// <p>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 (<code>GetObject</code>) or object metadata (<code>HeadObject</code>) from these buckets, Amazon S3 will return the <code>x-amz-replication-status</code> header in the response as follows:</p>
/// <ul>
/// <li>
/// <p><b>If requesting an object from the source bucket</b>, Amazon S3 will return the <code>x-amz-replication-status</code> header if the object in your request is eligible for replication.</p>
/// <p>For example, suppose that in your replication configuration, you specify object prefix <code>TaxDocs</code> requesting Amazon S3 to replicate objects with key prefix <code>TaxDocs</code>. Any objects you upload with this key name prefix, for example <code>TaxDocs/document1.pdf</code>, are eligible for replication. For any object request with this key name prefix, Amazon S3 will return the <code>x-amz-replication-status</code> header with value PENDING, COMPLETED or FAILED indicating object replication status.</p></li>
/// <li>
/// <p><b>If requesting an object from a destination bucket</b>, Amazon S3 will return the <code>x-amz-replication-status</code> 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.</p></li>
/// <li>
/// <p><b>When replicating objects to multiple destination buckets</b>, the <code>x-amz-replication-status</code> 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.</p></li>
/// </ul>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Replication</a>.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn replication_status(mut self, input: crate::types::ReplicationStatus) -> Self {
self.replication_status = ::std::option::Option::Some(input);
self
}
/// <p>Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule.</p>
/// <p>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 (<code>GetObject</code>) or object metadata (<code>HeadObject</code>) from these buckets, Amazon S3 will return the <code>x-amz-replication-status</code> header in the response as follows:</p>
/// <ul>
/// <li>
/// <p><b>If requesting an object from the source bucket</b>, Amazon S3 will return the <code>x-amz-replication-status</code> header if the object in your request is eligible for replication.</p>
/// <p>For example, suppose that in your replication configuration, you specify object prefix <code>TaxDocs</code> requesting Amazon S3 to replicate objects with key prefix <code>TaxDocs</code>. Any objects you upload with this key name prefix, for example <code>TaxDocs/document1.pdf</code>, are eligible for replication. For any object request with this key name prefix, Amazon S3 will return the <code>x-amz-replication-status</code> header with value PENDING, COMPLETED or FAILED indicating object replication status.</p></li>
/// <li>
/// <p><b>If requesting an object from a destination bucket</b>, Amazon S3 will return the <code>x-amz-replication-status</code> 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.</p></li>
/// <li>
/// <p><b>When replicating objects to multiple destination buckets</b>, the <code>x-amz-replication-status</code> 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.</p></li>
/// </ul>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Replication</a>.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn set_replication_status(mut self, input: ::std::option::Option<crate::types::ReplicationStatus>) -> Self {
self.replication_status = input;
self
}
/// <p>Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule.</p>
/// <p>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 (<code>GetObject</code>) or object metadata (<code>HeadObject</code>) from these buckets, Amazon S3 will return the <code>x-amz-replication-status</code> header in the response as follows:</p>
/// <ul>
/// <li>
/// <p><b>If requesting an object from the source bucket</b>, Amazon S3 will return the <code>x-amz-replication-status</code> header if the object in your request is eligible for replication.</p>
/// <p>For example, suppose that in your replication configuration, you specify object prefix <code>TaxDocs</code> requesting Amazon S3 to replicate objects with key prefix <code>TaxDocs</code>. Any objects you upload with this key name prefix, for example <code>TaxDocs/document1.pdf</code>, are eligible for replication. For any object request with this key name prefix, Amazon S3 will return the <code>x-amz-replication-status</code> header with value PENDING, COMPLETED or FAILED indicating object replication status.</p></li>
/// <li>
/// <p><b>If requesting an object from a destination bucket</b>, Amazon S3 will return the <code>x-amz-replication-status</code> 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.</p></li>
/// <li>
/// <p><b>When replicating objects to multiple destination buckets</b>, the <code>x-amz-replication-status</code> 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.</p></li>
/// </ul>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Replication</a>.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn get_replication_status(&self) -> &::std::option::Option<crate::types::ReplicationStatus> {
&self.replication_status
}
/// <p>The count of parts this object has. This value is only returned if you specify <code>partNumber</code> in your request and the object was uploaded as a multipart upload.</p>
pub fn parts_count(mut self, input: i32) -> Self {
self.parts_count = ::std::option::Option::Some(input);
self
}
/// <p>The count of parts this object has. This value is only returned if you specify <code>partNumber</code> in your request and the object was uploaded as a multipart upload.</p>
pub fn set_parts_count(mut self, input: ::std::option::Option<i32>) -> Self {
self.parts_count = input;
self
}
/// <p>The count of parts this object has. This value is only returned if you specify <code>partNumber</code> in your request and the object was uploaded as a multipart upload.</p>
pub fn get_parts_count(&self) -> &::std::option::Option<i32> {
&self.parts_count
}
/// <p>The number of tags, if any, on the object, when you have the relevant permission to read object tags.</p>
/// <p>You can use <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html">GetObjectTagging</a> to retrieve the tag set associated with an object.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn tag_count(mut self, input: i32) -> Self {
self.tag_count = ::std::option::Option::Some(input);
self
}
/// <p>The number of tags, if any, on the object, when you have the relevant permission to read object tags.</p>
/// <p>You can use <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html">GetObjectTagging</a> to retrieve the tag set associated with an object.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn set_tag_count(mut self, input: ::std::option::Option<i32>) -> Self {
self.tag_count = input;
self
}
/// <p>The number of tags, if any, on the object, when you have the relevant permission to read object tags.</p>
/// <p>You can use <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html">GetObjectTagging</a> to retrieve the tag set associated with an object.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn get_tag_count(&self) -> &::std::option::Option<i32> {
&self.tag_count
}
/// <p>The Object Lock mode, if any, that's in effect for this object. This header is only returned if the requester has the <code>s3:GetObjectRetention</code> permission. For more information about S3 Object Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Object Lock</a>.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn object_lock_mode(mut self, input: crate::types::ObjectLockMode) -> Self {
self.object_lock_mode = ::std::option::Option::Some(input);
self
}
/// <p>The Object Lock mode, if any, that's in effect for this object. This header is only returned if the requester has the <code>s3:GetObjectRetention</code> permission. For more information about S3 Object Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Object Lock</a>.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn set_object_lock_mode(mut self, input: ::std::option::Option<crate::types::ObjectLockMode>) -> Self {
self.object_lock_mode = input;
self
}
/// <p>The Object Lock mode, if any, that's in effect for this object. This header is only returned if the requester has the <code>s3:GetObjectRetention</code> permission. For more information about S3 Object Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Object Lock</a>.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn get_object_lock_mode(&self) -> &::std::option::Option<crate::types::ObjectLockMode> {
&self.object_lock_mode
}
/// <p>The date and time when the Object Lock retention period expires. This header is only returned if the requester has the <code>s3:GetObjectRetention</code> permission.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn object_lock_retain_until_date(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.object_lock_retain_until_date = ::std::option::Option::Some(input);
self
}
/// <p>The date and time when the Object Lock retention period expires. This header is only returned if the requester has the <code>s3:GetObjectRetention</code> permission.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn set_object_lock_retain_until_date(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.object_lock_retain_until_date = input;
self
}
/// <p>The date and time when the Object Lock retention period expires. This header is only returned if the requester has the <code>s3:GetObjectRetention</code> permission.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn get_object_lock_retain_until_date(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
&self.object_lock_retain_until_date
}
/// <p>Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has the <code>s3:GetObjectLegalHold</code> 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Object Lock</a>.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn object_lock_legal_hold_status(mut self, input: crate::types::ObjectLockLegalHoldStatus) -> Self {
self.object_lock_legal_hold_status = ::std::option::Option::Some(input);
self
}
/// <p>Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has the <code>s3:GetObjectLegalHold</code> 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Object Lock</a>.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn set_object_lock_legal_hold_status(mut self, input: ::std::option::Option<crate::types::ObjectLockLegalHoldStatus>) -> Self {
self.object_lock_legal_hold_status = input;
self
}
/// <p>Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has the <code>s3:GetObjectLegalHold</code> 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Object Lock</a>.</p><note>
/// <p>This functionality is not supported for directory buckets.</p>
/// </note>
pub fn get_object_lock_legal_hold_status(&self) -> &::std::option::Option<crate::types::ObjectLockLegalHoldStatus> {
&self.object_lock_legal_hold_status
}
/// <p>The date and time at which the object is no longer cacheable.</p>
#[deprecated(note = "Please use `expires_string` which contains the raw, unparsed value of this field.")]
pub fn expires(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.expires = ::std::option::Option::Some(input);
self
}
/// <p>The date and time at which the object is no longer cacheable.</p>
#[deprecated(note = "Please use `expires_string` which contains the raw, unparsed value of this field.")]
pub fn set_expires(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.expires = input;
self
}
/// <p>The date and time at which the object is no longer cacheable.</p>
#[deprecated(note = "Please use `expires_string` which contains the raw, unparsed value of this field.")]
pub fn get_expires(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
&self.expires
}
/// <p>The date and time at which the object is no longer cacheable.</p>
pub fn expires_string(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.expires_string = ::std::option::Option::Some(input.into());
self
}
/// <p>The date and time at which the object is no longer cacheable.</p>
pub fn set_expires_string(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.expires_string = input;
self
}
/// <p>The date and time at which the object is no longer cacheable.</p>
pub fn get_expires_string(&self) -> &::std::option::Option<::std::string::String> {
&self.expires_string
}
pub(crate) fn _extended_request_id(mut self, extended_request_id: impl Into<String>) -> Self {
self._extended_request_id = Some(extended_request_id.into());
self
}
pub(crate) fn _set_extended_request_id(&mut self, extended_request_id: Option<String>) -> &mut Self {
self._extended_request_id = extended_request_id;
self
}
pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
self._request_id = Some(request_id.into());
self
}
pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
self._request_id = request_id;
self
}
/// Consumes the builder and constructs a [`HeadObjectOutput`](crate::operation::head_object::HeadObjectOutput).
pub fn build(self) -> crate::operation::head_object::HeadObjectOutput {
crate::operation::head_object::HeadObjectOutput {
delete_marker: self.delete_marker,
accept_ranges: self.accept_ranges,
expiration: self.expiration,
restore: self.restore,
archive_status: self.archive_status,
last_modified: self.last_modified,
content_length: self.content_length,
checksum_crc32: self.checksum_crc32,
checksum_crc32_c: self.checksum_crc32_c,
checksum_crc64_nvme: self.checksum_crc64_nvme,
checksum_sha1: self.checksum_sha1,
checksum_sha256: self.checksum_sha256,
checksum_type: self.checksum_type,
e_tag: self.e_tag,
missing_meta: self.missing_meta,
version_id: self.version_id,
cache_control: self.cache_control,
content_disposition: self.content_disposition,
content_encoding: self.content_encoding,
content_language: self.content_language,
content_type: self.content_type,
content_range: self.content_range,
website_redirect_location: self.website_redirect_location,
server_side_encryption: self.server_side_encryption,
metadata: self.metadata,
sse_customer_algorithm: self.sse_customer_algorithm,
sse_customer_key_md5: self.sse_customer_key_md5,
ssekms_key_id: self.ssekms_key_id,
bucket_key_enabled: self.bucket_key_enabled,
storage_class: self.storage_class,
request_charged: self.request_charged,
replication_status: self.replication_status,
parts_count: self.parts_count,
tag_count: self.tag_count,
object_lock_mode: self.object_lock_mode,
object_lock_retain_until_date: self.object_lock_retain_until_date,
object_lock_legal_hold_status: self.object_lock_legal_hold_status,
expires: self.expires,
expires_string: self.expires_string,
_extended_request_id: self._extended_request_id,
_request_id: self._request_id,
}
}
}
impl ::std::fmt::Debug for HeadObjectOutputBuilder {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
let mut formatter = f.debug_struct("HeadObjectOutputBuilder");
formatter.field("delete_marker", &self.delete_marker);
formatter.field("accept_ranges", &self.accept_ranges);
formatter.field("expiration", &self.expiration);
formatter.field("restore", &self.restore);
formatter.field("archive_status", &self.archive_status);
formatter.field("last_modified", &self.last_modified);
formatter.field("content_length", &self.content_length);
formatter.field("checksum_crc32", &self.checksum_crc32);
formatter.field("checksum_crc32_c", &self.checksum_crc32_c);
formatter.field("checksum_crc64_nvme", &self.checksum_crc64_nvme);
formatter.field("checksum_sha1", &self.checksum_sha1);
formatter.field("checksum_sha256", &self.checksum_sha256);
formatter.field("checksum_type", &self.checksum_type);
formatter.field("e_tag", &self.e_tag);
formatter.field("missing_meta", &self.missing_meta);
formatter.field("version_id", &self.version_id);
formatter.field("cache_control", &self.cache_control);
formatter.field("content_disposition", &self.content_disposition);
formatter.field("content_encoding", &self.content_encoding);
formatter.field("content_language", &self.content_language);
formatter.field("content_type", &self.content_type);
formatter.field("content_range", &self.content_range);
formatter.field("website_redirect_location", &self.website_redirect_location);
formatter.field("server_side_encryption", &self.server_side_encryption);
formatter.field("metadata", &self.metadata);
formatter.field("sse_customer_algorithm", &self.sse_customer_algorithm);
formatter.field("sse_customer_key_md5", &self.sse_customer_key_md5);
formatter.field("ssekms_key_id", &"*** Sensitive Data Redacted ***");
formatter.field("bucket_key_enabled", &self.bucket_key_enabled);
formatter.field("storage_class", &self.storage_class);
formatter.field("request_charged", &self.request_charged);
formatter.field("replication_status", &self.replication_status);
formatter.field("parts_count", &self.parts_count);
formatter.field("tag_count", &self.tag_count);
formatter.field("object_lock_mode", &self.object_lock_mode);
formatter.field("object_lock_retain_until_date", &self.object_lock_retain_until_date);
formatter.field("object_lock_legal_hold_status", &self.object_lock_legal_hold_status);
formatter.field("expires", &self.expires);
formatter.field("expires_string", &self.expires_string);
formatter.field("_extended_request_id", &self._extended_request_id);
formatter.field("_request_id", &self._request_id);
formatter.finish()
}
}