Struct bonsaidb::keystorage::s3::aws_sdk_s3::operation::list_objects_v2::ListObjectsV2Output
#[non_exhaustive]pub struct ListObjectsV2Output {Show 13 fields
pub is_truncated: bool,
pub contents: Option<Vec<Object>>,
pub name: Option<String>,
pub prefix: Option<String>,
pub delimiter: Option<String>,
pub max_keys: i32,
pub common_prefixes: Option<Vec<CommonPrefix>>,
pub encoding_type: Option<EncodingType>,
pub key_count: i32,
pub continuation_token: Option<String>,
pub next_continuation_token: Option<String>,
pub start_after: Option<String>,
pub request_charged: Option<RequestCharged>,
/* private fields */
}
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.is_truncated: 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.
contents: Option<Vec<Object>>
Metadata about each object returned.
name: 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.
prefix: Option<String>
Keys that begin with the indicated prefix.
delimiter: 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.
max_keys: 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.
common_prefixes: 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.
encoding_type: 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
.
key_count: 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.
continuation_token: Option<String>
If ContinuationToken
was sent with the request, it is included in the response.
next_continuation_token: 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
start_after: Option<String>
If StartAfter was sent with the request, it is included in the response.
request_charged: Option<RequestCharged>
If present, indicates that the requester was successfully charged for the request.
Implementations§
§impl ListObjectsV2Output
impl ListObjectsV2Output
pub fn is_truncated(&self) -> bool
pub fn is_truncated(&self) -> 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.
pub fn name(&self) -> Option<&str>
pub fn name(&self) -> Option<&str>
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.
pub fn delimiter(&self) -> Option<&str>
pub fn delimiter(&self) -> Option<&str>
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) -> i32
pub fn max_keys(&self) -> 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.
pub fn common_prefixes(&self) -> Option<&[CommonPrefix]>
pub fn common_prefixes(&self) -> Option<&[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.
pub fn encoding_type(&self) -> Option<&EncodingType>
pub fn 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
.
pub fn key_count(&self) -> i32
pub fn key_count(&self) -> 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.
pub fn continuation_token(&self) -> Option<&str>
pub fn continuation_token(&self) -> Option<&str>
If ContinuationToken
was sent with the request, it is included in the response.
pub fn next_continuation_token(&self) -> Option<&str>
pub fn next_continuation_token(&self) -> Option<&str>
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
pub fn start_after(&self) -> Option<&str>
pub fn start_after(&self) -> Option<&str>
If StartAfter was sent with the request, it is included in the response.
pub fn request_charged(&self) -> Option<&RequestCharged>
pub fn request_charged(&self) -> Option<&RequestCharged>
If present, indicates that the requester was successfully charged for the request.
§impl ListObjectsV2Output
impl ListObjectsV2Output
pub fn builder() -> ListObjectsV2OutputBuilder
pub fn builder() -> ListObjectsV2OutputBuilder
Creates a new builder-style object to manufacture ListObjectsV2Output
.
Trait Implementations§
§impl Clone for ListObjectsV2Output
impl Clone for ListObjectsV2Output
§fn clone(&self) -> ListObjectsV2Output
fn clone(&self) -> ListObjectsV2Output
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more§impl Debug for ListObjectsV2Output
impl Debug for ListObjectsV2Output
§impl PartialEq for ListObjectsV2Output
impl PartialEq for ListObjectsV2Output
§fn eq(&self, other: &ListObjectsV2Output) -> bool
fn eq(&self, other: &ListObjectsV2Output) -> bool
self
and other
values to be equal, and is used
by ==
.§impl RequestId for ListObjectsV2Output
impl RequestId for ListObjectsV2Output
§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None
if the service could not be reached.