Struct aws_sdk_s3::operation::list_object_versions::builders::ListObjectVersionsInputBuilder
source · #[non_exhaustive]pub struct ListObjectVersionsInputBuilder { /* private fields */ }
Expand description
A builder for ListObjectVersionsInput
.
Implementations§
source§impl ListObjectVersionsInputBuilder
impl ListObjectVersionsInputBuilder
sourcepub fn bucket(self, input: impl Into<String>) -> Self
pub fn bucket(self, input: impl Into<String>) -> Self
The bucket name that contains the objects.
This field is required.sourcepub fn set_bucket(self, input: Option<String>) -> Self
pub fn set_bucket(self, input: Option<String>) -> Self
The bucket name that contains the objects.
sourcepub fn get_bucket(&self) -> &Option<String>
pub fn get_bucket(&self) -> &Option<String>
The bucket name that contains the objects.
sourcepub fn delimiter(self, input: impl Into<String>) -> Self
pub fn delimiter(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_delimiter(self, input: Option<String>) -> Self
pub fn set_delimiter(self, input: Option<String>) -> Self
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.
sourcepub fn get_delimiter(&self) -> &Option<String>
pub fn get_delimiter(&self) -> &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.
sourcepub fn encoding_type(self, input: EncodingType) -> Self
pub fn encoding_type(self, input: EncodingType) -> Self
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.
sourcepub fn set_encoding_type(self, input: Option<EncodingType>) -> Self
pub fn set_encoding_type(self, input: Option<EncodingType>) -> Self
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.
sourcepub fn get_encoding_type(&self) -> &Option<EncodingType>
pub fn get_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.
sourcepub fn key_marker(self, input: impl Into<String>) -> Self
pub fn key_marker(self, input: impl Into<String>) -> Self
Specifies the key to start with when listing objects in a bucket.
sourcepub fn set_key_marker(self, input: Option<String>) -> Self
pub fn set_key_marker(self, input: Option<String>) -> Self
Specifies the key to start with when listing objects in a bucket.
sourcepub fn get_key_marker(&self) -> &Option<String>
pub fn get_key_marker(&self) -> &Option<String>
Specifies the key to start with when listing objects in a bucket.
sourcepub fn max_keys(self, input: i32) -> Self
pub fn max_keys(self, input: i32) -> Self
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
.
sourcepub fn set_max_keys(self, input: Option<i32>) -> Self
pub fn set_max_keys(self, input: Option<i32>) -> Self
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
.
sourcepub fn get_max_keys(&self) -> &Option<i32>
pub fn get_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
.
sourcepub fn prefix(self, input: impl Into<String>) -> Self
pub fn prefix(self, input: impl Into<String>) -> Self
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
.
sourcepub fn set_prefix(self, input: Option<String>) -> Self
pub fn set_prefix(self, input: Option<String>) -> Self
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
.
sourcepub fn get_prefix(&self) -> &Option<String>
pub fn get_prefix(&self) -> &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
.
sourcepub fn version_id_marker(self, input: impl Into<String>) -> Self
pub fn version_id_marker(self, input: impl Into<String>) -> Self
Specifies the object version you want to start listing from.
sourcepub fn set_version_id_marker(self, input: Option<String>) -> Self
pub fn set_version_id_marker(self, input: Option<String>) -> Self
Specifies the object version you want to start listing from.
sourcepub fn get_version_id_marker(&self) -> &Option<String>
pub fn get_version_id_marker(&self) -> &Option<String>
Specifies the object version you want to start listing from.
sourcepub fn expected_bucket_owner(self, input: impl Into<String>) -> Self
pub fn expected_bucket_owner(self, input: impl Into<String>) -> Self
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden
(access denied).
sourcepub fn set_expected_bucket_owner(self, input: Option<String>) -> Self
pub fn set_expected_bucket_owner(self, input: Option<String>) -> Self
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden
(access denied).
sourcepub fn get_expected_bucket_owner(&self) -> &Option<String>
pub fn get_expected_bucket_owner(&self) -> &Option<String>
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden
(access denied).
sourcepub fn request_payer(self, input: RequestPayer) -> Self
pub fn request_payer(self, input: RequestPayer) -> Self
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 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.
This functionality is not supported for directory buckets.
sourcepub fn set_request_payer(self, input: Option<RequestPayer>) -> Self
pub fn set_request_payer(self, input: Option<RequestPayer>) -> Self
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 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.
This functionality is not supported for directory buckets.
sourcepub fn get_request_payer(&self) -> &Option<RequestPayer>
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 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.
This functionality is not supported for directory buckets.
sourcepub fn optional_object_attributes(self, input: OptionalObjectAttributes) -> Self
pub fn optional_object_attributes(self, input: OptionalObjectAttributes) -> Self
Appends an item to optional_object_attributes
.
To override the contents of this collection use set_optional_object_attributes
.
Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.
sourcepub fn set_optional_object_attributes(
self,
input: Option<Vec<OptionalObjectAttributes>>,
) -> Self
pub fn set_optional_object_attributes( self, input: Option<Vec<OptionalObjectAttributes>>, ) -> Self
Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.
sourcepub fn get_optional_object_attributes(
&self,
) -> &Option<Vec<OptionalObjectAttributes>>
pub fn get_optional_object_attributes( &self, ) -> &Option<Vec<OptionalObjectAttributes>>
Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.
sourcepub fn build(self) -> Result<ListObjectVersionsInput, BuildError>
pub fn build(self) -> Result<ListObjectVersionsInput, BuildError>
Consumes the builder and constructs a ListObjectVersionsInput
.
source§impl ListObjectVersionsInputBuilder
impl ListObjectVersionsInputBuilder
sourcepub async fn send_with(
self,
client: &Client,
) -> Result<ListObjectVersionsOutput, SdkError<ListObjectVersionsError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<ListObjectVersionsOutput, SdkError<ListObjectVersionsError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
source§impl Clone for ListObjectVersionsInputBuilder
impl Clone for ListObjectVersionsInputBuilder
source§fn clone(&self) -> ListObjectVersionsInputBuilder
fn clone(&self) -> ListObjectVersionsInputBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Default for ListObjectVersionsInputBuilder
impl Default for ListObjectVersionsInputBuilder
source§fn default() -> ListObjectVersionsInputBuilder
fn default() -> ListObjectVersionsInputBuilder
source§impl PartialEq for ListObjectVersionsInputBuilder
impl PartialEq for ListObjectVersionsInputBuilder
source§fn eq(&self, other: &ListObjectVersionsInputBuilder) -> bool
fn eq(&self, other: &ListObjectVersionsInputBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for ListObjectVersionsInputBuilder
Auto Trait Implementations§
impl Freeze for ListObjectVersionsInputBuilder
impl RefUnwindSafe for ListObjectVersionsInputBuilder
impl Send for ListObjectVersionsInputBuilder
impl Sync for ListObjectVersionsInputBuilder
impl Unpin for ListObjectVersionsInputBuilder
impl UnwindSafe for ListObjectVersionsInputBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)