/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace Http { class URI; } //namespace Http namespace S3 { namespace Model { /** */ class AWS_S3_API DeleteObjectRequest : public S3Request { public: DeleteObjectRequest(); // 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 "DeleteObject"; } Aws::String SerializePayload() const override; void AddQueryStringParameters(Aws::Http::URI& uri) const override; Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The bucket name of the bucket containing the object.

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 of the bucket containing the object.

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

The bucket name of the bucket containing the object.

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

The bucket name of the bucket containing the object.

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

The bucket name of the bucket containing the object.

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

The bucket name of the bucket containing the object.

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

The bucket name of the bucket containing the object.

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

The bucket name of the bucket containing the object.

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

Key name of the object to delete.

*/ inline const Aws::String& GetKey() const{ return m_key; } /** *

Key name of the object to delete.

*/ inline bool KeyHasBeenSet() const { return m_keyHasBeenSet; } /** *

Key name of the object to delete.

*/ inline void SetKey(const Aws::String& value) { m_keyHasBeenSet = true; m_key = value; } /** *

Key name of the object to delete.

*/ inline void SetKey(Aws::String&& value) { m_keyHasBeenSet = true; m_key = std::move(value); } /** *

Key name of the object to delete.

*/ inline void SetKey(const char* value) { m_keyHasBeenSet = true; m_key.assign(value); } /** *

Key name of the object to delete.

*/ inline DeleteObjectRequest& WithKey(const Aws::String& value) { SetKey(value); return *this;} /** *

Key name of the object to delete.

*/ inline DeleteObjectRequest& WithKey(Aws::String&& value) { SetKey(std::move(value)); return *this;} /** *

Key name of the object to delete.

*/ inline DeleteObjectRequest& WithKey(const char* value) { SetKey(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 DeleteObjectRequest& WithMFA(const Aws::String& value) { SetMFA(value); return *this;} /** *

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

*/ inline DeleteObjectRequest& WithMFA(const char* value) { SetMFA(value); return *this;} /** *

VersionId used to reference a specific version of the object.

*/ inline const Aws::String& GetVersionId() const{ return m_versionId; } /** *

VersionId used to reference a specific version of the object.

*/ inline bool VersionIdHasBeenSet() const { return m_versionIdHasBeenSet; } /** *

VersionId used to reference a specific version of the object.

*/ inline void SetVersionId(const Aws::String& value) { m_versionIdHasBeenSet = true; m_versionId = value; } /** *

VersionId used to reference a specific version of the object.

*/ inline void SetVersionId(Aws::String&& value) { m_versionIdHasBeenSet = true; m_versionId = std::move(value); } /** *

VersionId used to reference a specific version of the object.

*/ inline void SetVersionId(const char* value) { m_versionIdHasBeenSet = true; m_versionId.assign(value); } /** *

VersionId used to reference a specific version of the object.

*/ inline DeleteObjectRequest& WithVersionId(const Aws::String& value) { SetVersionId(value); return *this;} /** *

VersionId used to reference a specific version of the object.

*/ inline DeleteObjectRequest& WithVersionId(Aws::String&& value) { SetVersionId(std::move(value)); return *this;} /** *

VersionId used to reference a specific version of the object.

*/ inline DeleteObjectRequest& WithVersionId(const char* value) { SetVersionId(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 DeleteObjectRequest& WithRequestPayer(const RequestPayer& value) { SetRequestPayer(value); return *this;} inline DeleteObjectRequest& WithRequestPayer(RequestPayer&& value) { SetRequestPayer(std::move(value)); return *this;} /** *

Indicates whether S3 Object Lock should bypass Governance-mode restrictions * to process this operation. To use this header, you must have the * s3:PutBucketPublicAccessBlock permission.

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

Indicates whether S3 Object Lock should bypass Governance-mode restrictions * to process this operation. To use this header, you must have the * s3:PutBucketPublicAccessBlock permission.

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

Indicates whether S3 Object Lock should bypass Governance-mode restrictions * to process this operation. To use this header, you must have the * s3:PutBucketPublicAccessBlock permission.

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

Indicates whether S3 Object Lock should bypass Governance-mode restrictions * to process this operation. To use this header, you must have the * s3:PutBucketPublicAccessBlock permission.

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