Struct bonsaidb::keystorage::s3::aws_sdk_s3::operation::get_object::builders::GetObjectInputBuilder

#[non_exhaustive]
pub struct GetObjectInputBuilder { /* private fields */ }

A builder for GetObjectInput.

Implementations

impl GetObjectInputBuilder

pub fn bucket(self, input: impl Into<String>) -> GetObjectInputBuilder

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 set_bucket(self, input: Option<String>) -> GetObjectInputBuilder

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 get_bucket(&self) -> &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.

pub fn if_match(self, input: impl Into<String>) -> GetObjectInputBuilder

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 set_if_match(self, input: Option<String>) -> GetObjectInputBuilder

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 get_if_match(&self) -> &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.

pub fn if_modified_since(self, input: DateTime) -> GetObjectInputBuilder

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

pub fn set_if_modified_since( self, input: Option<DateTime> ) -> GetObjectInputBuilder

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

pub fn get_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, input: impl Into<String>) -> GetObjectInputBuilder

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

pub fn set_if_none_match(self, input: Option<String>) -> GetObjectInputBuilder

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

pub fn get_if_none_match(&self) -> &Option<String>

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, input: DateTime) -> GetObjectInputBuilder

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

pub fn set_if_unmodified_since( self, input: Option<DateTime> ) -> GetObjectInputBuilder

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

pub fn get_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 key(self, input: impl Into<String>) -> GetObjectInputBuilder

Key of the object to get.

pub fn set_key(self, input: Option<String>) -> GetObjectInputBuilder

Key of the object to get.

pub fn get_key(&self) -> &Option<String>

Key of the object to get.

pub fn range(self, input: impl Into<String>) -> GetObjectInputBuilder

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 set_range(self, input: Option<String>) -> GetObjectInputBuilder

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 get_range(&self) -> &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.

pub fn response_cache_control( self, input: impl Into<String> ) -> GetObjectInputBuilder

Sets the Cache-Control header of the response.

pub fn set_response_cache_control( self, input: Option<String> ) -> GetObjectInputBuilder

Sets the Cache-Control header of the response.

pub fn get_response_cache_control(&self) -> &Option<String>

Sets the Cache-Control header of the response.

pub fn response_content_disposition( self, input: impl Into<String> ) -> GetObjectInputBuilder

Sets the Content-Disposition header of the response

pub fn set_response_content_disposition( self, input: Option<String> ) -> GetObjectInputBuilder

Sets the Content-Disposition header of the response

pub fn get_response_content_disposition(&self) -> &Option<String>

Sets the Content-Disposition header of the response

pub fn response_content_encoding( self, input: impl Into<String> ) -> GetObjectInputBuilder

Sets the Content-Encoding header of the response.

pub fn set_response_content_encoding( self, input: Option<String> ) -> GetObjectInputBuilder

Sets the Content-Encoding header of the response.

pub fn get_response_content_encoding(&self) -> &Option<String>

Sets the Content-Encoding header of the response.

pub fn response_content_language( self, input: impl Into<String> ) -> GetObjectInputBuilder

Sets the Content-Language header of the response.

pub fn set_response_content_language( self, input: Option<String> ) -> GetObjectInputBuilder

Sets the Content-Language header of the response.

pub fn get_response_content_language(&self) -> &Option<String>

Sets the Content-Language header of the response.

pub fn response_content_type( self, input: impl Into<String> ) -> GetObjectInputBuilder

Sets the Content-Type header of the response.

pub fn set_response_content_type( self, input: Option<String> ) -> GetObjectInputBuilder

Sets the Content-Type header of the response.

pub fn get_response_content_type(&self) -> &Option<String>

Sets the Content-Type header of the response.

pub fn response_expires(self, input: DateTime) -> GetObjectInputBuilder

Sets the Expires header of the response.

pub fn set_response_expires( self, input: Option<DateTime> ) -> GetObjectInputBuilder

Sets the Expires header of the response.

pub fn get_response_expires(&self) -> &Option<DateTime>

Sets the Expires header of the response.

pub fn version_id(self, input: impl Into<String>) -> GetObjectInputBuilder

VersionId used to reference a specific version of the object.

pub fn set_version_id(self, input: Option<String>) -> GetObjectInputBuilder

VersionId used to reference a specific version of the object.

pub fn get_version_id(&self) -> &Option<String>

VersionId used to reference a specific version of the object.

pub fn sse_customer_algorithm( self, input: impl Into<String> ) -> GetObjectInputBuilder

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

pub fn set_sse_customer_algorithm( self, input: Option<String> ) -> GetObjectInputBuilder

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

pub fn get_sse_customer_algorithm(&self) -> &Option<String>

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

pub fn sse_customer_key(self, input: impl Into<String>) -> GetObjectInputBuilder

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 set_sse_customer_key( self, input: Option<String> ) -> GetObjectInputBuilder

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 get_sse_customer_key(&self) -> &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.

pub fn sse_customer_key_md5( self, input: impl Into<String> ) -> GetObjectInputBuilder

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 set_sse_customer_key_md5( self, input: Option<String> ) -> GetObjectInputBuilder

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 get_sse_customer_key_md5(&self) -> &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.

pub fn request_payer(self, input: RequestPayer) -> GetObjectInputBuilder

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 set_request_payer( self, input: Option<RequestPayer> ) -> GetObjectInputBuilder

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 get_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, input: i32) -> GetObjectInputBuilder

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 set_part_number(self, input: Option<i32>) -> GetObjectInputBuilder

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 get_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, input: impl Into<String> ) -> GetObjectInputBuilder

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 set_expected_bucket_owner( self, input: Option<String> ) -> GetObjectInputBuilder

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 get_expected_bucket_owner(&self) -> &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).

pub fn checksum_mode(self, input: ChecksumMode) -> GetObjectInputBuilder

To retrieve the checksum, this mode must be enabled.

pub fn set_checksum_mode( self, input: Option<ChecksumMode> ) -> GetObjectInputBuilder

To retrieve the checksum, this mode must be enabled.

pub fn get_checksum_mode(&self) -> &Option<ChecksumMode>

To retrieve the checksum, this mode must be enabled.

pub fn build(self) -> Result<GetObjectInput, BuildError>

Consumes the builder and constructs a GetObjectInput.

impl GetObjectInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<GetObjectOutput, SdkError<GetObjectError, Response<SdkBody>>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for GetObjectInputBuilder

fn clone(&self) -> GetObjectInputBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetObjectInputBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for GetObjectInputBuilder

fn default() -> GetObjectInputBuilder

Returns the “default value” for a type.

impl PartialEq for GetObjectInputBuilder

fn eq(&self, other: &GetObjectInputBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GetObjectInputBuilder