#[non_exhaustive]pub struct ListObjectsV2OutputBuilder { /* private fields */ }
Expand description
A builder for ListObjectsV2Output
.
Implementations§
source§impl ListObjectsV2OutputBuilder
impl ListObjectsV2OutputBuilder
sourcepub fn is_truncated(self, input: bool) -> Self
pub fn is_truncated(self, input: bool) -> Self
Set to false
if all of the results were returned. Set to true
if more keys are available to return. If the number of results exceeds that specified by MaxKeys
, all of the results might not be returned.
sourcepub fn set_is_truncated(self, input: Option<bool>) -> Self
pub fn set_is_truncated(self, input: Option<bool>) -> Self
Set to false
if all of the results were returned. Set to true
if more keys are available to return. If the number of results exceeds that specified by MaxKeys
, all of the results might not be returned.
sourcepub fn get_is_truncated(&self) -> &Option<bool>
pub fn get_is_truncated(&self) -> &Option<bool>
Set to false
if all of the results were returned. Set to true
if more keys are available to return. If the number of results exceeds that specified by MaxKeys
, all of the results might not be returned.
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 name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
The bucket name.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
sourcepub fn set_name(self, input: Option<String>) -> Self
pub fn set_name(self, input: Option<String>) -> Self
The bucket name.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
sourcepub fn get_name(&self) -> &Option<String>
pub fn get_name(&self) -> &Option<String>
The bucket name.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
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
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.
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.
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.
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 into 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 a 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 into 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 a 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 into 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 a 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 key names in the XML response.
If you specify the encoding-type
request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:
Delimiter, Prefix, Key,
and StartAfter
.
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 key names in the XML response.
If you specify the encoding-type
request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:
Delimiter, Prefix, Key,
and StartAfter
.
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 key names in the XML response.
If you specify the encoding-type
request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:
Delimiter, Prefix, Key,
and StartAfter
.
sourcepub fn key_count(self, input: i32) -> Self
pub fn key_count(self, input: i32) -> Self
KeyCount
is the number of keys returned with this request. KeyCount
will always be less than or equal to the MaxKeys
field. For example, if you ask for 50 keys, your result will include 50 keys or fewer.
sourcepub fn set_key_count(self, input: Option<i32>) -> Self
pub fn set_key_count(self, input: Option<i32>) -> Self
KeyCount
is the number of keys returned with this request. KeyCount
will always be less than or equal to the MaxKeys
field. For example, if you ask for 50 keys, your result will include 50 keys or fewer.
sourcepub fn get_key_count(&self) -> &Option<i32>
pub fn get_key_count(&self) -> &Option<i32>
KeyCount
is the number of keys returned with this request. KeyCount
will always be less than or equal to the MaxKeys
field. For example, if you ask for 50 keys, your result will include 50 keys or fewer.
sourcepub fn continuation_token(self, input: impl Into<String>) -> Self
pub fn continuation_token(self, input: impl Into<String>) -> Self
If ContinuationToken
was sent with the request, it is included in the response.
sourcepub fn set_continuation_token(self, input: Option<String>) -> Self
pub fn set_continuation_token(self, input: Option<String>) -> Self
If ContinuationToken
was sent with the request, it is included in the response.
sourcepub fn get_continuation_token(&self) -> &Option<String>
pub fn get_continuation_token(&self) -> &Option<String>
If ContinuationToken
was sent with the request, it is included in the response.
sourcepub fn next_continuation_token(self, input: impl Into<String>) -> Self
pub fn next_continuation_token(self, input: impl Into<String>) -> Self
NextContinuationToken
is sent when isTruncated
is true, which means there are more keys in the bucket that can be listed. The next list requests to Amazon S3 can be continued with this NextContinuationToken
. NextContinuationToken
is obfuscated and is not a real key
sourcepub fn set_next_continuation_token(self, input: Option<String>) -> Self
pub fn set_next_continuation_token(self, input: Option<String>) -> Self
NextContinuationToken
is sent when isTruncated
is true, which means there are more keys in the bucket that can be listed. The next list requests to Amazon S3 can be continued with this NextContinuationToken
. NextContinuationToken
is obfuscated and is not a real key
sourcepub fn get_next_continuation_token(&self) -> &Option<String>
pub fn get_next_continuation_token(&self) -> &Option<String>
NextContinuationToken
is sent when isTruncated
is true, which means there are more keys in the bucket that can be listed. The next list requests to Amazon S3 can be continued with this NextContinuationToken
. NextContinuationToken
is obfuscated and is not a real key
sourcepub fn start_after(self, input: impl Into<String>) -> Self
pub fn start_after(self, input: impl Into<String>) -> Self
If StartAfter was sent with the request, it is included in the response.
sourcepub fn set_start_after(self, input: Option<String>) -> Self
pub fn set_start_after(self, input: Option<String>) -> Self
If StartAfter was sent with the request, it is included in the response.
sourcepub fn get_start_after(&self) -> &Option<String>
pub fn get_start_after(&self) -> &Option<String>
If StartAfter was sent with the request, it is included in the response.
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.
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.
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.
sourcepub fn build(self) -> ListObjectsV2Output
pub fn build(self) -> ListObjectsV2Output
Consumes the builder and constructs a ListObjectsV2Output
.
Trait Implementations§
source§impl Clone for ListObjectsV2OutputBuilder
impl Clone for ListObjectsV2OutputBuilder
source§fn clone(&self) -> ListObjectsV2OutputBuilder
fn clone(&self) -> ListObjectsV2OutputBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ListObjectsV2OutputBuilder
impl Debug for ListObjectsV2OutputBuilder
source§impl Default for ListObjectsV2OutputBuilder
impl Default for ListObjectsV2OutputBuilder
source§fn default() -> ListObjectsV2OutputBuilder
fn default() -> ListObjectsV2OutputBuilder
source§impl PartialEq<ListObjectsV2OutputBuilder> for ListObjectsV2OutputBuilder
impl PartialEq<ListObjectsV2OutputBuilder> for ListObjectsV2OutputBuilder
source§fn eq(&self, other: &ListObjectsV2OutputBuilder) -> bool
fn eq(&self, other: &ListObjectsV2OutputBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.