Struct bonsaidb::keystorage::s3::aws_sdk_s3::operation::get_object::GetObjectInput
#[non_exhaustive]pub struct GetObjectInput {Show 21 fields
pub bucket: Option<String>,
pub if_match: Option<String>,
pub if_modified_since: Option<DateTime>,
pub if_none_match: Option<String>,
pub if_unmodified_since: Option<DateTime>,
pub key: Option<String>,
pub range: Option<String>,
pub response_cache_control: Option<String>,
pub response_content_disposition: Option<String>,
pub response_content_encoding: Option<String>,
pub response_content_language: Option<String>,
pub response_content_type: Option<String>,
pub response_expires: Option<DateTime>,
pub version_id: Option<String>,
pub sse_customer_algorithm: Option<String>,
pub sse_customer_key: Option<String>,
pub sse_customer_key_md5: Option<String>,
pub request_payer: Option<RequestPayer>,
pub part_number: Option<i32>,
pub expected_bucket_owner: Option<String>,
pub checksum_mode: Option<ChecksumMode>,
}Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.bucket: Option<String>The bucket name containing the object.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When using an Object Lambda access point the hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com.
When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
if_match: Option<String>Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error.
if_modified_since: Option<DateTime>Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.
if_none_match: Option<String>Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.
if_unmodified_since: Option<DateTime>Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.
key: Option<String>Key of the object to get.
range: Option<String>Downloads the specified range bytes of an object. For more information about the HTTP Range header, see https://www.rfc-editor.org/rfc/rfc9110.html#name-range.
Amazon S3 doesn't support retrieving multiple ranges of data per GET request.
response_cache_control: Option<String>Sets the Cache-Control header of the response.
response_content_disposition: Option<String>Sets the Content-Disposition header of the response
response_content_encoding: Option<String>Sets the Content-Encoding header of the response.
response_content_language: Option<String>Sets the Content-Language header of the response.
response_content_type: Option<String>Sets the Content-Type header of the response.
response_expires: Option<DateTime>Sets the Expires header of the response.
version_id: Option<String>VersionId used to reference a specific version of the object.
sse_customer_algorithm: Option<String>Specifies the algorithm to use to when decrypting the object (for example, AES256).
sse_customer_key: Option<String>Specifies the customer-provided encryption key for Amazon S3 used to encrypt the data. This value is used to decrypt the object when recovering it and must match the one used when storing the data. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.
sse_customer_key_md5: Option<String>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
request_payer: Option<RequestPayer>Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.
part_number: Option<i32>Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object.
expected_bucket_owner: Option<String>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
checksum_mode: Option<ChecksumMode>To retrieve the checksum, this mode must be enabled.
Implementations§
§impl GetObjectInput
impl GetObjectInput
pub fn bucket(&self) -> Option<&str>
pub fn bucket(&self) -> Option<&str>
The bucket name containing the object.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When using an Object Lambda access point the hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com.
When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
pub fn if_match(&self) -> Option<&str>
pub fn if_match(&self) -> Option<&str>
Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error.
pub fn if_modified_since(&self) -> Option<&DateTime>
pub fn if_modified_since(&self) -> Option<&DateTime>
Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.
pub fn if_none_match(&self) -> Option<&str>
pub fn if_none_match(&self) -> Option<&str>
Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.
pub fn if_unmodified_since(&self) -> Option<&DateTime>
pub fn if_unmodified_since(&self) -> Option<&DateTime>
Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.
pub fn range(&self) -> Option<&str>
pub fn range(&self) -> Option<&str>
Downloads the specified range bytes of an object. For more information about the HTTP Range header, see https://www.rfc-editor.org/rfc/rfc9110.html#name-range.
Amazon S3 doesn't support retrieving multiple ranges of data per GET request.
pub fn response_cache_control(&self) -> Option<&str>
pub fn response_cache_control(&self) -> Option<&str>
Sets the Cache-Control header of the response.
pub fn response_content_disposition(&self) -> Option<&str>
pub fn response_content_disposition(&self) -> Option<&str>
Sets the Content-Disposition header of the response
pub fn response_content_encoding(&self) -> Option<&str>
pub fn response_content_encoding(&self) -> Option<&str>
Sets the Content-Encoding header of the response.
pub fn response_content_language(&self) -> Option<&str>
pub fn response_content_language(&self) -> Option<&str>
Sets the Content-Language header of the response.
pub fn response_content_type(&self) -> Option<&str>
pub fn response_content_type(&self) -> Option<&str>
Sets the Content-Type header of the response.
pub fn response_expires(&self) -> Option<&DateTime>
pub fn response_expires(&self) -> Option<&DateTime>
Sets the Expires header of the response.
pub fn version_id(&self) -> Option<&str>
pub fn version_id(&self) -> Option<&str>
VersionId used to reference a specific version of the object.
pub fn sse_customer_algorithm(&self) -> Option<&str>
pub fn sse_customer_algorithm(&self) -> Option<&str>
Specifies the algorithm to use to when decrypting the object (for example, AES256).
pub fn sse_customer_key(&self) -> Option<&str>
pub fn sse_customer_key(&self) -> Option<&str>
Specifies the customer-provided encryption key for Amazon S3 used to encrypt the data. This value is used to decrypt the object when recovering it and must match the one used when storing the data. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.
pub fn sse_customer_key_md5(&self) -> Option<&str>
pub fn sse_customer_key_md5(&self) -> Option<&str>
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
pub fn request_payer(&self) -> Option<&RequestPayer>
pub fn request_payer(&self) -> Option<&RequestPayer>
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.
pub fn part_number(&self) -> Option<i32>
pub fn part_number(&self) -> Option<i32>
Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object.
pub fn expected_bucket_owner(&self) -> Option<&str>
pub fn expected_bucket_owner(&self) -> Option<&str>
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
pub fn checksum_mode(&self) -> Option<&ChecksumMode>
pub fn checksum_mode(&self) -> Option<&ChecksumMode>
To retrieve the checksum, this mode must be enabled.
§impl GetObjectInput
impl GetObjectInput
pub fn builder() -> GetObjectInputBuilder
pub fn builder() -> GetObjectInputBuilder
Creates a new builder-style object to manufacture GetObjectInput.
Trait Implementations§
§impl Clone for GetObjectInput
impl Clone for GetObjectInput
§fn clone(&self) -> GetObjectInput
fn clone(&self) -> GetObjectInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more§impl Debug for GetObjectInput
impl Debug for GetObjectInput
§impl PartialEq for GetObjectInput
impl PartialEq for GetObjectInput
§fn eq(&self, other: &GetObjectInput) -> bool
fn eq(&self, other: &GetObjectInput) -> bool
self and other values to be equal, and is used
by ==.