#[non_exhaustive]pub struct ListObjectsOutputBuilder { /* private fields */ }
Expand description
A builder for ListObjectsOutput
.
Implementations§
source§impl ListObjectsOutputBuilder
impl ListObjectsOutputBuilder
sourcepub fn is_truncated(self, input: bool) -> Self
pub fn is_truncated(self, input: bool) -> Self
A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.
sourcepub fn set_is_truncated(self, input: Option<bool>) -> Self
pub fn set_is_truncated(self, input: Option<bool>) -> Self
A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.
sourcepub fn get_is_truncated(&self) -> &Option<bool>
pub fn get_is_truncated(&self) -> &Option<bool>
A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.
sourcepub fn marker(self, input: impl Into<String>) -> Self
pub fn marker(self, input: impl Into<String>) -> Self
Indicates where in the bucket listing begins. Marker is included in the response if it was sent with the request.
sourcepub fn set_marker(self, input: Option<String>) -> Self
pub fn set_marker(self, input: Option<String>) -> Self
Indicates where in the bucket listing begins. Marker is included in the response if it was sent with the request.
sourcepub fn get_marker(&self) -> &Option<String>
pub fn get_marker(&self) -> &Option<String>
Indicates where in the bucket listing begins. Marker is included in the response if it was sent with the request.
sourcepub fn next_marker(self, input: impl Into<String>) -> Self
pub fn next_marker(self, input: impl Into<String>) -> Self
When the response is truncated (the IsTruncated
element value in the response is true
), you can use the key name in this field as the marker
parameter in the subsequent request to get the next set of objects. Amazon S3 lists objects in alphabetical order.
This element is returned only if you have the delimiter
request parameter specified. If the response does not include the NextMarker
element and it is truncated, you can use the value of the last Key
element in the response as the marker
parameter in the subsequent request to get the next set of object keys.
sourcepub fn set_next_marker(self, input: Option<String>) -> Self
pub fn set_next_marker(self, input: Option<String>) -> Self
When the response is truncated (the IsTruncated
element value in the response is true
), you can use the key name in this field as the marker
parameter in the subsequent request to get the next set of objects. Amazon S3 lists objects in alphabetical order.
This element is returned only if you have the delimiter
request parameter specified. If the response does not include the NextMarker
element and it is truncated, you can use the value of the last Key
element in the response as the marker
parameter in the subsequent request to get the next set of object keys.
sourcepub fn get_next_marker(&self) -> &Option<String>
pub fn get_next_marker(&self) -> &Option<String>
When the response is truncated (the IsTruncated
element value in the response is true
), you can use the key name in this field as the marker
parameter in the subsequent request to get the next set of objects. Amazon S3 lists objects in alphabetical order.
This element is returned only if you have the delimiter
request parameter specified. If the response does not include the NextMarker
element and it is truncated, you can use the value of the last Key
element in the response as the marker
parameter in the subsequent request to get the next set of object keys.
sourcepub fn contents(self, input: Object) -> Self
pub fn contents(self, input: Object) -> Self
Appends an item to contents
.
To override the contents of this collection use set_contents
.
Metadata about each object returned.
sourcepub fn set_contents(self, input: Option<Vec<Object>>) -> Self
pub fn set_contents(self, input: Option<Vec<Object>>) -> Self
Metadata about each object returned.
sourcepub fn get_contents(&self) -> &Option<Vec<Object>>
pub fn get_contents(&self) -> &Option<Vec<Object>>
Metadata about each object returned.
sourcepub fn prefix(self, input: impl Into<String>) -> Self
pub fn prefix(self, input: impl Into<String>) -> Self
Keys that begin with the indicated prefix.
sourcepub fn set_prefix(self, input: Option<String>) -> Self
pub fn set_prefix(self, input: Option<String>) -> Self
Keys that begin with the indicated prefix.
sourcepub fn get_prefix(&self) -> &Option<String>
pub fn get_prefix(&self) -> &Option<String>
Keys that begin with the indicated prefix.
sourcepub fn delimiter(self, input: impl Into<String>) -> Self
pub fn delimiter(self, input: impl Into<String>) -> Self
Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes
collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the MaxKeys
value.
sourcepub fn set_delimiter(self, input: Option<String>) -> Self
pub fn set_delimiter(self, input: Option<String>) -> Self
Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes
collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the MaxKeys
value.
sourcepub fn get_delimiter(&self) -> &Option<String>
pub fn get_delimiter(&self) -> &Option<String>
Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes
collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the MaxKeys
value.
sourcepub fn max_keys(self, input: i32) -> Self
pub fn max_keys(self, input: i32) -> Self
The maximum number of keys returned in the response body.
sourcepub fn set_max_keys(self, input: Option<i32>) -> Self
pub fn set_max_keys(self, input: Option<i32>) -> Self
The maximum number of keys returned in the response body.
sourcepub fn get_max_keys(&self) -> &Option<i32>
pub fn get_max_keys(&self) -> &Option<i32>
The maximum number of keys returned in the response body.
sourcepub fn common_prefixes(self, input: CommonPrefix) -> Self
pub fn common_prefixes(self, input: CommonPrefix) -> Self
Appends an item to common_prefixes
.
To override the contents of this collection use set_common_prefixes
.
All of the keys (up to 1,000) rolled up in a common prefix count as a single return when calculating the number of returns.
A response can contain CommonPrefixes
only if you specify a delimiter.
CommonPrefixes
contains all (if there are any) keys between Prefix
and the next occurrence of the string specified by the delimiter.
CommonPrefixes
lists keys that act like subdirectories in the directory specified by Prefix
.
For example, if the prefix is notes/
and the delimiter is a slash (/
), as in notes/summer/july
, the common prefix is notes/summer/
. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.
sourcepub fn set_common_prefixes(self, input: Option<Vec<CommonPrefix>>) -> Self
pub fn set_common_prefixes(self, input: Option<Vec<CommonPrefix>>) -> Self
All of the keys (up to 1,000) rolled up in a common prefix count as a single return when calculating the number of returns.
A response can contain CommonPrefixes
only if you specify a delimiter.
CommonPrefixes
contains all (if there are any) keys between Prefix
and the next occurrence of the string specified by the delimiter.
CommonPrefixes
lists keys that act like subdirectories in the directory specified by Prefix
.
For example, if the prefix is notes/
and the delimiter is a slash (/
), as in notes/summer/july
, the common prefix is notes/summer/
. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.
sourcepub fn get_common_prefixes(&self) -> &Option<Vec<CommonPrefix>>
pub fn get_common_prefixes(&self) -> &Option<Vec<CommonPrefix>>
All of the keys (up to 1,000) rolled up in a common prefix count as a single return when calculating the number of returns.
A response can contain CommonPrefixes
only if you specify a delimiter.
CommonPrefixes
contains all (if there are any) keys between Prefix
and the next occurrence of the string specified by the delimiter.
CommonPrefixes
lists keys that act like subdirectories in the directory specified by Prefix
.
For example, if the prefix is notes/
and the delimiter is a slash (/
), as in notes/summer/july
, the common prefix is notes/summer/
. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.
sourcepub fn encoding_type(self, input: EncodingType) -> Self
pub fn encoding_type(self, input: EncodingType) -> Self
Encoding type used by Amazon S3 to encode object keys in the response. If using url
, non-ASCII characters used in an object's key name will be URL encoded. For example, the object test_file(3).png will appear as test_file%283%29.png.
sourcepub fn set_encoding_type(self, input: Option<EncodingType>) -> Self
pub fn set_encoding_type(self, input: Option<EncodingType>) -> Self
Encoding type used by Amazon S3 to encode object keys in the response. If using url
, non-ASCII characters used in an object's key name will be URL encoded. For example, the object test_file(3).png will appear as test_file%283%29.png.
sourcepub fn get_encoding_type(&self) -> &Option<EncodingType>
pub fn get_encoding_type(&self) -> &Option<EncodingType>
Encoding type used by Amazon S3 to encode object keys in the response. If using url
, non-ASCII characters used in an object's key name will be URL encoded. For example, the object test_file(3).png will appear as test_file%283%29.png.
sourcepub fn request_charged(self, input: RequestCharged) -> Self
pub fn request_charged(self, input: RequestCharged) -> Self
If present, indicates that the requester was successfully charged for the request.
This functionality is not supported for directory buckets.
sourcepub fn set_request_charged(self, input: Option<RequestCharged>) -> Self
pub fn set_request_charged(self, input: Option<RequestCharged>) -> Self
If present, indicates that the requester was successfully charged for the request.
This functionality is not supported for directory buckets.
sourcepub fn get_request_charged(&self) -> &Option<RequestCharged>
pub fn get_request_charged(&self) -> &Option<RequestCharged>
If present, indicates that the requester was successfully charged for the request.
This functionality is not supported for directory buckets.
sourcepub fn build(self) -> ListObjectsOutput
pub fn build(self) -> ListObjectsOutput
Consumes the builder and constructs a ListObjectsOutput
.
Trait Implementations§
source§impl Clone for ListObjectsOutputBuilder
impl Clone for ListObjectsOutputBuilder
source§fn clone(&self) -> ListObjectsOutputBuilder
fn clone(&self) -> ListObjectsOutputBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ListObjectsOutputBuilder
impl Debug for ListObjectsOutputBuilder
source§impl Default for ListObjectsOutputBuilder
impl Default for ListObjectsOutputBuilder
source§fn default() -> ListObjectsOutputBuilder
fn default() -> ListObjectsOutputBuilder
source§impl PartialEq for ListObjectsOutputBuilder
impl PartialEq for ListObjectsOutputBuilder
impl StructuralPartialEq for ListObjectsOutputBuilder
Auto Trait Implementations§
impl Freeze for ListObjectsOutputBuilder
impl RefUnwindSafe for ListObjectsOutputBuilder
impl Send for ListObjectsOutputBuilder
impl Sync for ListObjectsOutputBuilder
impl Unpin for ListObjectsOutputBuilder
impl UnwindSafe for ListObjectsOutputBuilder
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
)