Struct aws_sdk_s3::operation::get_object_legal_hold::builders::GetObjectLegalHoldInputBuilder

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

A builder for GetObjectLegalHoldInput.

Implementations

impl GetObjectLegalHoldInputBuilder

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

The bucket name containing the object whose legal hold status you want to retrieve.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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.

This field is required.

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

The bucket name containing the object whose legal hold status you want to retrieve.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 legal hold status you want to retrieve.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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>) -> Self

The key name for the object whose legal hold status you want to retrieve.

This field is required.

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

The key name for the object whose legal hold status you want to retrieve.

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

The key name for the object whose legal hold status you want to retrieve.

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

The version ID of the object whose legal hold status you want to retrieve.

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

The version ID of the object whose legal hold status you want to retrieve.

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

The version ID of the object whose legal hold status you want to retrieve.

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

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

This functionality is not supported for directory buckets.

pub fn set_request_payer(self, input: Option<RequestPayer>) -> Self

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

This functionality is not supported for directory buckets.

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

This functionality is not supported for directory buckets.

pub fn expected_bucket_owner(self, input: impl Into<String>) -> Self

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

pub fn set_expected_bucket_owner(self, input: Option<String>) -> Self

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, 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 account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

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

Consumes the builder and constructs a GetObjectLegalHoldInput.

impl GetObjectLegalHoldInputBuilder

pub async fn send_with( self, client: &Client, ) -> Result<GetObjectLegalHoldOutput, SdkError<GetObjectLegalHoldError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for GetObjectLegalHoldInputBuilder

fn clone(&self) -> GetObjectLegalHoldInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetObjectLegalHoldInputBuilder

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

Formats the value using the given formatter.

impl Default for GetObjectLegalHoldInputBuilder

fn default() -> GetObjectLegalHoldInputBuilder

Returns the “default value” for a type.

impl PartialEq for GetObjectLegalHoldInputBuilder

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for GetObjectLegalHoldInputBuilder