Struct bonsaidb::keystorage::s3::aws_sdk_s3::operation::head_object::builders::HeadObjectInputBuilder

pub struct HeadObjectInputBuilder { /* private fields */ }

A builder for HeadObjectInput.

Implementations

impl HeadObjectInputBuilder

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

The name of the bucket 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 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>) -> HeadObjectInputBuilder

The name of the bucket 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 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 name of the bucket 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 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>) -> HeadObjectInputBuilder

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>) -> HeadObjectInputBuilder

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) -> HeadObjectInputBuilder

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> ) -> HeadObjectInputBuilder

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>) -> HeadObjectInputBuilder

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>) -> HeadObjectInputBuilder

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) -> HeadObjectInputBuilder

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> ) -> HeadObjectInputBuilder

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>) -> HeadObjectInputBuilder

The object key.

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

The object key.

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

The object key.

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

HeadObject returns only the metadata for an object. If the Range is satisfiable, only the ContentLength is affected in the response. If the Range is not satisfiable, S3 returns a 416 - Requested Range Not Satisfiable error.

pub fn set_range(self, input: Option<String>) -> HeadObjectInputBuilder

HeadObject returns only the metadata for an object. If the Range is satisfiable, only the ContentLength is affected in the response. If the Range is not satisfiable, S3 returns a 416 - Requested Range Not Satisfiable error.

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

HeadObject returns only the metadata for an object. If the Range is satisfiable, only the ContentLength is affected in the response. If the Range is not satisfiable, S3 returns a 416 - Requested Range Not Satisfiable error.

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

VersionId used to reference a specific version of the object.

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

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> ) -> HeadObjectInputBuilder

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

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

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

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

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

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

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. 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> ) -> HeadObjectInputBuilder

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. 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 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. 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> ) -> HeadObjectInputBuilder

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> ) -> HeadObjectInputBuilder

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) -> HeadObjectInputBuilder

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> ) -> HeadObjectInputBuilder

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) -> HeadObjectInputBuilder

Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object.

pub fn set_part_number(self, input: Option<i32>) -> HeadObjectInputBuilder

Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this 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' HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object.

pub fn expected_bucket_owner( self, input: impl Into<String> ) -> HeadObjectInputBuilder

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> ) -> HeadObjectInputBuilder

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) -> HeadObjectInputBuilder

To retrieve the checksum, this parameter must be enabled.

In addition, if you enable ChecksumMode and the object is encrypted with Amazon Web Services Key Management Service (Amazon Web Services KMS), you must have permission to use the kms:Decrypt action for the request to succeed.

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

To retrieve the checksum, this parameter must be enabled.

In addition, if you enable ChecksumMode and the object is encrypted with Amazon Web Services Key Management Service (Amazon Web Services KMS), you must have permission to use the kms:Decrypt action for the request to succeed.

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

To retrieve the checksum, this parameter must be enabled.

In addition, if you enable ChecksumMode and the object is encrypted with Amazon Web Services Key Management Service (Amazon Web Services KMS), you must have permission to use the kms:Decrypt action for the request to succeed.

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

Consumes the builder and constructs a HeadObjectInput.

impl HeadObjectInputBuilder

pub async fn send_with( self, client: &Client ) -> impl Future<Output = Result<HeadObjectOutput, SdkError<HeadObjectError, Response<SdkBody>>>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for HeadObjectInputBuilder

fn clone(&self) -> HeadObjectInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HeadObjectInputBuilder

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

Formats the value using the given formatter.

impl Default for HeadObjectInputBuilder

fn default() -> HeadObjectInputBuilder

Returns the “default value” for a type.

impl PartialEq<HeadObjectInputBuilder> for HeadObjectInputBuilder

fn eq(&self, other: &HeadObjectInputBuilder) -> 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 HeadObjectInputBuilder