Struct bonsaidb::keystorage::s3::aws_sdk_s3::operation::list_multipart_uploads::builders::ListMultipartUploadsInputBuilder
#[non_exhaustive]pub struct ListMultipartUploadsInputBuilder { /* private fields */ }
Expand description
A builder for ListMultipartUploadsInput
.
Implementations§
§impl ListMultipartUploadsInputBuilder
impl ListMultipartUploadsInputBuilder
pub fn bucket(
self,
input: impl Into<String>
) -> ListMultipartUploadsInputBuilder
pub fn bucket( self, input: impl Into<String> ) -> ListMultipartUploadsInputBuilder
The name of the bucket to which the multipart upload was initiated.
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>
) -> ListMultipartUploadsInputBuilder
pub fn set_bucket( self, input: Option<String> ) -> ListMultipartUploadsInputBuilder
The name of the bucket to which the multipart upload was initiated.
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 to which the multipart upload was initiated.
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>
) -> ListMultipartUploadsInputBuilder
pub fn delimiter( self, input: impl Into<String> ) -> ListMultipartUploadsInputBuilder
Character you use to group keys.
All keys that contain the same string between the prefix, if specified, and the first occurrence of the delimiter after the prefix are grouped under a single result element, CommonPrefixes
. If you don't specify the prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped under CommonPrefixes
result element are not returned elsewhere in the response.
pub fn set_delimiter(
self,
input: Option<String>
) -> ListMultipartUploadsInputBuilder
pub fn set_delimiter( self, input: Option<String> ) -> ListMultipartUploadsInputBuilder
Character you use to group keys.
All keys that contain the same string between the prefix, if specified, and the first occurrence of the delimiter after the prefix are grouped under a single result element, CommonPrefixes
. If you don't specify the prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped under CommonPrefixes
result element are not returned elsewhere in the response.
pub fn get_delimiter(&self) -> &Option<String>
pub fn get_delimiter(&self) -> &Option<String>
Character you use to group keys.
All keys that contain the same string between the prefix, if specified, and the first occurrence of the delimiter after the prefix are grouped under a single result element, CommonPrefixes
. If you don't specify the prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped under CommonPrefixes
result element are not returned elsewhere in the response.
pub fn encoding_type(
self,
input: EncodingType
) -> ListMultipartUploadsInputBuilder
pub fn encoding_type( self, input: EncodingType ) -> ListMultipartUploadsInputBuilder
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>
) -> ListMultipartUploadsInputBuilder
pub fn set_encoding_type( self, input: Option<EncodingType> ) -> ListMultipartUploadsInputBuilder
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 key_marker(
self,
input: impl Into<String>
) -> ListMultipartUploadsInputBuilder
pub fn key_marker( self, input: impl Into<String> ) -> ListMultipartUploadsInputBuilder
Together with upload-id-marker
, this parameter specifies the multipart upload after which listing should begin.
If upload-id-marker
is not specified, only the keys lexicographically greater than the specified key-marker
will be included in the list.
If upload-id-marker
is specified, any multipart uploads for a key equal to the key-marker
might also be included, provided those multipart uploads have upload IDs lexicographically greater than the specified upload-id-marker
.
pub fn set_key_marker(
self,
input: Option<String>
) -> ListMultipartUploadsInputBuilder
pub fn set_key_marker( self, input: Option<String> ) -> ListMultipartUploadsInputBuilder
Together with upload-id-marker
, this parameter specifies the multipart upload after which listing should begin.
If upload-id-marker
is not specified, only the keys lexicographically greater than the specified key-marker
will be included in the list.
If upload-id-marker
is specified, any multipart uploads for a key equal to the key-marker
might also be included, provided those multipart uploads have upload IDs lexicographically greater than the specified upload-id-marker
.
pub fn get_key_marker(&self) -> &Option<String>
pub fn get_key_marker(&self) -> &Option<String>
Together with upload-id-marker
, this parameter specifies the multipart upload after which listing should begin.
If upload-id-marker
is not specified, only the keys lexicographically greater than the specified key-marker
will be included in the list.
If upload-id-marker
is specified, any multipart uploads for a key equal to the key-marker
might also be included, provided those multipart uploads have upload IDs lexicographically greater than the specified upload-id-marker
.
pub fn max_uploads(self, input: i32) -> ListMultipartUploadsInputBuilder
pub fn max_uploads(self, input: i32) -> ListMultipartUploadsInputBuilder
Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response.
pub fn set_max_uploads(
self,
input: Option<i32>
) -> ListMultipartUploadsInputBuilder
pub fn set_max_uploads( self, input: Option<i32> ) -> ListMultipartUploadsInputBuilder
Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response.
pub fn get_max_uploads(&self) -> &Option<i32>
pub fn get_max_uploads(&self) -> &Option<i32>
Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response.
pub fn prefix(
self,
input: impl Into<String>
) -> ListMultipartUploadsInputBuilder
pub fn prefix( self, input: impl Into<String> ) -> ListMultipartUploadsInputBuilder
Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix
to make groups in the same way that you'd use a folder in a file system.)
pub fn set_prefix(
self,
input: Option<String>
) -> ListMultipartUploadsInputBuilder
pub fn set_prefix( self, input: Option<String> ) -> ListMultipartUploadsInputBuilder
Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix
to make groups in the same way that you'd use a folder in a file system.)
pub fn get_prefix(&self) -> &Option<String>
pub fn get_prefix(&self) -> &Option<String>
Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix
to make groups in the same way that you'd use a folder in a file system.)
pub fn upload_id_marker(
self,
input: impl Into<String>
) -> ListMultipartUploadsInputBuilder
pub fn upload_id_marker( self, input: impl Into<String> ) -> ListMultipartUploadsInputBuilder
Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified upload-id-marker
.
pub fn set_upload_id_marker(
self,
input: Option<String>
) -> ListMultipartUploadsInputBuilder
pub fn set_upload_id_marker( self, input: Option<String> ) -> ListMultipartUploadsInputBuilder
Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified upload-id-marker
.
pub fn get_upload_id_marker(&self) -> &Option<String>
pub fn get_upload_id_marker(&self) -> &Option<String>
Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified upload-id-marker
.
pub fn expected_bucket_owner(
self,
input: impl Into<String>
) -> ListMultipartUploadsInputBuilder
pub fn expected_bucket_owner( self, input: impl Into<String> ) -> ListMultipartUploadsInputBuilder
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>
) -> ListMultipartUploadsInputBuilder
pub fn set_expected_bucket_owner( self, input: Option<String> ) -> ListMultipartUploadsInputBuilder
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 request_payer(
self,
input: RequestPayer
) -> ListMultipartUploadsInputBuilder
pub fn request_payer( self, input: RequestPayer ) -> ListMultipartUploadsInputBuilder
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.
pub fn set_request_payer(
self,
input: Option<RequestPayer>
) -> ListMultipartUploadsInputBuilder
pub fn set_request_payer( self, input: Option<RequestPayer> ) -> ListMultipartUploadsInputBuilder
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.
pub fn get_request_payer(&self) -> &Option<RequestPayer>
pub fn get_request_payer(&self) -> &Option<RequestPayer>
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.
pub fn build(self) -> Result<ListMultipartUploadsInput, BuildError>
pub fn build(self) -> Result<ListMultipartUploadsInput, BuildError>
Consumes the builder and constructs a ListMultipartUploadsInput
.
§impl ListMultipartUploadsInputBuilder
impl ListMultipartUploadsInputBuilder
pub async fn send_with(
self,
client: &Client
) -> Result<ListMultipartUploadsOutput, SdkError<ListMultipartUploadsError, Response<SdkBody>>>
pub async fn send_with( self, client: &Client ) -> Result<ListMultipartUploadsOutput, SdkError<ListMultipartUploadsError, Response<SdkBody>>>
Sends a request with this input using the given client.
Trait Implementations§
§impl Clone for ListMultipartUploadsInputBuilder
impl Clone for ListMultipartUploadsInputBuilder
§fn clone(&self) -> ListMultipartUploadsInputBuilder
fn clone(&self) -> ListMultipartUploadsInputBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more§impl Debug for ListMultipartUploadsInputBuilder
impl Debug for ListMultipartUploadsInputBuilder
§impl Default for ListMultipartUploadsInputBuilder
impl Default for ListMultipartUploadsInputBuilder
§fn default() -> ListMultipartUploadsInputBuilder
fn default() -> ListMultipartUploadsInputBuilder
§impl PartialEq for ListMultipartUploadsInputBuilder
impl PartialEq for ListMultipartUploadsInputBuilder
§fn eq(&self, other: &ListMultipartUploadsInputBuilder) -> bool
fn eq(&self, other: &ListMultipartUploadsInputBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.