Struct aws_sdk_s3::operation::head_object::builders::HeadObjectOutputBuilder
source · #[non_exhaustive]pub struct HeadObjectOutputBuilder { /* private fields */ }
Expand description
A builder for HeadObjectOutput
.
Implementations§
source§impl HeadObjectOutputBuilder
impl HeadObjectOutputBuilder
sourcepub fn delete_marker(self, input: bool) -> Self
pub fn delete_marker(self, input: bool) -> Self
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.
This functionality is not supported for directory buckets.
sourcepub fn set_delete_marker(self, input: Option<bool>) -> Self
pub fn set_delete_marker(self, input: Option<bool>) -> Self
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.
This functionality is not supported for directory buckets.
sourcepub fn get_delete_marker(&self) -> &Option<bool>
pub fn get_delete_marker(&self) -> &Option<bool>
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.
This functionality is not supported for directory buckets.
sourcepub fn accept_ranges(self, input: impl Into<String>) -> Self
pub fn accept_ranges(self, input: impl Into<String>) -> Self
Indicates that a range of bytes was specified.
sourcepub fn set_accept_ranges(self, input: Option<String>) -> Self
pub fn set_accept_ranges(self, input: Option<String>) -> Self
Indicates that a range of bytes was specified.
sourcepub fn get_accept_ranges(&self) -> &Option<String>
pub fn get_accept_ranges(&self) -> &Option<String>
Indicates that a range of bytes was specified.
sourcepub fn expiration(self, input: impl Into<String>) -> Self
pub fn expiration(self, input: impl Into<String>) -> Self
If the object expiration is configured (see PutBucketLifecycleConfiguration
), the response includes this header. It includes the expiry-date
and rule-id
key-value pairs providing object expiration information. The value of the rule-id
is URL-encoded.
This functionality is not supported for directory buckets.
sourcepub fn set_expiration(self, input: Option<String>) -> Self
pub fn set_expiration(self, input: Option<String>) -> Self
If the object expiration is configured (see PutBucketLifecycleConfiguration
), the response includes this header. It includes the expiry-date
and rule-id
key-value pairs providing object expiration information. The value of the rule-id
is URL-encoded.
This functionality is not supported for directory buckets.
sourcepub fn get_expiration(&self) -> &Option<String>
pub fn get_expiration(&self) -> &Option<String>
If the object expiration is configured (see PutBucketLifecycleConfiguration
), the response includes this header. It includes the expiry-date
and rule-id
key-value pairs providing object expiration information. The value of the rule-id
is URL-encoded.
This functionality is not supported for directory buckets.
sourcepub fn restore(self, input: impl Into<String>) -> Self
pub fn restore(self, input: impl Into<String>) -> Self
If the object is an archived object (an object whose storage class is GLACIER), the response includes this header if either the archive restoration is in progress (see RestoreObject or an archive copy is already restored.
If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:
x-amz-restore: ongoing-request="false", expiry-date="Fri, 21 Dec 2012 00:00:00 GMT"
If the object restoration is in progress, the header returns the value ongoing-request="true"
.
For more information about archiving objects, see Transitioning Objects: General Considerations.
This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
sourcepub fn set_restore(self, input: Option<String>) -> Self
pub fn set_restore(self, input: Option<String>) -> Self
If the object is an archived object (an object whose storage class is GLACIER), the response includes this header if either the archive restoration is in progress (see RestoreObject or an archive copy is already restored.
If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:
x-amz-restore: ongoing-request="false", expiry-date="Fri, 21 Dec 2012 00:00:00 GMT"
If the object restoration is in progress, the header returns the value ongoing-request="true"
.
For more information about archiving objects, see Transitioning Objects: General Considerations.
This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
sourcepub fn get_restore(&self) -> &Option<String>
pub fn get_restore(&self) -> &Option<String>
If the object is an archived object (an object whose storage class is GLACIER), the response includes this header if either the archive restoration is in progress (see RestoreObject or an archive copy is already restored.
If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:
x-amz-restore: ongoing-request="false", expiry-date="Fri, 21 Dec 2012 00:00:00 GMT"
If the object restoration is in progress, the header returns the value ongoing-request="true"
.
For more information about archiving objects, see Transitioning Objects: General Considerations.
This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
sourcepub fn archive_status(self, input: ArchiveStatus) -> Self
pub fn archive_status(self, input: ArchiveStatus) -> Self
The archive state of the head object.
This functionality is not supported for directory buckets.
sourcepub fn set_archive_status(self, input: Option<ArchiveStatus>) -> Self
pub fn set_archive_status(self, input: Option<ArchiveStatus>) -> Self
The archive state of the head object.
This functionality is not supported for directory buckets.
sourcepub fn get_archive_status(&self) -> &Option<ArchiveStatus>
pub fn get_archive_status(&self) -> &Option<ArchiveStatus>
The archive state of the head object.
This functionality is not supported for directory buckets.
sourcepub fn last_modified(self, input: DateTime) -> Self
pub fn last_modified(self, input: DateTime) -> Self
Date and time when the object was last modified.
sourcepub fn set_last_modified(self, input: Option<DateTime>) -> Self
pub fn set_last_modified(self, input: Option<DateTime>) -> Self
Date and time when the object was last modified.
sourcepub fn get_last_modified(&self) -> &Option<DateTime>
pub fn get_last_modified(&self) -> &Option<DateTime>
Date and time when the object was last modified.
sourcepub fn content_length(self, input: i64) -> Self
pub fn content_length(self, input: i64) -> Self
Size of the body in bytes.
sourcepub fn set_content_length(self, input: Option<i64>) -> Self
pub fn set_content_length(self, input: Option<i64>) -> Self
Size of the body in bytes.
sourcepub fn get_content_length(&self) -> &Option<i64>
pub fn get_content_length(&self) -> &Option<i64>
Size of the body in bytes.
sourcepub fn checksum_crc32(self, input: impl Into<String>) -> Self
pub fn checksum_crc32(self, input: impl Into<String>) -> Self
The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it 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 Checking object integrity in the Amazon S3 User Guide.
sourcepub fn set_checksum_crc32(self, input: Option<String>) -> Self
pub fn set_checksum_crc32(self, input: Option<String>) -> Self
The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it 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 Checking object integrity in the Amazon S3 User Guide.
sourcepub fn get_checksum_crc32(&self) -> &Option<String>
pub fn get_checksum_crc32(&self) -> &Option<String>
The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it 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 Checking object integrity in the Amazon S3 User Guide.
sourcepub fn checksum_crc32_c(self, input: impl Into<String>) -> Self
pub fn checksum_crc32_c(self, input: impl Into<String>) -> Self
The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it 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 Checking object integrity in the Amazon S3 User Guide.
sourcepub fn set_checksum_crc32_c(self, input: Option<String>) -> Self
pub fn set_checksum_crc32_c(self, input: Option<String>) -> Self
The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it 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 Checking object integrity in the Amazon S3 User Guide.
sourcepub fn get_checksum_crc32_c(&self) -> &Option<String>
pub fn get_checksum_crc32_c(&self) -> &Option<String>
The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it 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 Checking object integrity in the Amazon S3 User Guide.
sourcepub fn checksum_sha1(self, input: impl Into<String>) -> Self
pub fn checksum_sha1(self, input: impl Into<String>) -> Self
The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it 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 Checking object integrity in the Amazon S3 User Guide.
sourcepub fn set_checksum_sha1(self, input: Option<String>) -> Self
pub fn set_checksum_sha1(self, input: Option<String>) -> Self
The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it 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 Checking object integrity in the Amazon S3 User Guide.
sourcepub fn get_checksum_sha1(&self) -> &Option<String>
pub fn get_checksum_sha1(&self) -> &Option<String>
The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it 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 Checking object integrity in the Amazon S3 User Guide.
sourcepub fn checksum_sha256(self, input: impl Into<String>) -> Self
pub fn checksum_sha256(self, input: impl Into<String>) -> Self
The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it 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 Checking object integrity in the Amazon S3 User Guide.
sourcepub fn set_checksum_sha256(self, input: Option<String>) -> Self
pub fn set_checksum_sha256(self, input: Option<String>) -> Self
The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it 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 Checking object integrity in the Amazon S3 User Guide.
sourcepub fn get_checksum_sha256(&self) -> &Option<String>
pub fn get_checksum_sha256(&self) -> &Option<String>
The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it 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 Checking object integrity in the Amazon S3 User Guide.
sourcepub fn e_tag(self, input: impl Into<String>) -> Self
pub fn e_tag(self, input: impl Into<String>) -> Self
An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.
sourcepub fn set_e_tag(self, input: Option<String>) -> Self
pub fn set_e_tag(self, input: Option<String>) -> Self
An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.
sourcepub fn get_e_tag(&self) -> &Option<String>
pub fn get_e_tag(&self) -> &Option<String>
An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.
sourcepub fn missing_meta(self, input: i32) -> Self
pub fn missing_meta(self, input: i32) -> Self
This is set to the number of metadata entries not returned in x-amz-meta
headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.
This functionality is not supported for directory buckets.
sourcepub fn set_missing_meta(self, input: Option<i32>) -> Self
pub fn set_missing_meta(self, input: Option<i32>) -> Self
This is set to the number of metadata entries not returned in x-amz-meta
headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.
This functionality is not supported for directory buckets.
sourcepub fn get_missing_meta(&self) -> &Option<i32>
pub fn get_missing_meta(&self) -> &Option<i32>
This is set to the number of metadata entries not returned in x-amz-meta
headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.
This functionality is not supported for directory buckets.
sourcepub fn version_id(self, input: impl Into<String>) -> Self
pub fn version_id(self, input: impl Into<String>) -> Self
Version ID of the object.
This functionality is not supported for directory buckets.
sourcepub fn set_version_id(self, input: Option<String>) -> Self
pub fn set_version_id(self, input: Option<String>) -> Self
Version ID of the object.
This functionality is not supported for directory buckets.
sourcepub fn get_version_id(&self) -> &Option<String>
pub fn get_version_id(&self) -> &Option<String>
Version ID of the object.
This functionality is not supported for directory buckets.
sourcepub fn cache_control(self, input: impl Into<String>) -> Self
pub fn cache_control(self, input: impl Into<String>) -> Self
Specifies caching behavior along the request/reply chain.
sourcepub fn set_cache_control(self, input: Option<String>) -> Self
pub fn set_cache_control(self, input: Option<String>) -> Self
Specifies caching behavior along the request/reply chain.
sourcepub fn get_cache_control(&self) -> &Option<String>
pub fn get_cache_control(&self) -> &Option<String>
Specifies caching behavior along the request/reply chain.
sourcepub fn content_disposition(self, input: impl Into<String>) -> Self
pub fn content_disposition(self, input: impl Into<String>) -> Self
Specifies presentational information for the object.
sourcepub fn set_content_disposition(self, input: Option<String>) -> Self
pub fn set_content_disposition(self, input: Option<String>) -> Self
Specifies presentational information for the object.
sourcepub fn get_content_disposition(&self) -> &Option<String>
pub fn get_content_disposition(&self) -> &Option<String>
Specifies presentational information for the object.
sourcepub fn content_encoding(self, input: impl Into<String>) -> Self
pub fn content_encoding(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_content_encoding(self, input: Option<String>) -> Self
pub fn set_content_encoding(self, input: Option<String>) -> Self
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.
sourcepub fn get_content_encoding(&self) -> &Option<String>
pub fn get_content_encoding(&self) -> &Option<String>
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.
sourcepub fn content_language(self, input: impl Into<String>) -> Self
pub fn content_language(self, input: impl Into<String>) -> Self
The language the content is in.
sourcepub fn set_content_language(self, input: Option<String>) -> Self
pub fn set_content_language(self, input: Option<String>) -> Self
The language the content is in.
sourcepub fn get_content_language(&self) -> &Option<String>
pub fn get_content_language(&self) -> &Option<String>
The language the content is in.
sourcepub fn content_type(self, input: impl Into<String>) -> Self
pub fn content_type(self, input: impl Into<String>) -> Self
A standard MIME type describing the format of the object data.
sourcepub fn set_content_type(self, input: Option<String>) -> Self
pub fn set_content_type(self, input: Option<String>) -> Self
A standard MIME type describing the format of the object data.
sourcepub fn get_content_type(&self) -> &Option<String>
pub fn get_content_type(&self) -> &Option<String>
A standard MIME type describing the format of the object data.
sourcepub fn expires(self, input: DateTime) -> Self
pub fn expires(self, input: DateTime) -> Self
The date and time at which the object is no longer cacheable.
sourcepub fn set_expires(self, input: Option<DateTime>) -> Self
pub fn set_expires(self, input: Option<DateTime>) -> Self
The date and time at which the object is no longer cacheable.
sourcepub fn get_expires(&self) -> &Option<DateTime>
pub fn get_expires(&self) -> &Option<DateTime>
The date and time at which the object is no longer cacheable.
sourcepub fn website_redirect_location(self, input: impl Into<String>) -> Self
pub fn website_redirect_location(self, input: impl Into<String>) -> Self
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.
This functionality is not supported for directory buckets.
sourcepub fn set_website_redirect_location(self, input: Option<String>) -> Self
pub fn set_website_redirect_location(self, input: Option<String>) -> Self
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.
This functionality is not supported for directory buckets.
sourcepub fn get_website_redirect_location(&self) -> &Option<String>
pub fn get_website_redirect_location(&self) -> &Option<String>
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.
This functionality is not supported for directory buckets.
sourcepub fn server_side_encryption(self, input: ServerSideEncryption) -> Self
pub fn server_side_encryption(self, input: ServerSideEncryption) -> Self
The server-side encryption algorithm used when you store this object in Amazon S3 (for example, AES256
, aws:kms
, aws:kms:dsse
).
For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256
) is supported.
sourcepub fn set_server_side_encryption(
self,
input: Option<ServerSideEncryption>,
) -> Self
pub fn set_server_side_encryption( self, input: Option<ServerSideEncryption>, ) -> Self
The server-side encryption algorithm used when you store this object in Amazon S3 (for example, AES256
, aws:kms
, aws:kms:dsse
).
For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256
) is supported.
sourcepub fn get_server_side_encryption(&self) -> &Option<ServerSideEncryption>
pub fn get_server_side_encryption(&self) -> &Option<ServerSideEncryption>
The server-side encryption algorithm used when you store this object in Amazon S3 (for example, AES256
, aws:kms
, aws:kms:dsse
).
For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256
) is supported.
sourcepub fn metadata(self, k: impl Into<String>, v: impl Into<String>) -> Self
pub fn metadata(self, k: impl Into<String>, v: impl Into<String>) -> Self
Adds a key-value pair to metadata
.
To override the contents of this collection use set_metadata
.
A map of metadata to store with the object in S3.
sourcepub fn set_metadata(self, input: Option<HashMap<String, String>>) -> Self
pub fn set_metadata(self, input: Option<HashMap<String, String>>) -> Self
A map of metadata to store with the object in S3.
sourcepub fn get_metadata(&self) -> &Option<HashMap<String, String>>
pub fn get_metadata(&self) -> &Option<HashMap<String, String>>
A map of metadata to store with the object in S3.
sourcepub fn sse_customer_algorithm(self, input: impl Into<String>) -> Self
pub fn sse_customer_algorithm(self, input: impl Into<String>) -> Self
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.
This functionality is not supported for directory buckets.
sourcepub fn set_sse_customer_algorithm(self, input: Option<String>) -> Self
pub fn set_sse_customer_algorithm(self, input: Option<String>) -> Self
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.
This functionality is not supported for directory buckets.
sourcepub fn get_sse_customer_algorithm(&self) -> &Option<String>
pub fn get_sse_customer_algorithm(&self) -> &Option<String>
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.
This functionality is not supported for directory buckets.
sourcepub fn sse_customer_key_md5(self, input: impl Into<String>) -> Self
pub fn sse_customer_key_md5(self, input: impl Into<String>) -> Self
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.
This functionality is not supported for directory buckets.
sourcepub fn set_sse_customer_key_md5(self, input: Option<String>) -> Self
pub fn set_sse_customer_key_md5(self, input: Option<String>) -> Self
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.
This functionality is not supported for directory buckets.
sourcepub fn get_sse_customer_key_md5(&self) -> &Option<String>
pub fn get_sse_customer_key_md5(&self) -> &Option<String>
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.
This functionality is not supported for directory buckets.
sourcepub fn ssekms_key_id(self, input: impl Into<String>) -> Self
pub fn ssekms_key_id(self, input: impl Into<String>) -> Self
If present, indicates the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.
This functionality is not supported for directory buckets.
sourcepub fn set_ssekms_key_id(self, input: Option<String>) -> Self
pub fn set_ssekms_key_id(self, input: Option<String>) -> Self
If present, indicates the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.
This functionality is not supported for directory buckets.
sourcepub fn get_ssekms_key_id(&self) -> &Option<String>
pub fn get_ssekms_key_id(&self) -> &Option<String>
If present, indicates the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.
This functionality is not supported for directory buckets.
sourcepub fn bucket_key_enabled(self, input: bool) -> Self
pub fn bucket_key_enabled(self, input: bool) -> Self
Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
This functionality is not supported for directory buckets.
sourcepub fn set_bucket_key_enabled(self, input: Option<bool>) -> Self
pub fn set_bucket_key_enabled(self, input: Option<bool>) -> Self
Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
This functionality is not supported for directory buckets.
sourcepub fn get_bucket_key_enabled(&self) -> &Option<bool>
pub fn get_bucket_key_enabled(&self) -> &Option<bool>
Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
This functionality is not supported for directory buckets.
sourcepub fn storage_class(self, input: StorageClass) -> Self
pub fn storage_class(self, input: StorageClass) -> Self
Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.
For more information, see Storage Classes.
Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
sourcepub fn set_storage_class(self, input: Option<StorageClass>) -> Self
pub fn set_storage_class(self, input: Option<StorageClass>) -> Self
Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.
For more information, see Storage Classes.
Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
sourcepub fn get_storage_class(&self) -> &Option<StorageClass>
pub fn get_storage_class(&self) -> &Option<StorageClass>
Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.
For more information, see Storage Classes.
Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
sourcepub fn request_charged(self, input: RequestCharged) -> Self
pub fn request_charged(self, input: RequestCharged) -> Self
If present, indicates that the requester was successfully charged for the request.
This functionality is not supported for directory buckets.
sourcepub fn set_request_charged(self, input: Option<RequestCharged>) -> Self
pub fn set_request_charged(self, input: Option<RequestCharged>) -> Self
If present, indicates that the requester was successfully charged for the request.
This functionality is not supported for directory buckets.
sourcepub fn get_request_charged(&self) -> &Option<RequestCharged>
pub fn get_request_charged(&self) -> &Option<RequestCharged>
If present, indicates that the requester was successfully charged for the request.
This functionality is not supported for directory buckets.
sourcepub fn replication_status(self, input: ReplicationStatus) -> Self
pub fn replication_status(self, input: ReplicationStatus) -> Self
Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule.
In replication, you have a source bucket on which you configure replication and destination bucket or buckets where Amazon S3 stores object replicas. When you request an object (GetObject
) or object metadata (HeadObject
) from these buckets, Amazon S3 will return the x-amz-replication-status
header in the response as follows:
-
If requesting an object from the source bucket, Amazon S3 will return the
x-amz-replication-status
header if the object in your request is eligible for replication.For example, suppose that in your replication configuration, you specify object prefix
TaxDocs
requesting Amazon S3 to replicate objects with key prefixTaxDocs
. Any objects you upload with this key name prefix, for exampleTaxDocs/document1.pdf
, are eligible for replication. For any object request with this key name prefix, Amazon S3 will return thex-amz-replication-status
header with value PENDING, COMPLETED or FAILED indicating object replication status. -
If requesting an object from a destination bucket, Amazon S3 will return the
x-amz-replication-status
header with value REPLICA if the object in your request is a replica that Amazon S3 created and there is no replica modification replication in progress. -
When replicating objects to multiple destination buckets, the
x-amz-replication-status
header acts differently. The header of the source object will only return a value of COMPLETED when replication is successful to all destinations. The header will remain at value PENDING until replication has completed for all destinations. If one or more destinations fails replication the header will return FAILED.
For more information, see Replication.
This functionality is not supported for directory buckets.
sourcepub fn set_replication_status(self, input: Option<ReplicationStatus>) -> Self
pub fn set_replication_status(self, input: Option<ReplicationStatus>) -> Self
Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule.
In replication, you have a source bucket on which you configure replication and destination bucket or buckets where Amazon S3 stores object replicas. When you request an object (GetObject
) or object metadata (HeadObject
) from these buckets, Amazon S3 will return the x-amz-replication-status
header in the response as follows:
-
If requesting an object from the source bucket, Amazon S3 will return the
x-amz-replication-status
header if the object in your request is eligible for replication.For example, suppose that in your replication configuration, you specify object prefix
TaxDocs
requesting Amazon S3 to replicate objects with key prefixTaxDocs
. Any objects you upload with this key name prefix, for exampleTaxDocs/document1.pdf
, are eligible for replication. For any object request with this key name prefix, Amazon S3 will return thex-amz-replication-status
header with value PENDING, COMPLETED or FAILED indicating object replication status. -
If requesting an object from a destination bucket, Amazon S3 will return the
x-amz-replication-status
header with value REPLICA if the object in your request is a replica that Amazon S3 created and there is no replica modification replication in progress. -
When replicating objects to multiple destination buckets, the
x-amz-replication-status
header acts differently. The header of the source object will only return a value of COMPLETED when replication is successful to all destinations. The header will remain at value PENDING until replication has completed for all destinations. If one or more destinations fails replication the header will return FAILED.
For more information, see Replication.
This functionality is not supported for directory buckets.
sourcepub fn get_replication_status(&self) -> &Option<ReplicationStatus>
pub fn get_replication_status(&self) -> &Option<ReplicationStatus>
Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule.
In replication, you have a source bucket on which you configure replication and destination bucket or buckets where Amazon S3 stores object replicas. When you request an object (GetObject
) or object metadata (HeadObject
) from these buckets, Amazon S3 will return the x-amz-replication-status
header in the response as follows:
-
If requesting an object from the source bucket, Amazon S3 will return the
x-amz-replication-status
header if the object in your request is eligible for replication.For example, suppose that in your replication configuration, you specify object prefix
TaxDocs
requesting Amazon S3 to replicate objects with key prefixTaxDocs
. Any objects you upload with this key name prefix, for exampleTaxDocs/document1.pdf
, are eligible for replication. For any object request with this key name prefix, Amazon S3 will return thex-amz-replication-status
header with value PENDING, COMPLETED or FAILED indicating object replication status. -
If requesting an object from a destination bucket, Amazon S3 will return the
x-amz-replication-status
header with value REPLICA if the object in your request is a replica that Amazon S3 created and there is no replica modification replication in progress. -
When replicating objects to multiple destination buckets, the
x-amz-replication-status
header acts differently. The header of the source object will only return a value of COMPLETED when replication is successful to all destinations. The header will remain at value PENDING until replication has completed for all destinations. If one or more destinations fails replication the header will return FAILED.
For more information, see Replication.
This functionality is not supported for directory buckets.
sourcepub fn parts_count(self, input: i32) -> Self
pub fn parts_count(self, input: i32) -> Self
The count of parts this object has. This value is only returned if you specify partNumber
in your request and the object was uploaded as a multipart upload.
sourcepub fn set_parts_count(self, input: Option<i32>) -> Self
pub fn set_parts_count(self, input: Option<i32>) -> Self
The count of parts this object has. This value is only returned if you specify partNumber
in your request and the object was uploaded as a multipart upload.
sourcepub fn get_parts_count(&self) -> &Option<i32>
pub fn get_parts_count(&self) -> &Option<i32>
The count of parts this object has. This value is only returned if you specify partNumber
in your request and the object was uploaded as a multipart upload.
sourcepub fn object_lock_mode(self, input: ObjectLockMode) -> Self
pub fn object_lock_mode(self, input: ObjectLockMode) -> Self
The Object Lock mode, if any, that's in effect for this object. This header is only returned if the requester has the s3:GetObjectRetention
permission. For more information about S3 Object Lock, see Object Lock.
This functionality is not supported for directory buckets.
sourcepub fn set_object_lock_mode(self, input: Option<ObjectLockMode>) -> Self
pub fn set_object_lock_mode(self, input: Option<ObjectLockMode>) -> Self
The Object Lock mode, if any, that's in effect for this object. This header is only returned if the requester has the s3:GetObjectRetention
permission. For more information about S3 Object Lock, see Object Lock.
This functionality is not supported for directory buckets.
sourcepub fn get_object_lock_mode(&self) -> &Option<ObjectLockMode>
pub fn get_object_lock_mode(&self) -> &Option<ObjectLockMode>
The Object Lock mode, if any, that's in effect for this object. This header is only returned if the requester has the s3:GetObjectRetention
permission. For more information about S3 Object Lock, see Object Lock.
This functionality is not supported for directory buckets.
sourcepub fn object_lock_retain_until_date(self, input: DateTime) -> Self
pub fn object_lock_retain_until_date(self, input: DateTime) -> Self
The date and time when the Object Lock retention period expires. This header is only returned if the requester has the s3:GetObjectRetention
permission.
This functionality is not supported for directory buckets.
sourcepub fn set_object_lock_retain_until_date(self, input: Option<DateTime>) -> Self
pub fn set_object_lock_retain_until_date(self, input: Option<DateTime>) -> Self
The date and time when the Object Lock retention period expires. This header is only returned if the requester has the s3:GetObjectRetention
permission.
This functionality is not supported for directory buckets.
sourcepub fn get_object_lock_retain_until_date(&self) -> &Option<DateTime>
pub fn get_object_lock_retain_until_date(&self) -> &Option<DateTime>
The date and time when the Object Lock retention period expires. This header is only returned if the requester has the s3:GetObjectRetention
permission.
This functionality is not supported for directory buckets.
sourcepub fn object_lock_legal_hold_status(
self,
input: ObjectLockLegalHoldStatus,
) -> Self
pub fn object_lock_legal_hold_status( self, input: ObjectLockLegalHoldStatus, ) -> Self
Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has the s3:GetObjectLegalHold
permission. This header is not returned if the specified version of this object has never had a legal hold applied. For more information about S3 Object Lock, see Object Lock.
This functionality is not supported for directory buckets.
sourcepub fn set_object_lock_legal_hold_status(
self,
input: Option<ObjectLockLegalHoldStatus>,
) -> Self
pub fn set_object_lock_legal_hold_status( self, input: Option<ObjectLockLegalHoldStatus>, ) -> Self
Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has the s3:GetObjectLegalHold
permission. This header is not returned if the specified version of this object has never had a legal hold applied. For more information about S3 Object Lock, see Object Lock.
This functionality is not supported for directory buckets.
sourcepub fn get_object_lock_legal_hold_status(
&self,
) -> &Option<ObjectLockLegalHoldStatus>
pub fn get_object_lock_legal_hold_status( &self, ) -> &Option<ObjectLockLegalHoldStatus>
Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has the s3:GetObjectLegalHold
permission. This header is not returned if the specified version of this object has never had a legal hold applied. For more information about S3 Object Lock, see Object Lock.
This functionality is not supported for directory buckets.
sourcepub fn build(self) -> HeadObjectOutput
pub fn build(self) -> HeadObjectOutput
Consumes the builder and constructs a HeadObjectOutput
.
Trait Implementations§
source§impl Clone for HeadObjectOutputBuilder
impl Clone for HeadObjectOutputBuilder
source§fn clone(&self) -> HeadObjectOutputBuilder
fn clone(&self) -> HeadObjectOutputBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for HeadObjectOutputBuilder
impl Debug for HeadObjectOutputBuilder
source§impl Default for HeadObjectOutputBuilder
impl Default for HeadObjectOutputBuilder
source§fn default() -> HeadObjectOutputBuilder
fn default() -> HeadObjectOutputBuilder
source§impl PartialEq for HeadObjectOutputBuilder
impl PartialEq for HeadObjectOutputBuilder
impl StructuralPartialEq for HeadObjectOutputBuilder
Auto Trait Implementations§
impl Freeze for HeadObjectOutputBuilder
impl RefUnwindSafe for HeadObjectOutputBuilder
impl Send for HeadObjectOutputBuilder
impl Sync for HeadObjectOutputBuilder
impl Unpin for HeadObjectOutputBuilder
impl UnwindSafe for HeadObjectOutputBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)