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

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

Expand description

A builder for GetObjectOutput.

Implementations§

§

impl GetObjectOutputBuilder

pub fn body(self, input: ByteStream) -> GetObjectOutputBuilder

Object data.

pub fn set_body(self, input: Option<ByteStream>) -> GetObjectOutputBuilder

Object data.

pub fn get_body(&self) -> &Option<ByteStream>

Object data.

pub fn delete_marker(self, input: bool) -> GetObjectOutputBuilder

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.

pub fn set_delete_marker(self, input: Option<bool>) -> GetObjectOutputBuilder

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.

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.

pub fn accept_ranges(self, input: impl Into<String>) -> GetObjectOutputBuilder

Indicates that a range of bytes was specified.

pub fn set_accept_ranges(self, input: Option<String>) -> GetObjectOutputBuilder

Indicates that a range of bytes was specified.

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

Indicates that a range of bytes was specified.

pub fn expiration(self, input: impl Into<String>) -> GetObjectOutputBuilder

If the object expiration is configured (see PUT Bucket lifecycle), 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.

pub fn set_expiration(self, input: Option<String>) -> GetObjectOutputBuilder

If the object expiration is configured (see PUT Bucket lifecycle), 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.

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

If the object expiration is configured (see PUT Bucket lifecycle), 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.

pub fn restore(self, input: impl Into<String>) -> GetObjectOutputBuilder

Provides information about object restoration action and expiration time of the restored object copy.

pub fn set_restore(self, input: Option<String>) -> GetObjectOutputBuilder

Provides information about object restoration action and expiration time of the restored object copy.

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

Provides information about object restoration action and expiration time of the restored object copy.

pub fn last_modified(self, input: DateTime) -> GetObjectOutputBuilder

Creation date of the object.

pub fn set_last_modified( self, input: Option<DateTime> ) -> GetObjectOutputBuilder

Creation date of the object.

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

Creation date of the object.

pub fn content_length(self, input: i64) -> GetObjectOutputBuilder

Size of the body in bytes.

pub fn set_content_length(self, input: Option<i64>) -> GetObjectOutputBuilder

Size of the body in bytes.

pub fn get_content_length(&self) -> &Option<i64>

Size of the body in bytes.

pub fn e_tag(self, input: impl Into<String>) -> GetObjectOutputBuilder

An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.

pub fn set_e_tag(self, input: Option<String>) -> GetObjectOutputBuilder

An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.

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.

pub fn checksum_crc32(self, input: impl Into<String>) -> GetObjectOutputBuilder

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

pub fn set_checksum_crc32(self, input: Option<String>) -> GetObjectOutputBuilder

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

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. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

pub fn checksum_crc32_c( self, input: impl Into<String> ) -> GetObjectOutputBuilder

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

pub fn set_checksum_crc32_c( self, input: Option<String> ) -> GetObjectOutputBuilder

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

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. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

pub fn checksum_sha1(self, input: impl Into<String>) -> GetObjectOutputBuilder

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

pub fn set_checksum_sha1(self, input: Option<String>) -> GetObjectOutputBuilder

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

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. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

pub fn checksum_sha256(self, input: impl Into<String>) -> GetObjectOutputBuilder

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

pub fn set_checksum_sha256( self, input: Option<String> ) -> GetObjectOutputBuilder

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

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. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

pub fn missing_meta(self, input: i32) -> GetObjectOutputBuilder

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.

pub fn set_missing_meta(self, input: Option<i32>) -> GetObjectOutputBuilder

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.

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.

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

Version of the object.

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

Version of the object.

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

Version of the object.

pub fn cache_control(self, input: impl Into<String>) -> GetObjectOutputBuilder

Specifies caching behavior along the request/reply chain.

pub fn set_cache_control(self, input: Option<String>) -> GetObjectOutputBuilder

Specifies caching behavior along the request/reply chain.

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

Specifies caching behavior along the request/reply chain.

pub fn content_disposition( self, input: impl Into<String> ) -> GetObjectOutputBuilder

Specifies presentational information for the object.

pub fn set_content_disposition( self, input: Option<String> ) -> GetObjectOutputBuilder

Specifies presentational information for the object.

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

Specifies presentational information for the object.

