Struct bonsaidb::keystorage::s3::aws_sdk_s3::operation::get_object_retention::builders::GetObjectRetentionFluentBuilder

pub struct GetObjectRetentionFluentBuilder { /* private fields */ }

Fluent builder constructing a request to GetObjectRetention.

Retrieves an object's retention settings. For more information, see Locking Objects.

This action is not supported by Amazon S3 on Outposts.

The following action is related to GetObjectRetention:

• GetObjectAttributes

Implementations

impl GetObjectRetentionFluentBuilder

pub fn as_input(&self) -> &GetObjectRetentionInputBuilder

Access the GetObjectRetention as a reference.

pub async fn send( self ) -> impl Future<Output = Result<GetObjectRetentionOutput, SdkError<GetObjectRetentionError, 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<GetObjectRetentionOutput, GetObjectRetentionError, GetObjectRetentionFluentBuilder>, SdkError<GetObjectRetentionError, Response>>>

Consumes this builder, creating a customizable operation that can be modified before being sent.

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

The bucket name containing the object whose retention settings you want to retrieve.

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.

pub fn set_bucket( self, input: Option<String> ) -> GetObjectRetentionFluentBuilder

The bucket name containing the object whose retention settings you want to retrieve.

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.

pub fn get_bucket(&self) -> &Option<String>

The bucket name containing the object whose retention settings you want to retrieve.

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.

pub fn key(self, input: impl Into<String>) -> GetObjectRetentionFluentBuilder

The key name for the object whose retention settings you want to retrieve.

pub fn set_key(self, input: Option<String>) -> GetObjectRetentionFluentBuilder

The key name for the object whose retention settings you want to retrieve.

pub fn get_key(&self) -> &Option<String>

The key name for the object whose retention settings you want to retrieve.

pub fn version_id( self, input: impl Into<String> ) -> GetObjectRetentionFluentBuilder

The version ID for the object whose retention settings you want to retrieve.

pub fn set_version_id( self, input: Option<String> ) -> GetObjectRetentionFluentBuilder

The version ID for the object whose retention settings you want to retrieve.

pub fn get_version_id(&self) -> &Option<String>

The version ID for the object whose retention settings you want to retrieve.

pub fn request_payer( self, input: RequestPayer ) -> GetObjectRetentionFluentBuilder

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

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>

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 expected_bucket_owner( self, input: impl Into<String> ) -> GetObjectRetentionFluentBuilder

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

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

Trait Implementations

impl Clone for GetObjectRetentionFluentBuilder

fn clone(&self) -> GetObjectRetentionFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetObjectRetentionFluentBuilder

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

Formats the value using the given formatter.