Struct bonsaidb::keystorage::s3::aws_sdk_s3::operation::list_object_versions::ListObjectVersionsInput
#[non_exhaustive]pub struct ListObjectVersionsInput {
pub bucket: Option<String>,
pub delimiter: Option<String>,
pub encoding_type: Option<EncodingType>,
pub key_marker: Option<String>,
pub max_keys: Option<i32>,
pub prefix: Option<String>,
pub version_id_marker: Option<String>,
pub expected_bucket_owner: Option<String>,
pub request_payer: Option<RequestPayer>,
pub optional_object_attributes: Option<Vec<OptionalObjectAttributes>>,
}
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 that contains the objects.
delimiter: Option<String>
A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix
and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes
. These groups are counted as one result against the max-keys
limitation. These keys are not returned elsewhere in the response.
encoding_type: Option<EncodingType>
Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key can contain any Unicode character; however, the XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.
key_marker: Option<String>
Specifies the key to start with when listing objects in a bucket.
max_keys: Option<i32>
Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more. If additional keys satisfy the search criteria, but were not returned because max-keys
was exceeded, the response contains
. To return the additional keys, see key-marker
and version-id-marker
.
prefix: Option<String>
Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix
to make groups in the same way that you'd use a folder in a file system.) You can use prefix
with delimiter
to roll up numerous objects into a single result under CommonPrefixes
.
version_id_marker: Option<String>
Specifies the object version you want to start listing from.
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).
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.
optional_object_attributes: Option<Vec<OptionalObjectAttributes>>
Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.
Implementations§
§impl ListObjectVersionsInput
impl ListObjectVersionsInput
pub fn delimiter(&self) -> Option<&str>
pub fn delimiter(&self) -> Option<&str>
A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix
and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes
. These groups are counted as one result against the max-keys
limitation. These keys are not returned elsewhere in the response.
pub fn encoding_type(&self) -> Option<&EncodingType>
pub fn encoding_type(&self) -> Option<&EncodingType>
Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key can contain any Unicode character; however, the XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.
pub fn key_marker(&self) -> Option<&str>
pub fn key_marker(&self) -> Option<&str>
Specifies the key to start with when listing objects in a bucket.
pub fn max_keys(&self) -> Option<i32>
pub fn max_keys(&self) -> Option<i32>
Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more. If additional keys satisfy the search criteria, but were not returned because max-keys
was exceeded, the response contains
. To return the additional keys, see key-marker
and version-id-marker
.
pub fn prefix(&self) -> Option<&str>
pub fn prefix(&self) -> Option<&str>
Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix
to make groups in the same way that you'd use a folder in a file system.) You can use prefix
with delimiter
to roll up numerous objects into a single result under CommonPrefixes
.
pub fn version_id_marker(&self) -> Option<&str>
pub fn version_id_marker(&self) -> Option<&str>
Specifies the object version you want to start listing from.
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 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 optional_object_attributes(&self) -> Option<&[OptionalObjectAttributes]>
pub fn optional_object_attributes(&self) -> Option<&[OptionalObjectAttributes]>
Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.
§impl ListObjectVersionsInput
impl ListObjectVersionsInput
pub fn builder() -> ListObjectVersionsInputBuilder
pub fn builder() -> ListObjectVersionsInputBuilder
Creates a new builder-style object to manufacture ListObjectVersionsInput
.
Trait Implementations§
§impl Clone for ListObjectVersionsInput
impl Clone for ListObjectVersionsInput
§fn clone(&self) -> ListObjectVersionsInput
fn clone(&self) -> ListObjectVersionsInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more§impl Debug for ListObjectVersionsInput
impl Debug for ListObjectVersionsInput
§impl PartialEq for ListObjectVersionsInput
impl PartialEq for ListObjectVersionsInput
§fn eq(&self, other: &ListObjectVersionsInput) -> bool
fn eq(&self, other: &ListObjectVersionsInput) -> bool
self
and other
values to be equal, and is used
by ==
.