#[non_exhaustive]
pub struct ListObjectsOutputBuilder { /* private fields */ }
Expand description

A builder for ListObjectsOutput.

Implementations§

source§

impl ListObjectsOutputBuilder

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

source

pub fn set_contents(self, input: Option<Vec<Object>>) -> Self

Metadata about each object returned.

source

pub fn get_contents(&self) -> &Option<Vec<Object>>

Metadata about each object returned.

source

pub fn name(self, input: impl Into<String>) -> Self

The bucket name.

source

pub fn set_name(self, input: Option<String>) -> Self

The bucket name.

source

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

The bucket name.

source

pub fn prefix(self, input: impl Into<String>) -> Self

Keys that begin with the indicated prefix.

source

pub fn set_prefix(self, input: Option<String>) -> Self

Keys that begin with the indicated prefix.

source

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

Keys that begin with the indicated prefix.

source

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.

source

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.

source

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.

source

pub fn max_keys(self, input: i32) -> Self

The maximum number of keys returned in the response body.

source

pub fn set_max_keys(self, input: Option<i32>) -> Self

The maximum number of keys returned in the response body.

source

pub fn get_max_keys(&self) -> &Option<i32>

The maximum number of keys returned in the response body.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

source

pub fn build(self) -> ListObjectsOutput

Consumes the builder and constructs a ListObjectsOutput.

Trait Implementations§

source§

impl Clone for ListObjectsOutputBuilder

source§

fn clone(&self) -> ListObjectsOutputBuilder

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for ListObjectsOutputBuilder

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for ListObjectsOutputBuilder

source§

fn default() -> ListObjectsOutputBuilder

Returns the “default value” for a type. Read more
source§

impl PartialEq for ListObjectsOutputBuilder

source§

fn eq(&self, other: &ListObjectsOutputBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl StructuralPartialEq for ListObjectsOutputBuilder

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more