/** * 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/core/utils/memory/stl/AWSString.h> #include <aws/s3/model/ServerSideEncryption.h> #include <aws/s3/model/RequestCharged.h> #include <utility> namespace Aws { template<typename RESULT_TYPE> class AmazonWebServiceResult; namespace Utils { namespace Xml { class XmlDocument; } // namespace Xml } // namespace Utils namespace S3 { namespace Model { class AWS_S3_API PutObjectResult { public: PutObjectResult(); PutObjectResult(const Aws::AmazonWebServiceResult<Aws::Utils::Xml::XmlDocument>& result); PutObjectResult& operator=(const Aws::AmazonWebServiceResult<Aws::Utils::Xml::XmlDocument>& result); /** * <p> If the expiration is configured for the object (see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a>), * the response includes this header. It includes the expiry-date and rule-id * key-value pairs that provide information about object expiration. The value of * the rule-id is URL encoded.</p> */ inline const Aws::String& GetExpiration() const{ return m_expiration; } /** * <p> If the expiration is configured for the object (see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a>), * the response includes this header. It includes the expiry-date and rule-id * key-value pairs that provide information about object expiration. The value of * the rule-id is URL encoded.</p> */ inline void SetExpiration(const Aws::String& value) { m_expiration = value; } /** * <p> If the expiration is configured for the object (see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a>), * the response includes this header. It includes the expiry-date and rule-id * key-value pairs that provide information about object expiration. The value of * the rule-id is URL encoded.</p> */ inline void SetExpiration(Aws::String&& value) { m_expiration = std::move(value); } /** * <p> If the expiration is configured for the object (see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a>), * the response includes this header. It includes the expiry-date and rule-id * key-value pairs that provide information about object expiration. The value of * the rule-id is URL encoded.</p> */ inline void SetExpiration(const char* value) { m_expiration.assign(value); } /** * <p> If the expiration is configured for the object (see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a>), * the response includes this header. It includes the expiry-date and rule-id * key-value pairs that provide information about object expiration. The value of * the rule-id is URL encoded.</p> */ inline PutObjectResult& WithExpiration(const Aws::String& value) { SetExpiration(value); return *this;} /** * <p> If the expiration is configured for the object (see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a>), * the response includes this header. It includes the expiry-date and rule-id * key-value pairs that provide information about object expiration. The value of * the rule-id is URL encoded.</p> */ inline PutObjectResult& WithExpiration(Aws::String&& value) { SetExpiration(std::move(value)); return *this;} /** * <p> If the expiration is configured for the object (see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a>), * the response includes this header. It includes the expiry-date and rule-id * key-value pairs that provide information about object expiration. The value of * the rule-id is URL encoded.</p> */ inline PutObjectResult& WithExpiration(const char* value) { SetExpiration(value); return *this;} /** * <p>Entity tag for the uploaded object.</p> */ inline const Aws::String& GetETag() const{ return m_eTag; } /** * <p>Entity tag for the uploaded object.</p> */ inline void SetETag(const Aws::String& value) { m_eTag = value; } /** * <p>Entity tag for the uploaded object.</p> */ inline void SetETag(Aws::String&& value) { m_eTag = std::move(value); } /** * <p>Entity tag for the uploaded object.</p> */ inline void SetETag(const char* value) { m_eTag.assign(value); } /** * <p>Entity tag for the uploaded object.</p> */ inline PutObjectResult& WithETag(const Aws::String& value) { SetETag(value); return *this;} /** * <p>Entity tag for the uploaded object.</p> */ inline PutObjectResult& WithETag(Aws::String&& value) { SetETag(std::move(value)); return *this;} /** * <p>Entity tag for the uploaded object.</p> */ inline PutObjectResult& WithETag(const char* value) { SetETag(value); return *this;} /** * <p>If you specified server-side encryption either with an AWS KMS customer * master key (CMK) or Amazon S3-managed encryption key in your PUT request, the * response includes this header. It confirms the encryption algorithm that Amazon * S3 used to encrypt the object.</p> */ inline const ServerSideEncryption& GetServerSideEncryption() const{ return m_serverSideEncryption; } /** * <p>If you specified server-side encryption either with an AWS KMS customer * master key (CMK) or Amazon S3-managed encryption key in your PUT request, the * response includes this header. It confirms the encryption algorithm that Amazon * S3 used to encrypt the object.</p> */ inline void SetServerSideEncryption(const ServerSideEncryption& value) { m_serverSideEncryption = value; } /** * <p>If you specified server-side encryption either with an AWS KMS customer * master key (CMK) or Amazon S3-managed encryption key in your PUT request, the * response includes this header. It confirms the encryption algorithm that Amazon * S3 used to encrypt the object.</p> */ inline void SetServerSideEncryption(ServerSideEncryption&& value) { m_serverSideEncryption = std::move(value); } /** * <p>If you specified server-side encryption either with an AWS KMS customer * master key (CMK) or Amazon S3-managed encryption key in your PUT request, the * response includes this header. It confirms the encryption algorithm that Amazon * S3 used to encrypt the object.</p> */ inline PutObjectResult& WithServerSideEncryption(const ServerSideEncryption& value) { SetServerSideEncryption(value); return *this;} /** * <p>If you specified server-side encryption either with an AWS KMS customer * master key (CMK) or Amazon S3-managed encryption key in your PUT request, the * response includes this header. It confirms the encryption algorithm that Amazon * S3 used to encrypt the object.</p> */ inline PutObjectResult& WithServerSideEncryption(ServerSideEncryption&& value) { SetServerSideEncryption(std::move(value)); return *this;} /** * <p>Version of the object.</p> */ inline const Aws::String& GetVersionId() const{ return m_versionId; } /** * <p>Version of the object.</p> */ inline void SetVersionId(const Aws::String& value) { m_versionId = value; } /** * <p>Version of the object.</p> */ inline void SetVersionId(Aws::String&& value) { m_versionId = std::move(value); } /** * <p>Version of the object.</p> */ inline void SetVersionId(const char* value) { m_versionId.assign(value); } /** * <p>Version of the object.</p> */ inline PutObjectResult& WithVersionId(const Aws::String& value) { SetVersionId(value); return *this;} /** * <p>Version of the object.</p> */ inline PutObjectResult& WithVersionId(Aws::String&& value) { SetVersionId(std::move(value)); return *this;} /** * <p>Version of the object.</p> */ inline PutObjectResult& WithVersionId(const char* value) { SetVersionId(value); return *this;} /** * <p>If server-side encryption with a customer-provided encryption key was * requested, the response will include this header confirming the encryption * algorithm used.</p> */ inline const Aws::String& GetSSECustomerAlgorithm() const{ return m_sSECustomerAlgorithm; } /** * <p>If server-side encryption with a customer-provided encryption key was * requested, the response will include this header confirming the encryption * algorithm used.</p> */ inline void SetSSECustomerAlgorithm(const Aws::String& value) { m_sSECustomerAlgorithm = value; } /** * <p>If server-side encryption with a customer-provided encryption key was * requested, the response will include this header confirming the encryption * algorithm used.</p> */ inline void SetSSECustomerAlgorithm(Aws::String&& value) { m_sSECustomerAlgorithm = std::move(value); } /** * <p>If server-side encryption with a customer-provided encryption key was * requested, the response will include this header confirming the encryption * algorithm used.</p> */ inline void SetSSECustomerAlgorithm(const char* value) { m_sSECustomerAlgorithm.assign(value); } /** * <p>If server-side encryption with a customer-provided encryption key was * requested, the response will include this header confirming the encryption * algorithm used.</p> */ inline PutObjectResult& WithSSECustomerAlgorithm(const Aws::String& value) { SetSSECustomerAlgorithm(value); return *this;} /** * <p>If server-side encryption with a customer-provided encryption key was * requested, the response will include this header confirming the encryption * algorithm used.</p> */ inline PutObjectResult& WithSSECustomerAlgorithm(Aws::String&& value) { SetSSECustomerAlgorithm(std::move(value)); return *this;} /** * <p>If server-side encryption with a customer-provided encryption key was * requested, the response will include this header confirming the encryption * algorithm used.</p> */ inline PutObjectResult& WithSSECustomerAlgorithm(const char* value) { SetSSECustomerAlgorithm(value); return *this;} /** * <p>If server-side encryption with a customer-provided encryption key was * requested, the response will include this header to provide round-trip message * integrity verification of the customer-provided encryption key.</p> */ inline const Aws::String& GetSSECustomerKeyMD5() const{ return m_sSECustomerKeyMD5; } /** * <p>If server-side encryption with a customer-provided encryption key was * requested, the response will include this header to provide round-trip message * integrity verification of the customer-provided encryption key.</p> */ inline void SetSSECustomerKeyMD5(const Aws::String& value) { m_sSECustomerKeyMD5 = value; } /** * <p>If server-side encryption with a customer-provided encryption key was * requested, the response will include this header to provide round-trip message * integrity verification of the customer-provided encryption key.</p> */ inline void SetSSECustomerKeyMD5(Aws::String&& value) { m_sSECustomerKeyMD5 = std::move(value); } /** * <p>If server-side encryption with a customer-provided encryption key was * requested, the response will include this header to provide round-trip message * integrity verification of the customer-provided encryption key.</p> */ inline void SetSSECustomerKeyMD5(const char* value) { m_sSECustomerKeyMD5.assign(value); } /** * <p>If server-side encryption with a customer-provided encryption key was * requested, the response will include this header to provide round-trip message * integrity verification of the customer-provided encryption key.</p> */ inline PutObjectResult& WithSSECustomerKeyMD5(const Aws::String& value) { SetSSECustomerKeyMD5(value); return *this;} /** * <p>If server-side encryption with a customer-provided encryption key was * requested, the response will include this header to provide round-trip message * integrity verification of the customer-provided encryption key.</p> */ inline PutObjectResult& WithSSECustomerKeyMD5(Aws::String&& value) { SetSSECustomerKeyMD5(std::move(value)); return *this;} /** * <p>If server-side encryption with a customer-provided encryption key was * requested, the response will include this header to provide round-trip message * integrity verification of the customer-provided encryption key.</p> */ inline PutObjectResult& WithSSECustomerKeyMD5(const char* value) { SetSSECustomerKeyMD5(value); return *this;} /** * <p>If <code>x-amz-server-side-encryption</code> is present and has the value of * <code>aws:kms</code>, this header specifies the ID of the AWS Key Management * Service (AWS KMS) symmetric customer managed customer master key (CMK) that was * used for the object. </p> */ inline const Aws::String& GetSSEKMSKeyId() const{ return m_sSEKMSKeyId; } /** * <p>If <code>x-amz-server-side-encryption</code> is present and has the value of * <code>aws:kms</code>, this header specifies the ID of the AWS Key Management * Service (AWS KMS) symmetric customer managed customer master key (CMK) that was * used for the object. </p> */ inline void SetSSEKMSKeyId(const Aws::String& value) { m_sSEKMSKeyId = value; } /** * <p>If <code>x-amz-server-side-encryption</code> is present and has the value of * <code>aws:kms</code>, this header specifies the ID of the AWS Key Management * Service (AWS KMS) symmetric customer managed customer master key (CMK) that was * used for the object. </p> */ inline void SetSSEKMSKeyId(Aws::String&& value) { m_sSEKMSKeyId = std::move(value); } /** * <p>If <code>x-amz-server-side-encryption</code> is present and has the value of * <code>aws:kms</code>, this header specifies the ID of the AWS Key Management * Service (AWS KMS) symmetric customer managed customer master key (CMK) that was * used for the object. </p> */ inline void SetSSEKMSKeyId(const char* value) { m_sSEKMSKeyId.assign(value); } /** * <p>If <code>x-amz-server-side-encryption</code> is present and has the value of * <code>aws:kms</code>, this header specifies the ID of the AWS Key Management * Service (AWS KMS) symmetric customer managed customer master key (CMK) that was * used for the object. </p> */ inline PutObjectResult& WithSSEKMSKeyId(const Aws::String& value) { SetSSEKMSKeyId(value); return *this;} /** * <p>If <code>x-amz-server-side-encryption</code> is present and has the value of * <code>aws:kms</code>, this header specifies the ID of the AWS Key Management * Service (AWS KMS) symmetric customer managed customer master key (CMK) that was * used for the object. </p> */ inline PutObjectResult& WithSSEKMSKeyId(Aws::String&& value) { SetSSEKMSKeyId(std::move(value)); return *this;} /** * <p>If <code>x-amz-server-side-encryption</code> is present and has the value of * <code>aws:kms</code>, this header specifies the ID of the AWS Key Management * Service (AWS KMS) symmetric customer managed customer master key (CMK) that was * used for the object. </p> */ inline PutObjectResult& WithSSEKMSKeyId(const char* value) { SetSSEKMSKeyId(value); return *this;} /** * <p>If present, specifies the AWS KMS Encryption Context to use for object * encryption. The value of this header is a base64-encoded UTF-8 string holding * JSON with the encryption context key-value pairs.</p> */ inline const Aws::String& GetSSEKMSEncryptionContext() const{ return m_sSEKMSEncryptionContext; } /** * <p>If present, specifies the AWS KMS Encryption Context to use for object * encryption. The value of this header is a base64-encoded UTF-8 string holding * JSON with the encryption context key-value pairs.</p> */ inline void SetSSEKMSEncryptionContext(const Aws::String& value) { m_sSEKMSEncryptionContext = value; } /** * <p>If present, specifies the AWS KMS Encryption Context to use for object * encryption. The value of this header is a base64-encoded UTF-8 string holding * JSON with the encryption context key-value pairs.</p> */ inline void SetSSEKMSEncryptionContext(Aws::String&& value) { m_sSEKMSEncryptionContext = std::move(value); } /** * <p>If present, specifies the AWS KMS Encryption Context to use for object * encryption. The value of this header is a base64-encoded UTF-8 string holding * JSON with the encryption context key-value pairs.</p> */ inline void SetSSEKMSEncryptionContext(const char* value) { m_sSEKMSEncryptionContext.assign(value); } /** * <p>If present, specifies the AWS KMS Encryption Context to use for object * encryption. The value of this header is a base64-encoded UTF-8 string holding * JSON with the encryption context key-value pairs.</p> */ inline PutObjectResult& WithSSEKMSEncryptionContext(const Aws::String& value) { SetSSEKMSEncryptionContext(value); return *this;} /** * <p>If present, specifies the AWS KMS Encryption Context to use for object * encryption. The value of this header is a base64-encoded UTF-8 string holding * JSON with the encryption context key-value pairs.</p> */ inline PutObjectResult& WithSSEKMSEncryptionContext(Aws::String&& value) { SetSSEKMSEncryptionContext(std::move(value)); return *this;} /** * <p>If present, specifies the AWS KMS Encryption Context to use for object * encryption. The value of this header is a base64-encoded UTF-8 string holding * JSON with the encryption context key-value pairs.</p> */ inline PutObjectResult& WithSSEKMSEncryptionContext(const char* value) { SetSSEKMSEncryptionContext(value); return *this;} /** * <p>Indicates whether the uploaded object uses an S3 Bucket Key for server-side * encryption with AWS KMS (SSE-KMS).</p> */ inline bool GetBucketKeyEnabled() const{ return m_bucketKeyEnabled; } /** * <p>Indicates whether the uploaded object uses an S3 Bucket Key for server-side * encryption with AWS KMS (SSE-KMS).</p> */ inline void SetBucketKeyEnabled(bool value) { m_bucketKeyEnabled = value; } /** * <p>Indicates whether the uploaded object uses an S3 Bucket Key for server-side * encryption with AWS KMS (SSE-KMS).</p> */ inline PutObjectResult& WithBucketKeyEnabled(bool value) { SetBucketKeyEnabled(value); return *this;} inline const RequestCharged& GetRequestCharged() const{ return m_requestCharged; } inline void SetRequestCharged(const RequestCharged& value) { m_requestCharged = value; } inline void SetRequestCharged(RequestCharged&& value) { m_requestCharged = std::move(value); } inline PutObjectResult& WithRequestCharged(const RequestCharged& value) { SetRequestCharged(value); return *this;} inline PutObjectResult& WithRequestCharged(RequestCharged&& value) { SetRequestCharged(std::move(value)); return *this;} private: Aws::String m_expiration; Aws::String m_eTag; ServerSideEncryption m_serverSideEncryption; Aws::String m_versionId; Aws::String m_sSECustomerAlgorithm; Aws::String m_sSECustomerKeyMD5; Aws::String m_sSEKMSKeyId; Aws::String m_sSEKMSEncryptionContext; bool m_bucketKeyEnabled; RequestCharged m_requestCharged; }; } // namespace Model } // namespace S3 } // namespace Aws