/** * 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 #include #include #include #include namespace Aws { template class AmazonWebServiceResult; namespace Utils { namespace Xml { class XmlDocument; } // namespace Xml } // namespace Utils namespace S3 { namespace Model { class AWS_S3_API HeadObjectResult { public: HeadObjectResult(); HeadObjectResult(const Aws::AmazonWebServiceResult& result); HeadObjectResult& operator=(const Aws::AmazonWebServiceResult& result); /** *

Specifies whether the object retrieved was (true) or was not (false) a Delete * Marker. If false, this response header does not appear in the response.

*/ inline bool GetDeleteMarker() const{ return m_deleteMarker; } /** *

Specifies whether the object retrieved was (true) or was not (false) a Delete * Marker. If false, this response header does not appear in the response.

*/ inline void SetDeleteMarker(bool value) { m_deleteMarker = value; } /** *

Specifies whether the object retrieved was (true) or was not (false) a Delete * Marker. If false, this response header does not appear in the response.

*/ inline HeadObjectResult& WithDeleteMarker(bool value) { SetDeleteMarker(value); return *this;} /** *

Indicates that a range of bytes was specified.

*/ inline const Aws::String& GetAcceptRanges() const{ return m_acceptRanges; } /** *

Indicates that a range of bytes was specified.

*/ inline void SetAcceptRanges(const Aws::String& value) { m_acceptRanges = value; } /** *

Indicates that a range of bytes was specified.

*/ inline void SetAcceptRanges(Aws::String&& value) { m_acceptRanges = std::move(value); } /** *

Indicates that a range of bytes was specified.

*/ inline void SetAcceptRanges(const char* value) { m_acceptRanges.assign(value); } /** *

Indicates that a range of bytes was specified.

*/ inline HeadObjectResult& WithAcceptRanges(const Aws::String& value) { SetAcceptRanges(value); return *this;} /** *

Indicates that a range of bytes was specified.

*/ inline HeadObjectResult& WithAcceptRanges(Aws::String&& value) { SetAcceptRanges(std::move(value)); return *this;} /** *

Indicates that a range of bytes was specified.

*/ inline HeadObjectResult& WithAcceptRanges(const char* value) { SetAcceptRanges(value); return *this;} /** *

If the object expiration is configured (see PUT Bucket lifecycle), the * response includes this header. It includes the expiry-date and rule-id key-value * pairs providing object expiration information. The value of the rule-id is URL * encoded.

*/ inline const Aws::String& GetExpiration() const{ return m_expiration; } /** *

If the object expiration is configured (see PUT Bucket lifecycle), the * response includes this header. It includes the expiry-date and rule-id key-value * pairs providing object expiration information. The value of the rule-id is URL * encoded.

*/ inline void SetExpiration(const Aws::String& value) { m_expiration = value; } /** *

If the object expiration is configured (see PUT Bucket lifecycle), the * response includes this header. It includes the expiry-date and rule-id key-value * pairs providing object expiration information. The value of the rule-id is URL * encoded.

*/ inline void SetExpiration(Aws::String&& value) { m_expiration = std::move(value); } /** *

If the object expiration is configured (see PUT Bucket lifecycle), the * response includes this header. It includes the expiry-date and rule-id key-value * pairs providing object expiration information. The value of the rule-id is URL * encoded.

*/ inline void SetExpiration(const char* value) { m_expiration.assign(value); } /** *

If the object expiration is configured (see PUT Bucket lifecycle), the * response includes this header. It includes the expiry-date and rule-id key-value * pairs providing object expiration information. The value of the rule-id is URL * encoded.

*/ inline HeadObjectResult& WithExpiration(const Aws::String& value) { SetExpiration(value); return *this;} /** *

If the object expiration is configured (see PUT Bucket lifecycle), the * response includes this header. It includes the expiry-date and rule-id key-value * pairs providing object expiration information. The value of the rule-id is URL * encoded.

*/ inline HeadObjectResult& WithExpiration(Aws::String&& value) { SetExpiration(std::move(value)); return *this;} /** *

If the object expiration is configured (see PUT Bucket lifecycle), the * response includes this header. It includes the expiry-date and rule-id key-value * pairs providing object expiration information. The value of the rule-id is URL * encoded.

*/ inline HeadObjectResult& WithExpiration(const char* value) { SetExpiration(value); return *this;} /** *

If the object is an archived object (an object whose storage class is * GLACIER), the response includes this header if either the archive restoration is * in progress (see RestoreObject * or an archive copy is already restored.

If an archive copy is already * restored, the header value indicates when Amazon S3 is scheduled to delete the * object copy. For example:

x-amz-restore: ongoing-request="false", * expiry-date="Fri, 21 Dec 2012 00:00:00 GMT"

If the object * restoration is in progress, the header returns the value * ongoing-request="true".

For more information about archiving * objects, see Transitioning * Objects: General Considerations.

*/ inline const Aws::String& GetRestore() const{ return m_restore; } /** *

If the object is an archived object (an object whose storage class is * GLACIER), the response includes this header if either the archive restoration is * in progress (see RestoreObject * or an archive copy is already restored.

If an archive copy is already * restored, the header value indicates when Amazon S3 is scheduled to delete the * object copy. For example:

x-amz-restore: ongoing-request="false", * expiry-date="Fri, 21 Dec 2012 00:00:00 GMT"

If the object * restoration is in progress, the header returns the value * ongoing-request="true".

For more information about archiving * objects, see Transitioning * Objects: General Considerations.

*/ inline void SetRestore(const Aws::String& value) { m_restore = value; } /** *

If the object is an archived object (an object whose storage class is * GLACIER), the response includes this header if either the archive restoration is * in progress (see RestoreObject * or an archive copy is already restored.

If an archive copy is already * restored, the header value indicates when Amazon S3 is scheduled to delete the * object copy. For example:

x-amz-restore: ongoing-request="false", * expiry-date="Fri, 21 Dec 2012 00:00:00 GMT"

If the object * restoration is in progress, the header returns the value * ongoing-request="true".

For more information about archiving * objects, see Transitioning * Objects: General Considerations.

*/ inline void SetRestore(Aws::String&& value) { m_restore = std::move(value); } /** *

If the object is an archived object (an object whose storage class is * GLACIER), the response includes this header if either the archive restoration is * in progress (see RestoreObject * or an archive copy is already restored.

If an archive copy is already * restored, the header value indicates when Amazon S3 is scheduled to delete the * object copy. For example:

x-amz-restore: ongoing-request="false", * expiry-date="Fri, 21 Dec 2012 00:00:00 GMT"

If the object * restoration is in progress, the header returns the value * ongoing-request="true".

For more information about archiving * objects, see Transitioning * Objects: General Considerations.

*/ inline void SetRestore(const char* value) { m_restore.assign(value); } /** *

If the object is an archived object (an object whose storage class is * GLACIER), the response includes this header if either the archive restoration is * in progress (see RestoreObject * or an archive copy is already restored.

If an archive copy is already * restored, the header value indicates when Amazon S3 is scheduled to delete the * object copy. For example:

x-amz-restore: ongoing-request="false", * expiry-date="Fri, 21 Dec 2012 00:00:00 GMT"

If the object * restoration is in progress, the header returns the value * ongoing-request="true".

For more information about archiving * objects, see Transitioning * Objects: General Considerations.

*/ inline HeadObjectResult& WithRestore(const Aws::String& value) { SetRestore(value); return *this;} /** *

If the object is an archived object (an object whose storage class is * GLACIER), the response includes this header if either the archive restoration is * in progress (see RestoreObject * or an archive copy is already restored.

If an archive copy is already * restored, the header value indicates when Amazon S3 is scheduled to delete the * object copy. For example:

x-amz-restore: ongoing-request="false", * expiry-date="Fri, 21 Dec 2012 00:00:00 GMT"

If the object * restoration is in progress, the header returns the value * ongoing-request="true".

For more information about archiving * objects, see Transitioning * Objects: General Considerations.

*/ inline HeadObjectResult& WithRestore(Aws::String&& value) { SetRestore(std::move(value)); return *this;} /** *

If the object is an archived object (an object whose storage class is * GLACIER), the response includes this header if either the archive restoration is * in progress (see RestoreObject * or an archive copy is already restored.

If an archive copy is already * restored, the header value indicates when Amazon S3 is scheduled to delete the * object copy. For example:

x-amz-restore: ongoing-request="false", * expiry-date="Fri, 21 Dec 2012 00:00:00 GMT"

If the object * restoration is in progress, the header returns the value * ongoing-request="true".

For more information about archiving * objects, see Transitioning * Objects: General Considerations.

*/ inline HeadObjectResult& WithRestore(const char* value) { SetRestore(value); return *this;} /** *

The archive state of the head object.

*/ inline const ArchiveStatus& GetArchiveStatus() const{ return m_archiveStatus; } /** *

The archive state of the head object.

*/ inline void SetArchiveStatus(const ArchiveStatus& value) { m_archiveStatus = value; } /** *

The archive state of the head object.

*/ inline void SetArchiveStatus(ArchiveStatus&& value) { m_archiveStatus = std::move(value); } /** *

The archive state of the head object.

*/ inline HeadObjectResult& WithArchiveStatus(const ArchiveStatus& value) { SetArchiveStatus(value); return *this;} /** *

The archive state of the head object.

*/ inline HeadObjectResult& WithArchiveStatus(ArchiveStatus&& value) { SetArchiveStatus(std::move(value)); return *this;} /** *

Creation date of the object.

*/ inline const Aws::Utils::DateTime& GetLastModified() const{ return m_lastModified; } /** *

Creation date of the object.

*/ inline void SetLastModified(const Aws::Utils::DateTime& value) { m_lastModified = value; } /** *

Creation date of the object.

*/ inline void SetLastModified(Aws::Utils::DateTime&& value) { m_lastModified = std::move(value); } /** *

Creation date of the object.

*/ inline HeadObjectResult& WithLastModified(const Aws::Utils::DateTime& value) { SetLastModified(value); return *this;} /** *

Creation date of the object.

*/ inline HeadObjectResult& WithLastModified(Aws::Utils::DateTime&& value) { SetLastModified(std::move(value)); return *this;} /** *

Size of the body in bytes.

*/ inline long long GetContentLength() const{ return m_contentLength; } /** *

Size of the body in bytes.

*/ inline void SetContentLength(long long value) { m_contentLength = value; } /** *

Size of the body in bytes.

*/ inline HeadObjectResult& WithContentLength(long long value) { SetContentLength(value); return *this;} /** *

An ETag is an opaque identifier assigned by a web server to a specific * version of a resource found at a URL.

*/ inline const Aws::String& GetETag() const{ return m_eTag; } /** *

An ETag is an opaque identifier assigned by a web server to a specific * version of a resource found at a URL.

*/ inline void SetETag(const Aws::String& value) { m_eTag = value; } /** *

An ETag is an opaque identifier assigned by a web server to a specific * version of a resource found at a URL.

*/ inline void SetETag(Aws::String&& value) { m_eTag = std::move(value); } /** *

An ETag is an opaque identifier assigned by a web server to a specific * version of a resource found at a URL.

*/ inline void SetETag(const char* value) { m_eTag.assign(value); } /** *

An ETag is an opaque identifier assigned by a web server to a specific * version of a resource found at a URL.

*/ inline HeadObjectResult& WithETag(const Aws::String& value) { SetETag(value); return *this;} /** *

An ETag is an opaque identifier assigned by a web server to a specific * version of a resource found at a URL.

*/ inline HeadObjectResult& WithETag(Aws::String&& value) { SetETag(std::move(value)); return *this;} /** *

An ETag is an opaque identifier assigned by a web server to a specific * version of a resource found at a URL.

*/ inline HeadObjectResult& WithETag(const char* value) { SetETag(value); return *this;} /** *

This is set to the number of metadata entries not returned in * x-amz-meta headers. This can happen if you create metadata using an * API like SOAP that supports more flexible metadata than the REST API. For * example, using SOAP, you can create metadata whose values are not legal HTTP * headers.

*/ inline int GetMissingMeta() const{ return m_missingMeta; } /** *

This is set to the number of metadata entries not returned in * x-amz-meta headers. This can happen if you create metadata using an * API like SOAP that supports more flexible metadata than the REST API. For * example, using SOAP, you can create metadata whose values are not legal HTTP * headers.

*/ inline void SetMissingMeta(int value) { m_missingMeta = value; } /** *

This is set to the number of metadata entries not returned in * x-amz-meta headers. This can happen if you create metadata using an * API like SOAP that supports more flexible metadata than the REST API. For * example, using SOAP, you can create metadata whose values are not legal HTTP * headers.

*/ inline HeadObjectResult& WithMissingMeta(int value) { SetMissingMeta(value); return *this;} /** *

Version of the object.

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

Version of the object.

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

Version of the object.

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

Version of the object.

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

Version of the object.

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

Version of the object.

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

Version of the object.

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

Specifies caching behavior along the request/reply chain.

*/ inline const Aws::String& GetCacheControl() const{ return m_cacheControl; } /** *

Specifies caching behavior along the request/reply chain.

*/ inline void SetCacheControl(const Aws::String& value) { m_cacheControl = value; } /** *

Specifies caching behavior along the request/reply chain.

*/ inline void SetCacheControl(Aws::String&& value) { m_cacheControl = std::move(value); } /** *

Specifies caching behavior along the request/reply chain.

*/ inline void SetCacheControl(const char* value) { m_cacheControl.assign(value); } /** *

Specifies caching behavior along the request/reply chain.

*/ inline HeadObjectResult& WithCacheControl(const Aws::String& value) { SetCacheControl(value); return *this;} /** *

Specifies caching behavior along the request/reply chain.

*/ inline HeadObjectResult& WithCacheControl(Aws::String&& value) { SetCacheControl(std::move(value)); return *this;} /** *

Specifies caching behavior along the request/reply chain.

*/ inline HeadObjectResult& WithCacheControl(const char* value) { SetCacheControl(value); return *this;} /** *

Specifies presentational information for the object.

*/ inline const Aws::String& GetContentDisposition() const{ return m_contentDisposition; } /** *

Specifies presentational information for the object.

*/ inline void SetContentDisposition(const Aws::String& value) { m_contentDisposition = value; } /** *

Specifies presentational information for the object.

*/ inline void SetContentDisposition(Aws::String&& value) { m_contentDisposition = std::move(value); } /** *

Specifies presentational information for the object.

*/ inline void SetContentDisposition(const char* value) { m_contentDisposition.assign(value); } /** *

Specifies presentational information for the object.

*/ inline HeadObjectResult& WithContentDisposition(const Aws::String& value) { SetContentDisposition(value); return *this;} /** *

Specifies presentational information for the object.

*/ inline HeadObjectResult& WithContentDisposition(Aws::String&& value) { SetContentDisposition(std::move(value)); return *this;} /** *

Specifies presentational information for the object.

*/ inline HeadObjectResult& WithContentDisposition(const char* value) { SetContentDisposition(value); return *this;} /** *

Specifies what content encodings have been applied to the object and thus * what decoding mechanisms must be applied to obtain the media-type referenced by * the Content-Type header field.

*/ inline const Aws::String& GetContentEncoding() const{ return m_contentEncoding; } /** *

Specifies what content encodings have been applied to the object and thus * what decoding mechanisms must be applied to obtain the media-type referenced by * the Content-Type header field.

*/ inline void SetContentEncoding(const Aws::String& value) { m_contentEncoding = value; } /** *

Specifies what content encodings have been applied to the object and thus * what decoding mechanisms must be applied to obtain the media-type referenced by * the Content-Type header field.

*/ inline void SetContentEncoding(Aws::String&& value) { m_contentEncoding = std::move(value); } /** *

Specifies what content encodings have been applied to the object and thus * what decoding mechanisms must be applied to obtain the media-type referenced by * the Content-Type header field.

*/ inline void SetContentEncoding(const char* value) { m_contentEncoding.assign(value); } /** *

Specifies what content encodings have been applied to the object and thus * what decoding mechanisms must be applied to obtain the media-type referenced by * the Content-Type header field.

*/ inline HeadObjectResult& WithContentEncoding(const Aws::String& value) { SetContentEncoding(value); return *this;} /** *

Specifies what content encodings have been applied to the object and thus * what decoding mechanisms must be applied to obtain the media-type referenced by * the Content-Type header field.

*/ inline HeadObjectResult& WithContentEncoding(Aws::String&& value) { SetContentEncoding(std::move(value)); return *this;} /** *

Specifies what content encodings have been applied to the object and thus * what decoding mechanisms must be applied to obtain the media-type referenced by * the Content-Type header field.

*/ inline HeadObjectResult& WithContentEncoding(const char* value) { SetContentEncoding(value); return *this;} /** *

The language the content is in.

*/ inline const Aws::String& GetContentLanguage() const{ return m_contentLanguage; } /** *

The language the content is in.

*/ inline void SetContentLanguage(const Aws::String& value) { m_contentLanguage = value; } /** *

The language the content is in.

*/ inline void SetContentLanguage(Aws::String&& value) { m_contentLanguage = std::move(value); } /** *

The language the content is in.

*/ inline void SetContentLanguage(const char* value) { m_contentLanguage.assign(value); } /** *

The language the content is in.

*/ inline HeadObjectResult& WithContentLanguage(const Aws::String& value) { SetContentLanguage(value); return *this;} /** *

The language the content is in.

*/ inline HeadObjectResult& WithContentLanguage(Aws::String&& value) { SetContentLanguage(std::move(value)); return *this;} /** *

The language the content is in.

*/ inline HeadObjectResult& WithContentLanguage(const char* value) { SetContentLanguage(value); return *this;} /** *

A standard MIME type describing the format of the object data.

*/ inline const Aws::String& GetContentType() const{ return m_contentType; } /** *

A standard MIME type describing the format of the object data.

*/ inline void SetContentType(const Aws::String& value) { m_contentType = value; } /** *

A standard MIME type describing the format of the object data.

*/ inline void SetContentType(Aws::String&& value) { m_contentType = std::move(value); } /** *

A standard MIME type describing the format of the object data.

*/ inline void SetContentType(const char* value) { m_contentType.assign(value); } /** *

A standard MIME type describing the format of the object data.

*/ inline HeadObjectResult& WithContentType(const Aws::String& value) { SetContentType(value); return *this;} /** *

A standard MIME type describing the format of the object data.

*/ inline HeadObjectResult& WithContentType(Aws::String&& value) { SetContentType(std::move(value)); return *this;} /** *

A standard MIME type describing the format of the object data.

*/ inline HeadObjectResult& WithContentType(const char* value) { SetContentType(value); return *this;} /** *

The date and time at which the object is no longer cacheable.

*/ inline const Aws::Utils::DateTime& GetExpires() const{ return m_expires; } /** *

The date and time at which the object is no longer cacheable.

*/ inline void SetExpires(const Aws::Utils::DateTime& value) { m_expires = value; } /** *

The date and time at which the object is no longer cacheable.

*/ inline void SetExpires(Aws::Utils::DateTime&& value) { m_expires = std::move(value); } /** *

The date and time at which the object is no longer cacheable.

*/ inline HeadObjectResult& WithExpires(const Aws::Utils::DateTime& value) { SetExpires(value); return *this;} /** *

The date and time at which the object is no longer cacheable.

*/ inline HeadObjectResult& WithExpires(Aws::Utils::DateTime&& value) { SetExpires(std::move(value)); return *this;} /** *

If the bucket is configured as a website, redirects requests for this object * to another object in the same bucket or to an external URL. Amazon S3 stores the * value of this header in the object metadata.

*/ inline const Aws::String& GetWebsiteRedirectLocation() const{ return m_websiteRedirectLocation; } /** *

If the bucket is configured as a website, redirects requests for this object * to another object in the same bucket or to an external URL. Amazon S3 stores the * value of this header in the object metadata.

*/ inline void SetWebsiteRedirectLocation(const Aws::String& value) { m_websiteRedirectLocation = value; } /** *

If the bucket is configured as a website, redirects requests for this object * to another object in the same bucket or to an external URL. Amazon S3 stores the * value of this header in the object metadata.

*/ inline void SetWebsiteRedirectLocation(Aws::String&& value) { m_websiteRedirectLocation = std::move(value); } /** *

If the bucket is configured as a website, redirects requests for this object * to another object in the same bucket or to an external URL. Amazon S3 stores the * value of this header in the object metadata.

*/ inline void SetWebsiteRedirectLocation(const char* value) { m_websiteRedirectLocation.assign(value); } /** *

If the bucket is configured as a website, redirects requests for this object * to another object in the same bucket or to an external URL. Amazon S3 stores the * value of this header in the object metadata.

*/ inline HeadObjectResult& WithWebsiteRedirectLocation(const Aws::String& value) { SetWebsiteRedirectLocation(value); return *this;} /** *

If the bucket is configured as a website, redirects requests for this object * to another object in the same bucket or to an external URL. Amazon S3 stores the * value of this header in the object metadata.

*/ inline HeadObjectResult& WithWebsiteRedirectLocation(Aws::String&& value) { SetWebsiteRedirectLocation(std::move(value)); return *this;} /** *

If the bucket is configured as a website, redirects requests for this object * to another object in the same bucket or to an external URL. Amazon S3 stores the * value of this header in the object metadata.

*/ inline HeadObjectResult& WithWebsiteRedirectLocation(const char* value) { SetWebsiteRedirectLocation(value); return *this;} /** *

If the object is stored using server-side encryption either with an Amazon * Web Services KMS key or an Amazon S3-managed encryption key, the response * includes this header with the value of the server-side encryption algorithm used * when storing this object in Amazon S3 (for example, AES256, aws:kms).

*/ inline const ServerSideEncryption& GetServerSideEncryption() const{ return m_serverSideEncryption; } /** *

If the object is stored using server-side encryption either with an Amazon * Web Services KMS key or an Amazon S3-managed encryption key, the response * includes this header with the value of the server-side encryption algorithm used * when storing this object in Amazon S3 (for example, AES256, aws:kms).

*/ inline void SetServerSideEncryption(const ServerSideEncryption& value) { m_serverSideEncryption = value; } /** *

If the object is stored using server-side encryption either with an Amazon * Web Services KMS key or an Amazon S3-managed encryption key, the response * includes this header with the value of the server-side encryption algorithm used * when storing this object in Amazon S3 (for example, AES256, aws:kms).

*/ inline void SetServerSideEncryption(ServerSideEncryption&& value) { m_serverSideEncryption = std::move(value); } /** *

If the object is stored using server-side encryption either with an Amazon * Web Services KMS key or an Amazon S3-managed encryption key, the response * includes this header with the value of the server-side encryption algorithm used * when storing this object in Amazon S3 (for example, AES256, aws:kms).

*/ inline HeadObjectResult& WithServerSideEncryption(const ServerSideEncryption& value) { SetServerSideEncryption(value); return *this;} /** *

If the object is stored using server-side encryption either with an Amazon * Web Services KMS key or an Amazon S3-managed encryption key, the response * includes this header with the value of the server-side encryption algorithm used * when storing this object in Amazon S3 (for example, AES256, aws:kms).

*/ inline HeadObjectResult& WithServerSideEncryption(ServerSideEncryption&& value) { SetServerSideEncryption(std::move(value)); return *this;} /** *

A map of metadata to store with the object in S3.

*/ inline const Aws::Map& GetMetadata() const{ return m_metadata; } /** *

A map of metadata to store with the object in S3.

*/ inline void SetMetadata(const Aws::Map& value) { m_metadata = value; } /** *

A map of metadata to store with the object in S3.

*/ inline void SetMetadata(Aws::Map&& value) { m_metadata = std::move(value); } /** *

A map of metadata to store with the object in S3.

*/ inline HeadObjectResult& WithMetadata(const Aws::Map& value) { SetMetadata(value); return *this;} /** *

A map of metadata to store with the object in S3.

*/ inline HeadObjectResult& WithMetadata(Aws::Map&& value) { SetMetadata(std::move(value)); return *this;} /** *

A map of metadata to store with the object in S3.

*/ inline HeadObjectResult& AddMetadata(const Aws::String& key, const Aws::String& value) { m_metadata.emplace(key, value); return *this; } /** *

A map of metadata to store with the object in S3.

*/ inline HeadObjectResult& AddMetadata(Aws::String&& key, const Aws::String& value) { m_metadata.emplace(std::move(key), value); return *this; } /** *

A map of metadata to store with the object in S3.

*/ inline HeadObjectResult& AddMetadata(const Aws::String& key, Aws::String&& value) { m_metadata.emplace(key, std::move(value)); return *this; } /** *

A map of metadata to store with the object in S3.

*/ inline HeadObjectResult& AddMetadata(Aws::String&& key, Aws::String&& value) { m_metadata.emplace(std::move(key), std::move(value)); return *this; } /** *

A map of metadata to store with the object in S3.

*/ inline HeadObjectResult& AddMetadata(const char* key, Aws::String&& value) { m_metadata.emplace(key, std::move(value)); return *this; } /** *

A map of metadata to store with the object in S3.

*/ inline HeadObjectResult& AddMetadata(Aws::String&& key, const char* value) { m_metadata.emplace(std::move(key), value); return *this; } /** *

A map of metadata to store with the object in S3.

*/ inline HeadObjectResult& AddMetadata(const char* key, const char* value) { m_metadata.emplace(key, value); return *this; } /** *

If server-side encryption with a customer-provided encryption key was * requested, the response will include this header confirming the encryption * algorithm used.

*/ inline const Aws::String& GetSSECustomerAlgorithm() const{ return m_sSECustomerAlgorithm; } /** *

If server-side encryption with a customer-provided encryption key was * requested, the response will include this header confirming the encryption * algorithm used.

*/ inline void SetSSECustomerAlgorithm(const Aws::String& value) { m_sSECustomerAlgorithm = value; } /** *

If server-side encryption with a customer-provided encryption key was * requested, the response will include this header confirming the encryption * algorithm used.

*/ inline void SetSSECustomerAlgorithm(Aws::String&& value) { m_sSECustomerAlgorithm = std::move(value); } /** *

If server-side encryption with a customer-provided encryption key was * requested, the response will include this header confirming the encryption * algorithm used.

*/ inline void SetSSECustomerAlgorithm(const char* value) { m_sSECustomerAlgorithm.assign(value); } /** *

If server-side encryption with a customer-provided encryption key was * requested, the response will include this header confirming the encryption * algorithm used.

*/ inline HeadObjectResult& WithSSECustomerAlgorithm(const Aws::String& value) { SetSSECustomerAlgorithm(value); return *this;} /** *

If server-side encryption with a customer-provided encryption key was * requested, the response will include this header confirming the encryption * algorithm used.

*/ inline HeadObjectResult& WithSSECustomerAlgorithm(Aws::String&& value) { SetSSECustomerAlgorithm(std::move(value)); return *this;} /** *

If server-side encryption with a customer-provided encryption key was * requested, the response will include this header confirming the encryption * algorithm used.

*/ inline HeadObjectResult& WithSSECustomerAlgorithm(const char* value) { SetSSECustomerAlgorithm(value); return *this;} /** *

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.

*/ inline const Aws::String& GetSSECustomerKeyMD5() const{ return m_sSECustomerKeyMD5; } /** *

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.

*/ inline void SetSSECustomerKeyMD5(const Aws::String& value) { m_sSECustomerKeyMD5 = value; } /** *

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.

*/ inline void SetSSECustomerKeyMD5(Aws::String&& value) { m_sSECustomerKeyMD5 = std::move(value); } /** *

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.

*/ inline void SetSSECustomerKeyMD5(const char* value) { m_sSECustomerKeyMD5.assign(value); } /** *

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.

*/ inline HeadObjectResult& WithSSECustomerKeyMD5(const Aws::String& value) { SetSSECustomerKeyMD5(value); return *this;} /** *

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.

*/ inline HeadObjectResult& WithSSECustomerKeyMD5(Aws::String&& value) { SetSSECustomerKeyMD5(std::move(value)); return *this;} /** *

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.

*/ inline HeadObjectResult& WithSSECustomerKeyMD5(const char* value) { SetSSECustomerKeyMD5(value); return *this;} /** *

If present, specifies the ID of the Amazon Web Services Key Management * Service (Amazon Web Services KMS) symmetric customer managed key that was used * for the object.

*/ inline const Aws::String& GetSSEKMSKeyId() const{ return m_sSEKMSKeyId; } /** *

If present, specifies the ID of the Amazon Web Services Key Management * Service (Amazon Web Services KMS) symmetric customer managed key that was used * for the object.

*/ inline void SetSSEKMSKeyId(const Aws::String& value) { m_sSEKMSKeyId = value; } /** *

If present, specifies the ID of the Amazon Web Services Key Management * Service (Amazon Web Services KMS) symmetric customer managed key that was used * for the object.

*/ inline void SetSSEKMSKeyId(Aws::String&& value) { m_sSEKMSKeyId = std::move(value); } /** *

If present, specifies the ID of the Amazon Web Services Key Management * Service (Amazon Web Services KMS) symmetric customer managed key that was used * for the object.

*/ inline void SetSSEKMSKeyId(const char* value) { m_sSEKMSKeyId.assign(value); } /** *

If present, specifies the ID of the Amazon Web Services Key Management * Service (Amazon Web Services KMS) symmetric customer managed key that was used * for the object.

*/ inline HeadObjectResult& WithSSEKMSKeyId(const Aws::String& value) { SetSSEKMSKeyId(value); return *this;} /** *

If present, specifies the ID of the Amazon Web Services Key Management * Service (Amazon Web Services KMS) symmetric customer managed key that was used * for the object.

*/ inline HeadObjectResult& WithSSEKMSKeyId(Aws::String&& value) { SetSSEKMSKeyId(std::move(value)); return *this;} /** *

If present, specifies the ID of the Amazon Web Services Key Management * Service (Amazon Web Services KMS) symmetric customer managed key that was used * for the object.

*/ inline HeadObjectResult& WithSSEKMSKeyId(const char* value) { SetSSEKMSKeyId(value); return *this;} /** *

Indicates whether the object uses an S3 Bucket Key for server-side encryption * with Amazon Web Services KMS (SSE-KMS).

*/ inline bool GetBucketKeyEnabled() const{ return m_bucketKeyEnabled; } /** *

Indicates whether the object uses an S3 Bucket Key for server-side encryption * with Amazon Web Services KMS (SSE-KMS).

*/ inline void SetBucketKeyEnabled(bool value) { m_bucketKeyEnabled = value; } /** *

Indicates whether the object uses an S3 Bucket Key for server-side encryption * with Amazon Web Services KMS (SSE-KMS).

*/ inline HeadObjectResult& WithBucketKeyEnabled(bool value) { SetBucketKeyEnabled(value); return *this;} /** *

Provides storage class information of the object. Amazon S3 returns this * header for all objects except for S3 Standard storage class objects.

For * more information, see Storage * Classes.

*/ inline const StorageClass& GetStorageClass() const{ return m_storageClass; } /** *

Provides storage class information of the object. Amazon S3 returns this * header for all objects except for S3 Standard storage class objects.

For * more information, see Storage * Classes.

*/ inline void SetStorageClass(const StorageClass& value) { m_storageClass = value; } /** *

Provides storage class information of the object. Amazon S3 returns this * header for all objects except for S3 Standard storage class objects.

For * more information, see Storage * Classes.

*/ inline void SetStorageClass(StorageClass&& value) { m_storageClass = std::move(value); } /** *

Provides storage class information of the object. Amazon S3 returns this * header for all objects except for S3 Standard storage class objects.

For * more information, see Storage * Classes.

*/ inline HeadObjectResult& WithStorageClass(const StorageClass& value) { SetStorageClass(value); return *this;} /** *

Provides storage class information of the object. Amazon S3 returns this * header for all objects except for S3 Standard storage class objects.

For * more information, see Storage * Classes.

*/ inline HeadObjectResult& WithStorageClass(StorageClass&& value) { SetStorageClass(std::move(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 HeadObjectResult& WithRequestCharged(const RequestCharged& value) { SetRequestCharged(value); return *this;} inline HeadObjectResult& WithRequestCharged(RequestCharged&& value) { SetRequestCharged(std::move(value)); return *this;} /** *

Amazon S3 can return this header if your request involves a bucket that is * either a source or a destination in a replication rule.

In replication, * you have a source bucket on which you configure replication and destination * bucket or buckets where Amazon S3 stores object replicas. When you request an * object (GetObject) or object metadata (HeadObject) * from these buckets, Amazon S3 will return the * x-amz-replication-status header in the response as follows:

*
  • If requesting an object from the source bucket — Amazon S3 will * return the x-amz-replication-status header if the object in your * request is eligible for replication.

    For example, suppose that in your * replication configuration, you specify object prefix TaxDocs * requesting Amazon S3 to replicate objects with key prefix TaxDocs. * Any objects you upload with this key name prefix, for example * TaxDocs/document1.pdf, are eligible for replication. For any object * request with this key name prefix, Amazon S3 will return the * x-amz-replication-status header with value PENDING, COMPLETED or * FAILED indicating object replication status.

  • If requesting an * object from a destination bucket — Amazon S3 will return the * x-amz-replication-status header with value REPLICA if the object in * your request is a replica that Amazon S3 created and there is no replica * modification replication in progress.

  • When replicating objects * to multiple destination buckets the x-amz-replication-status header * acts differently. The header of the source object will only return a value of * COMPLETED when replication is successful to all destinations. The header will * remain at value PENDING until replication has completed for all destinations. If * one or more destinations fails replication the header will return FAILED.

    *

For more information, see Replication.

*/ inline const ReplicationStatus& GetReplicationStatus() const{ return m_replicationStatus; } /** *

Amazon S3 can return this header if your request involves a bucket that is * either a source or a destination in a replication rule.

In replication, * you have a source bucket on which you configure replication and destination * bucket or buckets where Amazon S3 stores object replicas. When you request an * object (GetObject) or object metadata (HeadObject) * from these buckets, Amazon S3 will return the * x-amz-replication-status header in the response as follows:

*
  • If requesting an object from the source bucket — Amazon S3 will * return the x-amz-replication-status header if the object in your * request is eligible for replication.

    For example, suppose that in your * replication configuration, you specify object prefix TaxDocs * requesting Amazon S3 to replicate objects with key prefix TaxDocs. * Any objects you upload with this key name prefix, for example * TaxDocs/document1.pdf, are eligible for replication. For any object * request with this key name prefix, Amazon S3 will return the * x-amz-replication-status header with value PENDING, COMPLETED or * FAILED indicating object replication status.

  • If requesting an * object from a destination bucket — Amazon S3 will return the * x-amz-replication-status header with value REPLICA if the object in * your request is a replica that Amazon S3 created and there is no replica * modification replication in progress.

  • When replicating objects * to multiple destination buckets the x-amz-replication-status header * acts differently. The header of the source object will only return a value of * COMPLETED when replication is successful to all destinations. The header will * remain at value PENDING until replication has completed for all destinations. If * one or more destinations fails replication the header will return FAILED.

    *

For more information, see Replication.

*/ inline void SetReplicationStatus(const ReplicationStatus& value) { m_replicationStatus = value; } /** *

Amazon S3 can return this header if your request involves a bucket that is * either a source or a destination in a replication rule.

In replication, * you have a source bucket on which you configure replication and destination * bucket or buckets where Amazon S3 stores object replicas. When you request an * object (GetObject) or object metadata (HeadObject) * from these buckets, Amazon S3 will return the * x-amz-replication-status header in the response as follows:

*
  • If requesting an object from the source bucket — Amazon S3 will * return the x-amz-replication-status header if the object in your * request is eligible for replication.

    For example, suppose that in your * replication configuration, you specify object prefix TaxDocs * requesting Amazon S3 to replicate objects with key prefix TaxDocs. * Any objects you upload with this key name prefix, for example * TaxDocs/document1.pdf, are eligible for replication. For any object * request with this key name prefix, Amazon S3 will return the * x-amz-replication-status header with value PENDING, COMPLETED or * FAILED indicating object replication status.

  • If requesting an * object from a destination bucket — Amazon S3 will return the * x-amz-replication-status header with value REPLICA if the object in * your request is a replica that Amazon S3 created and there is no replica * modification replication in progress.

  • When replicating objects * to multiple destination buckets the x-amz-replication-status header * acts differently. The header of the source object will only return a value of * COMPLETED when replication is successful to all destinations. The header will * remain at value PENDING until replication has completed for all destinations. If * one or more destinations fails replication the header will return FAILED.

    *

For more information, see Replication.

*/ inline void SetReplicationStatus(ReplicationStatus&& value) { m_replicationStatus = std::move(value); } /** *

Amazon S3 can return this header if your request involves a bucket that is * either a source or a destination in a replication rule.

In replication, * you have a source bucket on which you configure replication and destination * bucket or buckets where Amazon S3 stores object replicas. When you request an * object (GetObject) or object metadata (HeadObject) * from these buckets, Amazon S3 will return the * x-amz-replication-status header in the response as follows:

*
  • If requesting an object from the source bucket — Amazon S3 will * return the x-amz-replication-status header if the object in your * request is eligible for replication.

    For example, suppose that in your * replication configuration, you specify object prefix TaxDocs * requesting Amazon S3 to replicate objects with key prefix TaxDocs. * Any objects you upload with this key name prefix, for example * TaxDocs/document1.pdf, are eligible for replication. For any object * request with this key name prefix, Amazon S3 will return the * x-amz-replication-status header with value PENDING, COMPLETED or * FAILED indicating object replication status.

  • If requesting an * object from a destination bucket — Amazon S3 will return the * x-amz-replication-status header with value REPLICA if the object in * your request is a replica that Amazon S3 created and there is no replica * modification replication in progress.

  • When replicating objects * to multiple destination buckets the x-amz-replication-status header * acts differently. The header of the source object will only return a value of * COMPLETED when replication is successful to all destinations. The header will * remain at value PENDING until replication has completed for all destinations. If * one or more destinations fails replication the header will return FAILED.

    *

For more information, see Replication.

*/ inline HeadObjectResult& WithReplicationStatus(const ReplicationStatus& value) { SetReplicationStatus(value); return *this;} /** *

Amazon S3 can return this header if your request involves a bucket that is * either a source or a destination in a replication rule.

In replication, * you have a source bucket on which you configure replication and destination * bucket or buckets where Amazon S3 stores object replicas. When you request an * object (GetObject) or object metadata (HeadObject) * from these buckets, Amazon S3 will return the * x-amz-replication-status header in the response as follows:

*
  • If requesting an object from the source bucket — Amazon S3 will * return the x-amz-replication-status header if the object in your * request is eligible for replication.

    For example, suppose that in your * replication configuration, you specify object prefix TaxDocs * requesting Amazon S3 to replicate objects with key prefix TaxDocs. * Any objects you upload with this key name prefix, for example * TaxDocs/document1.pdf, are eligible for replication. For any object * request with this key name prefix, Amazon S3 will return the * x-amz-replication-status header with value PENDING, COMPLETED or * FAILED indicating object replication status.

  • If requesting an * object from a destination bucket — Amazon S3 will return the * x-amz-replication-status header with value REPLICA if the object in * your request is a replica that Amazon S3 created and there is no replica * modification replication in progress.

  • When replicating objects * to multiple destination buckets the x-amz-replication-status header * acts differently. The header of the source object will only return a value of * COMPLETED when replication is successful to all destinations. The header will * remain at value PENDING until replication has completed for all destinations. If * one or more destinations fails replication the header will return FAILED.

    *

For more information, see Replication.

*/ inline HeadObjectResult& WithReplicationStatus(ReplicationStatus&& value) { SetReplicationStatus(std::move(value)); return *this;} /** *

The count of parts this object has.

*/ inline int GetPartsCount() const{ return m_partsCount; } /** *

The count of parts this object has.

*/ inline void SetPartsCount(int value) { m_partsCount = value; } /** *

The count of parts this object has.

*/ inline HeadObjectResult& WithPartsCount(int value) { SetPartsCount(value); return *this;} /** *

The Object Lock mode, if any, that's in effect for this object. This header * is only returned if the requester has the s3:GetObjectRetention * permission. For more information about S3 Object Lock, see Object * Lock.

*/ inline const ObjectLockMode& GetObjectLockMode() const{ return m_objectLockMode; } /** *

The Object Lock mode, if any, that's in effect for this object. This header * is only returned if the requester has the s3:GetObjectRetention * permission. For more information about S3 Object Lock, see Object * Lock.

*/ inline void SetObjectLockMode(const ObjectLockMode& value) { m_objectLockMode = value; } /** *

The Object Lock mode, if any, that's in effect for this object. This header * is only returned if the requester has the s3:GetObjectRetention * permission. For more information about S3 Object Lock, see Object * Lock.

*/ inline void SetObjectLockMode(ObjectLockMode&& value) { m_objectLockMode = std::move(value); } /** *

The Object Lock mode, if any, that's in effect for this object. This header * is only returned if the requester has the s3:GetObjectRetention * permission. For more information about S3 Object Lock, see Object * Lock.

*/ inline HeadObjectResult& WithObjectLockMode(const ObjectLockMode& value) { SetObjectLockMode(value); return *this;} /** *

The Object Lock mode, if any, that's in effect for this object. This header * is only returned if the requester has the s3:GetObjectRetention * permission. For more information about S3 Object Lock, see Object * Lock.

*/ inline HeadObjectResult& WithObjectLockMode(ObjectLockMode&& value) { SetObjectLockMode(std::move(value)); return *this;} /** *

The date and time when the Object Lock retention period expires. This header * is only returned if the requester has the s3:GetObjectRetention * permission.

*/ inline const Aws::Utils::DateTime& GetObjectLockRetainUntilDate() const{ return m_objectLockRetainUntilDate; } /** *

The date and time when the Object Lock retention period expires. This header * is only returned if the requester has the s3:GetObjectRetention * permission.

*/ inline void SetObjectLockRetainUntilDate(const Aws::Utils::DateTime& value) { m_objectLockRetainUntilDate = value; } /** *

The date and time when the Object Lock retention period expires. This header * is only returned if the requester has the s3:GetObjectRetention * permission.

*/ inline void SetObjectLockRetainUntilDate(Aws::Utils::DateTime&& value) { m_objectLockRetainUntilDate = std::move(value); } /** *

The date and time when the Object Lock retention period expires. This header * is only returned if the requester has the s3:GetObjectRetention * permission.

*/ inline HeadObjectResult& WithObjectLockRetainUntilDate(const Aws::Utils::DateTime& value) { SetObjectLockRetainUntilDate(value); return *this;} /** *

The date and time when the Object Lock retention period expires. This header * is only returned if the requester has the s3:GetObjectRetention * permission.

*/ inline HeadObjectResult& WithObjectLockRetainUntilDate(Aws::Utils::DateTime&& value) { SetObjectLockRetainUntilDate(std::move(value)); return *this;} /** *

Specifies whether a legal hold is in effect for this object. This header is * only returned if the requester has the s3:GetObjectLegalHold * permission. This header is not returned if the specified version of this object * has never had a legal hold applied. For more information about S3 Object Lock, * see Object * Lock.

*/ inline const ObjectLockLegalHoldStatus& GetObjectLockLegalHoldStatus() const{ return m_objectLockLegalHoldStatus; } /** *

Specifies whether a legal hold is in effect for this object. This header is * only returned if the requester has the s3:GetObjectLegalHold * permission. This header is not returned if the specified version of this object * has never had a legal hold applied. For more information about S3 Object Lock, * see Object * Lock.

*/ inline void SetObjectLockLegalHoldStatus(const ObjectLockLegalHoldStatus& value) { m_objectLockLegalHoldStatus = value; } /** *

Specifies whether a legal hold is in effect for this object. This header is * only returned if the requester has the s3:GetObjectLegalHold * permission. This header is not returned if the specified version of this object * has never had a legal hold applied. For more information about S3 Object Lock, * see Object * Lock.

*/ inline void SetObjectLockLegalHoldStatus(ObjectLockLegalHoldStatus&& value) { m_objectLockLegalHoldStatus = std::move(value); } /** *

Specifies whether a legal hold is in effect for this object. This header is * only returned if the requester has the s3:GetObjectLegalHold * permission. This header is not returned if the specified version of this object * has never had a legal hold applied. For more information about S3 Object Lock, * see Object * Lock.

*/ inline HeadObjectResult& WithObjectLockLegalHoldStatus(const ObjectLockLegalHoldStatus& value) { SetObjectLockLegalHoldStatus(value); return *this;} /** *

Specifies whether a legal hold is in effect for this object. This header is * only returned if the requester has the s3:GetObjectLegalHold * permission. This header is not returned if the specified version of this object * has never had a legal hold applied. For more information about S3 Object Lock, * see Object * Lock.

*/ inline HeadObjectResult& WithObjectLockLegalHoldStatus(ObjectLockLegalHoldStatus&& value) { SetObjectLockLegalHoldStatus(std::move(value)); return *this;} private: bool m_deleteMarker; Aws::String m_acceptRanges; Aws::String m_expiration; Aws::String m_restore; ArchiveStatus m_archiveStatus; Aws::Utils::DateTime m_lastModified; long long m_contentLength; Aws::String m_eTag; int m_missingMeta; Aws::String m_versionId; Aws::String m_cacheControl; Aws::String m_contentDisposition; Aws::String m_contentEncoding; Aws::String m_contentLanguage; Aws::String m_contentType; Aws::Utils::DateTime m_expires; Aws::String m_websiteRedirectLocation; ServerSideEncryption m_serverSideEncryption; Aws::Map m_metadata; Aws::String m_sSECustomerAlgorithm; Aws::String m_sSECustomerKeyMD5; Aws::String m_sSEKMSKeyId; bool m_bucketKeyEnabled; StorageClass m_storageClass; RequestCharged m_requestCharged; ReplicationStatus m_replicationStatus; int m_partsCount; ObjectLockMode m_objectLockMode; Aws::Utils::DateTime m_objectLockRetainUntilDate; ObjectLockLegalHoldStatus m_objectLockLegalHoldStatus; }; } // namespace Model } // namespace S3 } // namespace Aws