/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include namespace Aws { namespace Http { class URI; } //namespace Http namespace S3 { namespace Model { /** */ class AWS_S3_API DeleteObjectsRequest : public S3Request { public: DeleteObjectsRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "DeleteObjects"; } Aws::String SerializePayload() const override; void AddQueryStringParameters(Aws::Http::URI& uri) const override; Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; inline bool ShouldComputeContentMd5() const override { return true; } /** *

The bucket name containing the objects to delete.

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 using 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 using this action using S3 on Outposts through the Amazon Web Services * SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more * information about S3 on Outposts ARNs, see Using * S3 on Outposts in the Amazon S3 User Guide.

*/ inline const Aws::String& GetBucket() const{ return m_bucket; } /** *

The bucket name containing the objects to delete.

*/ inline bool BucketHasBeenSet() const { return m_bucketHasBeenSet; } /** *

The bucket name containing the objects to delete.

*/ inline void SetBucket(const Aws::String& value) { m_bucketHasBeenSet = true; m_bucket = value; } /** *

The bucket name containing the objects to delete.

*/ inline void SetBucket(Aws::String&& value) { m_bucketHasBeenSet = true; m_bucket = std::move(value); } /** *

The bucket name containing the objects to delete.

*/ inline void SetBucket(const char* value) { m_bucketHasBeenSet = true; m_bucket.assign(value); } /** *

The bucket name containing the objects to delete.

*/ inline DeleteObjectsRequest& WithBucket(const Aws::String& value) { SetBucket(value); return *this;} /** *

The bucket name containing the objects to delete.

*/ inline DeleteObjectsRequest& WithBucket(Aws::String&& value) { SetBucket(std::move(value)); return *this;} /** *

The bucket name containing the objects to delete.

*/ inline DeleteObjectsRequest& WithBucket(const char* value) { SetBucket(value); return *this;} /** *

Container for the request.

*/ inline const Delete& GetDelete() const{ return m_delete; } /** *

Container for the request.

*/ inline bool DeleteHasBeenSet() const { return m_deleteHasBeenSet; } /** *

Container for the request.

*/ inline void SetDelete(const Delete& value) { m_deleteHasBeenSet = true; m_delete = value; } /** *

Container for the request.

*/ inline void SetDelete(Delete&& value) { m_deleteHasBeenSet = true; m_delete = std::move(value); } /** *

Container for the request.

*/ inline DeleteObjectsRequest& WithDelete(const Delete& value) { SetDelete(value); return *this;} /** *

Container for the request.

*/ inline DeleteObjectsRequest& WithDelete(Delete&& value) { SetDelete(std::move(value)); return *this;} /** *

The concatenation of the authentication device's serial number, a space, and * the value that is displayed on your authentication device. Required to * permanently delete a versioned object if versioning is configured with MFA * delete enabled.

*/ inline const Aws::String& GetMFA() const{ return m_mFA; } /** *

*/ inline bool MFAHasBeenSet() const { return m_mFAHasBeenSet; } /** *

*/ inline void SetMFA(const Aws::String& value) { m_mFAHasBeenSet = true; m_mFA = value; } /** *

*/ inline void SetMFA(Aws::String&& value) { m_mFAHasBeenSet = true; m_mFA = std::move(value); } /** *

*/ inline void SetMFA(const char* value) { m_mFAHasBeenSet = true; m_mFA.assign(value); } /** *

*/ inline DeleteObjectsRequest& WithMFA(const Aws::String& value) { SetMFA(value); return *this;} /** *

*/ inline DeleteObjectsRequest& WithMFA(Aws::String&& value) { SetMFA(std::move(value)); return *this;} /** *

*/ inline DeleteObjectsRequest& WithMFA(const char* value) { SetMFA(value); return *this;} inline const RequestPayer& GetRequestPayer() const{ return m_requestPayer; } inline bool RequestPayerHasBeenSet() const { return m_requestPayerHasBeenSet; } inline void SetRequestPayer(const RequestPayer& value) { m_requestPayerHasBeenSet = true; m_requestPayer = value; } inline void SetRequestPayer(RequestPayer&& value) { m_requestPayerHasBeenSet = true; m_requestPayer = std::move(value); } inline DeleteObjectsRequest& WithRequestPayer(const RequestPayer& value) { SetRequestPayer(value); return *this;} inline DeleteObjectsRequest& WithRequestPayer(RequestPayer&& value) { SetRequestPayer(std::move(value)); return *this;} /** *

Specifies whether you want to delete this object even if it has a * Governance-type Object Lock in place. To use this header, you must have the * s3:PutBucketPublicAccessBlock permission.

*/ inline bool GetBypassGovernanceRetention() const{ return m_bypassGovernanceRetention; } /** *

Specifies whether you want to delete this object even if it has a * Governance-type Object Lock in place. To use this header, you must have the * s3:PutBucketPublicAccessBlock permission.

*/ inline bool BypassGovernanceRetentionHasBeenSet() const { return m_bypassGovernanceRetentionHasBeenSet; } /** *

Specifies whether you want to delete this object even if it has a * Governance-type Object Lock in place. To use this header, you must have the * s3:PutBucketPublicAccessBlock permission.

*/ inline void SetBypassGovernanceRetention(bool value) { m_bypassGovernanceRetentionHasBeenSet = true; m_bypassGovernanceRetention = value; } /** *

Specifies whether you want to delete this object even if it has a * Governance-type Object Lock in place. To use this header, you must have the * s3:PutBucketPublicAccessBlock permission.

*/ inline DeleteObjectsRequest& WithBypassGovernanceRetention(bool value) { SetBypassGovernanceRetention(value); return *this;} /** *