pub fn content_encoding( self, input: impl Into<String> ) -> GetObjectOutputBuilder

Specifies 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.

pub fn set_content_encoding( self, input: Option<String> ) -> GetObjectOutputBuilder

Specifies 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.

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

Specifies 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.

pub fn content_language( self, input: impl Into<String> ) -> GetObjectOutputBuilder

The language the content is in.

pub fn set_content_language( self, input: Option<String> ) -> GetObjectOutputBuilder

The language the content is in.

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

The language the content is in.

pub fn content_range(self, input: impl Into<String>) -> GetObjectOutputBuilder

The portion of the object returned in the response.

pub fn set_content_range(self, input: Option<String>) -> GetObjectOutputBuilder

The portion of the object returned in the response.

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

The portion of the object returned in the response.

pub fn content_type(self, input: impl Into<String>) -> GetObjectOutputBuilder

A standard MIME type describing the format of the object data.

pub fn set_content_type(self, input: Option<String>) -> GetObjectOutputBuilder

A standard MIME type describing the format of the object data.

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

A standard MIME type describing the format of the object data.

pub fn expires(self, input: DateTime) -> GetObjectOutputBuilder

The date and time at which the object is no longer cacheable.

pub fn set_expires(self, input: Option<DateTime>) -> GetObjectOutputBuilder

The date and time at which the object is no longer cacheable.

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

The date and time at which the object is no longer cacheable.

pub fn website_redirect_location( self, input: impl Into<String> ) -> GetObjectOutputBuilder

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.

pub fn set_website_redirect_location( self, input: Option<String> ) -> GetObjectOutputBuilder

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.

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.

pub fn server_side_encryption( self, input: ServerSideEncryption ) -> GetObjectOutputBuilder

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).

pub fn set_server_side_encryption( self, input: Option<ServerSideEncryption> ) -> GetObjectOutputBuilder

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).

pub fn get_server_side_encryption(&self) -> &Option<ServerSideEncryption>

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).

pub fn metadata( self, k: impl Into<String>, v: impl Into<String> ) -> GetObjectOutputBuilder

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.

pub fn set_metadata( self, input: Option<HashMap<String, String>> ) -> GetObjectOutputBuilder

A map of metadata to store with the object in S3.

pub fn get_metadata(&self) -> &Option<HashMap<String, String>>

A map of metadata to store with the object in S3.

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

If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

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

If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

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 confirming the encryption algorithm used.

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

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.

pub fn set_sse_customer_key_md5( self, input: Option<String> ) -> GetObjectOutputBuilder

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.

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 round-trip message integrity verification of the customer-provided encryption key.

pub fn ssekms_key_id(self, input: impl Into<String>) -> GetObjectOutputBuilder

If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

pub fn set_ssekms_key_id(self, input: Option<String>) -> GetObjectOutputBuilder

If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

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

If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

pub fn bucket_key_enabled(self, input: bool) -> GetObjectOutputBuilder

Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

pub fn set_bucket_key_enabled( self, input: Option<bool> ) -> GetObjectOutputBuilder

Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

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

pub fn storage_class(self, input: StorageClass) -> GetObjectOutputBuilder

Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

pub fn set_storage_class( self, input: Option<StorageClass> ) -> GetObjectOutputBuilder

Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

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.

pub fn request_charged(self, input: RequestCharged) -> GetObjectOutputBuilder

If present, indicates that the requester was successfully charged for the request.

pub fn set_request_charged( self, input: Option<RequestCharged> ) -> GetObjectOutputBuilder

If present, indicates that the requester was successfully charged for the request.

pub fn get_request_charged(&self) -> &Option<RequestCharged>

If present, indicates that the requester was successfully charged for the request.

pub fn replication_status( self, input: ReplicationStatus ) -> GetObjectOutputBuilder

Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.

pub fn set_replication_status( self, input: Option<ReplicationStatus> ) -> GetObjectOutputBuilder

Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.

pub fn get_replication_status(&self) -> &Option<ReplicationStatus>

Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.

pub fn parts_count(self, input: i32) -> GetObjectOutputBuilder

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.

pub fn set_parts_count(self, input: Option<i32>) -> GetObjectOutputBuilder

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.

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.