246 lines
14 KiB
C++
246 lines
14 KiB
C++
/**
|
|
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
* SPDX-License-Identifier: Apache-2.0.
|
|
*/
|
|
|
|
#pragma once
|
|
#include <aws/s3/S3_EXPORTS.h>
|
|
#include <aws/s3/S3Request.h>
|
|
#include <aws/core/utils/memory/stl/AWSString.h>
|
|
#include <aws/s3/model/ObjectLockRetention.h>
|
|
#include <aws/s3/model/RequestPayer.h>
|
|
#include <aws/s3/model/ChecksumAlgorithm.h>
|
|
#include <aws/core/utils/memory/stl/AWSMap.h>
|
|
#include <utility>
|
|
|
|
namespace Aws
|
|
{
|
|
namespace Http
|
|
{
|
|
class URI;
|
|
} //namespace Http
|
|
namespace S3
|
|
{
|
|
namespace Model
|
|
{
|
|
|
|
/**
|
|
*/
|
|
class PutObjectRetentionRequest : public S3Request
|
|
{
|
|
public:
|
|
AWS_S3_API PutObjectRetentionRequest();
|
|
|
|
// 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 "PutObjectRetention"; }
|
|
|
|
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 bool HasEmbeddedError(IOStream &body, const Http::HeaderValueCollection &header) 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;
|
|
|
|
///@{
|
|
/**
|
|
* <p>The bucket name that contains the object you want to apply this Object
|
|
* Retention configuration to. </p> <p> <b>Access points</b> - 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
|
|
* <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.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 <a
|
|
* href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using
|
|
* access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
*/
|
|
inline const Aws::String& GetBucket() const{ return m_bucket; }
|
|
inline bool BucketHasBeenSet() const { return m_bucketHasBeenSet; }
|
|
inline void SetBucket(const Aws::String& value) { m_bucketHasBeenSet = true; m_bucket = value; }
|
|
inline void SetBucket(Aws::String&& value) { m_bucketHasBeenSet = true; m_bucket = std::move(value); }
|
|
inline void SetBucket(const char* value) { m_bucketHasBeenSet = true; m_bucket.assign(value); }
|
|
inline PutObjectRetentionRequest& WithBucket(const Aws::String& value) { SetBucket(value); return *this;}
|
|
inline PutObjectRetentionRequest& WithBucket(Aws::String&& value) { SetBucket(std::move(value)); return *this;}
|
|
inline PutObjectRetentionRequest& WithBucket(const char* value) { SetBucket(value); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>The key name for the object that you want to apply this Object Retention
|
|
* configuration to.</p>
|
|
*/
|
|
inline const Aws::String& GetKey() const{ return m_key; }
|
|
inline bool KeyHasBeenSet() const { return m_keyHasBeenSet; }
|
|
inline void SetKey(const Aws::String& value) { m_keyHasBeenSet = true; m_key = value; }
|
|
inline void SetKey(Aws::String&& value) { m_keyHasBeenSet = true; m_key = std::move(value); }
|
|
inline void SetKey(const char* value) { m_keyHasBeenSet = true; m_key.assign(value); }
|
|
inline PutObjectRetentionRequest& WithKey(const Aws::String& value) { SetKey(value); return *this;}
|
|
inline PutObjectRetentionRequest& WithKey(Aws::String&& value) { SetKey(std::move(value)); return *this;}
|
|
inline PutObjectRetentionRequest& WithKey(const char* value) { SetKey(value); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>The container element for the Object Retention configuration.</p>
|
|
*/
|
|
inline const ObjectLockRetention& GetRetention() const{ return m_retention; }
|
|
inline bool RetentionHasBeenSet() const { return m_retentionHasBeenSet; }
|
|
inline void SetRetention(const ObjectLockRetention& value) { m_retentionHasBeenSet = true; m_retention = value; }
|
|
inline void SetRetention(ObjectLockRetention&& value) { m_retentionHasBeenSet = true; m_retention = std::move(value); }
|
|
inline PutObjectRetentionRequest& WithRetention(const ObjectLockRetention& value) { SetRetention(value); return *this;}
|
|
inline PutObjectRetentionRequest& WithRetention(ObjectLockRetention&& value) { SetRetention(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 PutObjectRetentionRequest& WithRequestPayer(const RequestPayer& value) { SetRequestPayer(value); return *this;}
|
|
inline PutObjectRetentionRequest& WithRequestPayer(RequestPayer&& value) { SetRequestPayer(std::move(value)); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>The version ID for the object that you want to apply this Object Retention
|
|
* configuration to.</p>
|
|
*/
|
|
inline const Aws::String& GetVersionId() const{ return m_versionId; }
|
|
inline bool VersionIdHasBeenSet() const { return m_versionIdHasBeenSet; }
|
|
inline void SetVersionId(const Aws::String& value) { m_versionIdHasBeenSet = true; m_versionId = value; }
|
|
inline void SetVersionId(Aws::String&& value) { m_versionIdHasBeenSet = true; m_versionId = std::move(value); }
|
|
inline void SetVersionId(const char* value) { m_versionIdHasBeenSet = true; m_versionId.assign(value); }
|
|
inline PutObjectRetentionRequest& WithVersionId(const Aws::String& value) { SetVersionId(value); return *this;}
|
|
inline PutObjectRetentionRequest& WithVersionId(Aws::String&& value) { SetVersionId(std::move(value)); return *this;}
|
|
inline PutObjectRetentionRequest& WithVersionId(const char* value) { SetVersionId(value); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>Indicates whether this action should bypass Governance-mode restrictions.</p>
|
|
*/
|
|
inline bool GetBypassGovernanceRetention() const{ return m_bypassGovernanceRetention; }
|
|
inline bool BypassGovernanceRetentionHasBeenSet() const { return m_bypassGovernanceRetentionHasBeenSet; }
|
|
inline void SetBypassGovernanceRetention(bool value) { m_bypassGovernanceRetentionHasBeenSet = true; m_bypassGovernanceRetention = value; }
|
|
inline PutObjectRetentionRequest& WithBypassGovernanceRetention(bool value) { SetBypassGovernanceRetention(value); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>The MD5 hash for the request body.</p> <p>For requests made using the Amazon
|
|
* Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this
|
|
* field is calculated automatically.</p>
|
|
*/
|
|
inline const Aws::String& GetContentMD5() const{ return m_contentMD5; }
|
|
inline bool ContentMD5HasBeenSet() const { return m_contentMD5HasBeenSet; }
|
|
inline void SetContentMD5(const Aws::String& value) { m_contentMD5HasBeenSet = true; m_contentMD5 = value; }
|
|
inline void SetContentMD5(Aws::String&& value) { m_contentMD5HasBeenSet = true; m_contentMD5 = std::move(value); }
|
|
inline void SetContentMD5(const char* value) { m_contentMD5HasBeenSet = true; m_contentMD5.assign(value); }
|
|
inline PutObjectRetentionRequest& WithContentMD5(const Aws::String& value) { SetContentMD5(value); return *this;}
|
|
inline PutObjectRetentionRequest& WithContentMD5(Aws::String&& value) { SetContentMD5(std::move(value)); return *this;}
|
|
inline PutObjectRetentionRequest& WithContentMD5(const char* value) { SetContentMD5(value); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>Indicates the algorithm used to create the checksum for the object when you
|
|
* use the SDK. This header will not provide any additional functionality if you
|
|
* don't use the SDK. When you send this header, there must be a corresponding
|
|
* <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent.
|
|
* Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad
|
|
* Request</code>. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking
|
|
* object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide
|
|
* an individual checksum, Amazon S3 ignores any provided
|
|
* <code>ChecksumAlgorithm</code> parameter.</p>
|
|
*/
|
|
inline const ChecksumAlgorithm& GetChecksumAlgorithm() const{ return m_checksumAlgorithm; }
|
|
inline bool ChecksumAlgorithmHasBeenSet() const { return m_checksumAlgorithmHasBeenSet; }
|
|
inline void SetChecksumAlgorithm(const ChecksumAlgorithm& value) { m_checksumAlgorithmHasBeenSet = true; m_checksumAlgorithm = value; }
|
|
inline void SetChecksumAlgorithm(ChecksumAlgorithm&& value) { m_checksumAlgorithmHasBeenSet = true; m_checksumAlgorithm = std::move(value); }
|
|
inline PutObjectRetentionRequest& WithChecksumAlgorithm(const ChecksumAlgorithm& value) { SetChecksumAlgorithm(value); return *this;}
|
|
inline PutObjectRetentionRequest& WithChecksumAlgorithm(ChecksumAlgorithm&& value) { SetChecksumAlgorithm(std::move(value)); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>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 <code>403 Forbidden</code> (access denied).</p>
|
|
*/
|
|
inline const Aws::String& GetExpectedBucketOwner() const{ return m_expectedBucketOwner; }
|
|
inline bool ExpectedBucketOwnerHasBeenSet() const { return m_expectedBucketOwnerHasBeenSet; }
|
|
inline void SetExpectedBucketOwner(const Aws::String& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = value; }
|
|
inline void SetExpectedBucketOwner(Aws::String&& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = std::move(value); }
|
|
inline void SetExpectedBucketOwner(const char* value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner.assign(value); }
|
|
inline PutObjectRetentionRequest& WithExpectedBucketOwner(const Aws::String& value) { SetExpectedBucketOwner(value); return *this;}
|
|
inline PutObjectRetentionRequest& WithExpectedBucketOwner(Aws::String&& value) { SetExpectedBucketOwner(std::move(value)); return *this;}
|
|
inline PutObjectRetentionRequest& WithExpectedBucketOwner(const char* value) { SetExpectedBucketOwner(value); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
|
|
inline const Aws::Map<Aws::String, Aws::String>& GetCustomizedAccessLogTag() const{ return m_customizedAccessLogTag; }
|
|
inline bool CustomizedAccessLogTagHasBeenSet() const { return m_customizedAccessLogTagHasBeenSet; }
|
|
inline void SetCustomizedAccessLogTag(const Aws::Map<Aws::String, Aws::String>& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = value; }
|
|
inline void SetCustomizedAccessLogTag(Aws::Map<Aws::String, Aws::String>&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = std::move(value); }
|
|
inline PutObjectRetentionRequest& WithCustomizedAccessLogTag(const Aws::Map<Aws::String, Aws::String>& value) { SetCustomizedAccessLogTag(value); return *this;}
|
|
inline PutObjectRetentionRequest& WithCustomizedAccessLogTag(Aws::Map<Aws::String, Aws::String>&& value) { SetCustomizedAccessLogTag(std::move(value)); return *this;}
|
|
inline PutObjectRetentionRequest& AddCustomizedAccessLogTag(const Aws::String& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; }
|
|
inline PutObjectRetentionRequest& AddCustomizedAccessLogTag(Aws::String&& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; }
|
|
inline PutObjectRetentionRequest& AddCustomizedAccessLogTag(const Aws::String& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; }
|
|
inline PutObjectRetentionRequest& AddCustomizedAccessLogTag(Aws::String&& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), std::move(value)); return *this; }
|
|
inline PutObjectRetentionRequest& AddCustomizedAccessLogTag(const char* key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; }
|
|
inline PutObjectRetentionRequest& AddCustomizedAccessLogTag(Aws::String&& key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; }
|
|
inline PutObjectRetentionRequest& 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;
|
|
|
|
ObjectLockRetention m_retention;
|
|
bool m_retentionHasBeenSet = false;
|
|
|
|
RequestPayer m_requestPayer;
|
|
bool m_requestPayerHasBeenSet = false;
|
|
|
|
Aws::String m_versionId;
|
|
bool m_versionIdHasBeenSet = false;
|
|
|
|
bool m_bypassGovernanceRetention;
|
|
bool m_bypassGovernanceRetentionHasBeenSet = 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<Aws::String, Aws::String> m_customizedAccessLogTag;
|
|
bool m_customizedAccessLogTagHasBeenSet = false;
|
|
};
|
|
|
|
} // namespace Model
|
|
} // namespace S3
|
|
} // namespace Aws
|