Struct bonsaidb::keystorage::s3::aws_sdk_s3::operation::list_objects::builders::ListObjectsInputBuilder

#[non_exhaustive]
pub struct ListObjectsInputBuilder { /* private fields */ }

A builder for ListObjectsInput.

Implementations

impl ListObjectsInputBuilder

pub fn bucket(self, input: impl Into<String>) -> ListObjectsInputBuilder

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>) -> ListObjectsInputBuilder

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>

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>) -> ListObjectsInputBuilder

A delimiter is a character that you use to group keys.

pub fn set_delimiter(self, input: Option<String>) -> ListObjectsInputBuilder

A delimiter is a character that you use to group keys.

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) -> ListObjectsInputBuilder

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> ) -> ListObjectsInputBuilder

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>

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>) -> ListObjectsInputBuilder

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>) -> ListObjectsInputBuilder

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>

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) -> ListObjectsInputBuilder

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>) -> ListObjectsInputBuilder

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>

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>) -> ListObjectsInputBuilder

Limits the response to keys that begin with the specified prefix.

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

Limits the response to keys that begin with the specified prefix.

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) -> ListObjectsInputBuilder

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> ) -> ListObjectsInputBuilder

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>

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> ) -> ListObjectsInputBuilder

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> ) -> ListObjectsInputBuilder

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>

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 ) -> ListObjectsInputBuilder

Appends an item to optional_object_attributes.

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>> ) -> ListObjectsInputBuilder

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>>

Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.

pub fn build(self) -> Result<ListObjectsInput, BuildError>

Consumes the builder and constructs a ListObjectsInput.

impl ListObjectsInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<ListObjectsOutput, SdkError<ListObjectsError, Response<SdkBody>>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for ListObjectsInputBuilder

fn clone(&self) -> ListObjectsInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListObjectsInputBuilder

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

Formats the value using the given formatter.

impl Default for ListObjectsInputBuilder

fn default() -> ListObjectsInputBuilder

Returns the “default value” for a type.

impl PartialEq for ListObjectsInputBuilder

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ListObjectsInputBuilder