Struct bonsaidb::keystorage::s3::aws_sdk_s3::operation::list_objects::builders::ListObjectsFluentBuilder
pub struct ListObjectsFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to ListObjects
.
Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Be sure to design your application to parse the contents of the response and handle it appropriately.
This action has been revised. We recommend that you use the newer version, ListObjectsV2, when developing applications. For backward compatibility, Amazon S3 continues to support ListObjects
.
The following operations are related to ListObjects
:
Implementations§
§impl ListObjectsFluentBuilder
impl ListObjectsFluentBuilder
pub fn as_input(&self) -> &ListObjectsInputBuilder
pub fn as_input(&self) -> &ListObjectsInputBuilder
Access the ListObjects as a reference.
pub async fn send(
self
) -> impl Future<Output = Result<ListObjectsOutput, SdkError<ListObjectsError, Response<SdkBody>>>>
pub async fn send( self ) -> impl Future<Output = Result<ListObjectsOutput, SdkError<ListObjectsError, Response<SdkBody>>>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
pub async fn customize(
self
) -> impl Future<Output = Result<CustomizableOperation<ListObjectsOutput, ListObjectsError, ListObjectsFluentBuilder>, SdkError<ListObjectsError, Response>>>
pub async fn customize( self ) -> impl Future<Output = Result<CustomizableOperation<ListObjectsOutput, ListObjectsError, ListObjectsFluentBuilder>, SdkError<ListObjectsError, Response>>>
Consumes this builder, creating a customizable operation that can be modified before being sent.
pub fn bucket(self, input: impl Into<String>) -> ListObjectsFluentBuilder
pub fn bucket(self, input: impl Into<String>) -> ListObjectsFluentBuilder
The name of the bucket containing the objects.
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 set_bucket(self, input: Option<String>) -> ListObjectsFluentBuilder
pub fn set_bucket(self, input: Option<String>) -> ListObjectsFluentBuilder
The name of the bucket containing the objects.
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 get_bucket(&self) -> &Option<String>
pub fn get_bucket(&self) -> &Option<String>
The name of the bucket containing the objects.
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, input: impl Into<String>) -> ListObjectsFluentBuilder
pub fn delimiter(self, input: impl Into<String>) -> ListObjectsFluentBuilder
A delimiter is a character that you use to group keys.
pub fn set_delimiter(self, input: Option<String>) -> ListObjectsFluentBuilder
pub fn set_delimiter(self, input: Option<String>) -> ListObjectsFluentBuilder
A delimiter is a character that you use to group keys.
pub fn get_delimiter(&self) -> &Option<String>
pub fn get_delimiter(&self) -> &Option<String>
A delimiter is a character that you use to group keys.
pub fn encoding_type(self, input: EncodingType) -> ListObjectsFluentBuilder
pub fn encoding_type(self, input: EncodingType) -> ListObjectsFluentBuilder
Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key can contain any Unicode character; however, the XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.
pub fn set_encoding_type(
self,
input: Option<EncodingType>
) -> ListObjectsFluentBuilder
pub fn set_encoding_type( self, input: Option<EncodingType> ) -> ListObjectsFluentBuilder
Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key can contain any Unicode character; however, the XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.
pub fn get_encoding_type(&self) -> &Option<EncodingType>
pub fn get_encoding_type(&self) -> &Option<EncodingType>
Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key can contain any Unicode character; however, the XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.
pub fn marker(self, input: impl Into<String>) -> ListObjectsFluentBuilder
pub fn marker(self, input: impl Into<String>) -> ListObjectsFluentBuilder
Marker is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. Marker can be any key in the bucket.
pub fn set_marker(self, input: Option<String>) -> ListObjectsFluentBuilder
pub fn set_marker(self, input: Option<String>) -> ListObjectsFluentBuilder
Marker is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. Marker can be any key in the bucket.
pub fn get_marker(&self) -> &Option<String>
pub fn get_marker(&self) -> &Option<String>
Marker is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. Marker can be any key in the bucket.
pub fn max_keys(self, input: i32) -> ListObjectsFluentBuilder
pub fn max_keys(self, input: i32) -> ListObjectsFluentBuilder
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 set_max_keys(self, input: Option<i32>) -> ListObjectsFluentBuilder
pub fn set_max_keys(self, input: Option<i32>) -> ListObjectsFluentBuilder
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 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.
pub fn prefix(self, input: impl Into<String>) -> ListObjectsFluentBuilder
pub fn prefix(self, input: impl Into<String>) -> ListObjectsFluentBuilder
Limits the response to keys that begin with the specified prefix.
pub fn set_prefix(self, input: Option<String>) -> ListObjectsFluentBuilder
pub fn set_prefix(self, input: Option<String>) -> ListObjectsFluentBuilder
Limits the response to keys that begin with the specified prefix.
pub fn get_prefix(&self) -> &Option<String>
pub fn get_prefix(&self) -> &Option<String>
Limits the response to keys that begin with the specified prefix.
pub fn request_payer(self, input: RequestPayer) -> ListObjectsFluentBuilder
pub fn request_payer(self, input: RequestPayer) -> ListObjectsFluentBuilder
Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.
pub fn set_request_payer(
self,
input: Option<RequestPayer>
) -> ListObjectsFluentBuilder
pub fn set_request_payer( self, input: Option<RequestPayer> ) -> ListObjectsFluentBuilder
Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.
pub fn get_request_payer(&self) -> &Option<RequestPayer>
pub fn get_request_payer(&self) -> &Option<RequestPayer>
Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.
pub fn expected_bucket_owner(
self,
input: impl Into<String>
) -> ListObjectsFluentBuilder
pub fn expected_bucket_owner( self, input: impl Into<String> ) -> ListObjectsFluentBuilder
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden
(access denied).
pub fn set_expected_bucket_owner(
self,
input: Option<String>
) -> ListObjectsFluentBuilder
pub fn set_expected_bucket_owner( self, input: Option<String> ) -> ListObjectsFluentBuilder
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden
(access denied).
pub fn get_expected_bucket_owner(&self) -> &Option<String>
pub fn get_expected_bucket_owner(&self) -> &Option<String>
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden
(access denied).
pub fn optional_object_attributes(
self,
input: OptionalObjectAttributes
) -> ListObjectsFluentBuilder
pub fn optional_object_attributes( self, input: OptionalObjectAttributes ) -> ListObjectsFluentBuilder
Appends an item to OptionalObjectAttributes
.
To override the contents of this collection use set_optional_object_attributes
.
Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.
pub fn set_optional_object_attributes(
self,
input: Option<Vec<OptionalObjectAttributes, Global>>
) -> ListObjectsFluentBuilder
pub fn set_optional_object_attributes( self, input: Option<Vec<OptionalObjectAttributes, Global>> ) -> ListObjectsFluentBuilder
Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.
pub fn get_optional_object_attributes(
&self
) -> &Option<Vec<OptionalObjectAttributes, Global>>
pub fn get_optional_object_attributes( &self ) -> &Option<Vec<OptionalObjectAttributes, Global>>
Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.
Trait Implementations§
§impl Clone for ListObjectsFluentBuilder
impl Clone for ListObjectsFluentBuilder
§fn clone(&self) -> ListObjectsFluentBuilder
fn clone(&self) -> ListObjectsFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more