Struct aws_sdk_s3::output::list_objects_output::Builder

#[non_exhaustive]
pub struct Builder { /* fields omitted */ }

A builder for ListObjectsOutput

Implementations

impl Builder

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.

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.

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.

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.

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

When response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as marker in the subsequent request to get next set of objects. Amazon S3 lists objects in alphabetical order Note: This element is returned only if you have delimiter request parameter specified. If response does not include the NextMarker and it is truncated, you can use the value of the last Key in the response as the marker in the subsequent request to get the next set of object keys.

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

When response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as marker in the subsequent request to get next set of objects. Amazon S3 lists objects in alphabetical order Note: This element is returned only if you have delimiter request parameter specified. If response does not include the NextMarker and it is truncated, you can use the value of the last Key in the response as the marker in the subsequent request to get the next set of object keys.

pub fn contents(self, input: impl Into<Object>) -> Self

Appends an item to contents.

To override the contents of this collection use set_contents.

Metadata about each object returned.

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

Metadata about each object returned.

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

The bucket name.

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

The bucket name.

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

Keys that begin with the indicated prefix.

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

Keys that begin with the indicated prefix.

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.

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.

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

The maximum number of keys returned in the response body.

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

The maximum number of keys returned in the response body.

pub fn common_prefixes(self, input: impl Into<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.

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.

pub fn encoding_type(self, input: EncodingType) -> Self

Encoding type used by Amazon S3 to encode object keys in the response.

pub fn set_encoding_type(self, input: Option<EncodingType>) -> Self

Encoding type used by Amazon S3 to encode object keys in the response.

pub fn build(self) -> ListObjectsOutput

Consumes the builder and constructs a ListObjectsOutput

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for Builder