/** * 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 #include namespace Aws { namespace Http { class URI; } //namespace Http namespace S3 { namespace Model { /** */ class PutObjectLegalHoldRequest : public S3Request { public: AWS_S3_API PutObjectLegalHoldRequest(); // 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 "PutObjectLegalHold"; } AWS_S3_API Aws::String SerializePayload() const override; AWS_S3_API void AddQueryStringParameters(Aws::Http::URI& uri) const override; AWS_S3_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; AWS_S3_API Aws::String GetChecksumAlgorithmName() const override; /** * Helper function to collect parameters (configurable and static hardcoded) required for endpoint computation. */ AWS_S3_API EndpointParameters GetEndpointContextParams() const override; /** *

The bucket name containing the object that you want to place a legal hold on. *

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.

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

The bucket name containing the object that you want to place a legal hold on. *

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.

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

The bucket name containing the object that you want to place a legal hold on. *

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.

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

The bucket name containing the object that you want to place a legal hold on. *

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.

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

The bucket name containing the object that you want to place a legal hold on. *

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.

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

The bucket name containing the object that you want to place a legal hold on. *

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.

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

The bucket name containing the object that you want to place a legal hold on. *

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.

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

The bucket name containing the object that you want to place a legal hold on. *

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.

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

The key name for the object that you want to place a legal hold on.

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

The key name for the object that you want to place a legal hold on.

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

The key name for the object that you want to place a legal hold on.

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

The key name for the object that you want to place a legal hold on.

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

The key name for the object that you want to place a legal hold on.

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

The key name for the object that you want to place a legal hold on.

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

The key name for the object that you want to place a legal hold on.

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

The key name for the object that you want to place a legal hold on.

*/ inline PutObjectLegalHoldRequest& WithKey(const char* value) { SetKey(value); return *this;} /** *

Container element for the legal hold configuration you want to apply to the * specified object.

*/ inline const ObjectLockLegalHold& GetLegalHold() const{ return m_legalHold; } /** *

Container element for the legal hold configuration you want to apply to the * specified object.

*/ inline bool LegalHoldHasBeenSet() const { return m_legalHoldHasBeenSet; } /** *

Container element for the legal hold configuration you want to apply to the * specified object.

*/ inline void SetLegalHold(const ObjectLockLegalHold& value) { m_legalHoldHasBeenSet = true; m_legalHold = value; } /** *

Container element for the legal hold configuration you want to apply to the * specified object.

*/ inline void SetLegalHold(ObjectLockLegalHold&& value) { m_legalHoldHasBeenSet = true; m_legalHold = std::move(value); } /** *

Container element for the legal hold configuration you want to apply to the * specified object.

*/ inline PutObjectLegalHoldRequest& WithLegalHold(const ObjectLockLegalHold& value) { SetLegalHold(value); return *this;} /** *

Container element for the legal hold configuration you want to apply to the * specified object.

*/ inline PutObjectLegalHoldRequest& WithLegalHold(ObjectLockLegalHold&& value) { SetLegalHold(std::move(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 PutObjectLegalHoldRequest& WithRequestPayer(const RequestPayer& value) { SetRequestPayer(value); return *this;} inline PutObjectLegalHoldRequest& WithRequestPayer(RequestPayer&& value) { SetRequestPayer(std::move(value)); return *this;} /** *

The version ID of the object that you want to place a legal hold on.

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

The version ID of the object that you want to place a legal hold on.

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

The version ID of the object that you want to place a legal hold on.

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

The version ID of the object that you want to place a legal hold on.

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

The version ID of the object that you want to place a legal hold on.

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

The version ID of the object that you want to place a legal hold on.

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

The version ID of the object that you want to place a legal hold on.

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

The version ID of the object that you want to place a legal hold on.

*/ inline PutObjectLegalHoldRequest& WithVersionId(const char* value) { SetVersionId(value); return *this;} /** *

The MD5 hash for the request body.

For requests made using the Amazon * Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this * field is calculated automatically.

*/ inline const Aws::String& GetContentMD5() const{ return m_contentMD5; } /** *

The MD5 hash for the request body.

For requests made using the Amazon * Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this * field is calculated automatically.

*/ inline bool ContentMD5HasBeenSet() const { return m_contentMD5HasBeenSet; } /** *

The MD5 hash for the request body.

For requests made using the Amazon * Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this * field is calculated automatically.

*/ inline void SetContentMD5(const Aws::String& value) { m_contentMD5HasBeenSet = true; m_contentMD5 = value; } /** *

The MD5 hash for the request body.

For requests made using the Amazon * Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this * field is calculated automatically.

*/ inline void SetContentMD5(Aws::String&& value) { m_contentMD5HasBeenSet = true; m_contentMD5 = std::move(value); } /** *

The MD5 hash for the request body.

For requests made using the Amazon * Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this * field is calculated automatically.

*/ inline void SetContentMD5(const char* value) { m_contentMD5HasBeenSet = true; m_contentMD5.assign(value); } /** *

The MD5 hash for the request body.

For requests made using the Amazon * Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this * field is calculated automatically.

*/ inline PutObjectLegalHoldRequest& WithContentMD5(const Aws::String& value) { SetContentMD5(value); return *this;} /** *

The MD5 hash for the request body.

For requests made using the Amazon * Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this * field is calculated automatically.

*/ inline PutObjectLegalHoldRequest& WithContentMD5(Aws::String&& value) { SetContentMD5(std::move(value)); return *this;} /** *

The MD5 hash for the request body.

For requests made using the Amazon * Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this * field is calculated automatically.

*/ inline PutObjectLegalHoldRequest& WithContentMD5(const char* value) { SetContentMD5(value); return *this;} /** *

Indicates the algorithm used to create the checksum for the object when using * the SDK. This header will not provide any additional functionality if not using * the SDK. When sending this header, there must be a corresponding * x-amz-checksum or x-amz-trailer header sent. * Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad * Request. For more information, see Checking * object integrity in the Amazon S3 User Guide.

If you provide * an individual checksum, Amazon S3 ignores any provided * ChecksumAlgorithm parameter.

*/ inline const ChecksumAlgorithm& GetChecksumAlgorithm() const{ return m_checksumAlgorithm; } /** *

Indicates the algorithm used to create the checksum for the object when using * the SDK. This header will not provide any additional functionality if not using * the SDK. When sending this header, there must be a corresponding * x-amz-checksum or x-amz-trailer header sent. * Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad * Request. For more information, see Checking * object integrity in the Amazon S3 User Guide.

If you provide * an individual checksum, Amazon S3 ignores any provided * ChecksumAlgorithm parameter.

*/ inline bool ChecksumAlgorithmHasBeenSet() const { return m_checksumAlgorithmHasBeenSet; } /** *

Indicates the algorithm used to create the checksum for the object when using * the SDK. This header will not provide any additional functionality if not using * the SDK. When sending this header, there must be a corresponding * x-amz-checksum or x-amz-trailer header sent. * Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad * Request. For more information, see Checking * object integrity in the Amazon S3 User Guide.

If you provide * an individual checksum, Amazon S3 ignores any provided * ChecksumAlgorithm parameter.

*/ inline void SetChecksumAlgorithm(const ChecksumAlgorithm& value) { m_checksumAlgorithmHasBeenSet = true; m_checksumAlgorithm = value; } /** *

Indicates the algorithm used to create the checksum for the object when using * the SDK. This header will not provide any additional functionality if not using * the SDK. When sending this header, there must be a corresponding * x-amz-checksum or x-amz-trailer header sent. * Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad * Request. For more information, see Checking * object integrity in the Amazon S3 User Guide.

If you provide * an individual checksum, Amazon S3 ignores any provided * ChecksumAlgorithm parameter.

*/ inline void SetChecksumAlgorithm(ChecksumAlgorithm&& value) { m_checksumAlgorithmHasBeenSet = true; m_checksumAlgorithm = std::move(value); } /** *

Indicates the algorithm used to create the checksum for the object when using * the SDK. This header will not provide any additional functionality if not using * the SDK. When sending this header, there must be a corresponding * x-amz-checksum or x-amz-trailer header sent. * Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad * Request. For more information, see Checking * object integrity in the Amazon S3 User Guide.

If you provide * an individual checksum, Amazon S3 ignores any provided * ChecksumAlgorithm parameter.

*/ inline PutObjectLegalHoldRequest& WithChecksumAlgorithm(const ChecksumAlgorithm& value) { SetChecksumAlgorithm(value); return *this;} /** *

Indicates the algorithm used to create the checksum for the object when using * the SDK. This header will not provide any additional functionality if not using * the SDK. When sending this header, there must be a corresponding * x-amz-checksum or x-amz-trailer header sent. * Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad * Request. For more information, see Checking * object integrity in the Amazon S3 User Guide.

If you provide * an individual checksum, Amazon S3 ignores any provided * ChecksumAlgorithm parameter.

*/ inline PutObjectLegalHoldRequest& WithChecksumAlgorithm(ChecksumAlgorithm&& value) { SetChecksumAlgorithm(std::move(value)); return *this;} /** *

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

*/ inline const Aws::String& GetExpectedBucketOwner() const{ return m_expectedBucketOwner; } /** *

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

*/ inline bool ExpectedBucketOwnerHasBeenSet() const { return m_expectedBucketOwnerHasBeenSet; } /** *

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

*/ inline void SetExpectedBucketOwner(const Aws::String& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = value; } /** *

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

*/ inline void SetExpectedBucketOwner(Aws::String&& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = std::move(value); } /** *

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

*/ inline void SetExpectedBucketOwner(const char* value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner.assign(value); } /** *

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

*/ inline PutObjectLegalHoldRequest& WithExpectedBucketOwner(const Aws::String& value) { SetExpectedBucketOwner(value); return *this;} /** *

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

*/ inline PutObjectLegalHoldRequest& WithExpectedBucketOwner(Aws::String&& value) { SetExpectedBucketOwner(std::move(value)); return *this;} /** *

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

*/ inline PutObjectLegalHoldRequest& WithExpectedBucketOwner(const char* value) { SetExpectedBucketOwner(value); return *this;} inline const Aws::Map& GetCustomizedAccessLogTag() const{ return m_customizedAccessLogTag; } inline bool CustomizedAccessLogTagHasBeenSet() const { return m_customizedAccessLogTagHasBeenSet; } inline void SetCustomizedAccessLogTag(const Aws::Map& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = value; } inline void SetCustomizedAccessLogTag(Aws::Map&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = std::move(value); } inline PutObjectLegalHoldRequest& WithCustomizedAccessLogTag(const Aws::Map& value) { SetCustomizedAccessLogTag(value); return *this;} inline PutObjectLegalHoldRequest& WithCustomizedAccessLogTag(Aws::Map&& value) { SetCustomizedAccessLogTag(std::move(value)); return *this;} inline PutObjectLegalHoldRequest& AddCustomizedAccessLogTag(const Aws::String& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; } inline PutObjectLegalHoldRequest& AddCustomizedAccessLogTag(Aws::String&& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; } inline PutObjectLegalHoldRequest& AddCustomizedAccessLogTag(const Aws::String& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; } inline PutObjectLegalHoldRequest& AddCustomizedAccessLogTag(Aws::String&& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), std::move(value)); return *this; } inline PutObjectLegalHoldRequest& AddCustomizedAccessLogTag(const char* key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; } inline PutObjectLegalHoldRequest& AddCustomizedAccessLogTag(Aws::String&& key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; } inline PutObjectLegalHoldRequest& AddCustomizedAccessLogTag(const char* key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; } private: Aws::String m_bucket; bool m_bucketHasBeenSet = false; Aws::String m_key; bool m_keyHasBeenSet = false; ObjectLockLegalHold m_legalHold; bool m_legalHoldHasBeenSet = false; RequestPayer m_requestPayer; bool m_requestPayerHasBeenSet = false; Aws::String m_versionId; bool m_versionIdHasBeenSet = false; Aws::String m_contentMD5; bool m_contentMD5HasBeenSet = false; ChecksumAlgorithm m_checksumAlgorithm; bool m_checksumAlgorithmHasBeenSet = false; Aws::String m_expectedBucketOwner; bool m_expectedBucketOwnerHasBeenSet = false; Aws::Map m_customizedAccessLogTag; bool m_customizedAccessLogTagHasBeenSet = false; }; } // namespace Model } // namespace S3 } // namespace Aws