/** * 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 S3Crt { namespace Model { /** */ class HeadObjectRequest : public S3CrtRequest { public: AWS_S3CRT_API HeadObjectRequest(); // 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 "HeadObject"; } AWS_S3CRT_API Aws::String SerializePayload() const override; AWS_S3CRT_API void AddQueryStringParameters(Aws::Http::URI& uri) const override; AWS_S3CRT_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** * Helper function to collect parameters (configurable and static hardcoded) required for endpoint computation. */ AWS_S3CRT_API EndpointParameters GetEndpointContextParams() const override; /** *

The name of the bucket containing the object.

When using this action * with an access point, you must direct requests to the access point hostname. The * access point hostname takes the form * AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. * When using this action with an access point through the Amazon Web Services * SDKs, you provide the access point ARN in place of the bucket name. For more * information about access point ARNs, see Using * access points in the Amazon S3 User Guide.

When you use this * action with Amazon S3 on Outposts, you must direct requests to the S3 on * Outposts hostname. The S3 on Outposts hostname takes the form * AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. * When you use this action with S3 on Outposts through the Amazon Web Services * SDKs, you provide the Outposts access point ARN in place of the bucket name. For * more information about S3 on Outposts ARNs, see What * is S3 on Outposts? in the Amazon S3 User Guide.

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

The name of the bucket containing the object.

When using this action * with an access point, you must direct requests to the access point hostname. The * access point hostname takes the form * AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. * When using this action with an access point through the Amazon Web Services * SDKs, you provide the access point ARN in place of the bucket name. For more * information about access point ARNs, see Using * access points in the Amazon S3 User Guide.

When you use this * action with Amazon S3 on Outposts, you must direct requests to the S3 on * Outposts hostname. The S3 on Outposts hostname takes the form * AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. * When you use this action with S3 on Outposts through the Amazon Web Services * SDKs, you provide the Outposts access point ARN in place of the bucket name. For * more information about S3 on Outposts ARNs, see What * is S3 on Outposts? in the Amazon S3 User Guide.

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

The name of the bucket containing the object.

When using this action * with an access point, you must direct requests to the access point hostname. The * access point hostname takes the form * AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. * When using this action with an access point through the Amazon Web Services * SDKs, you provide the access point ARN in place of the bucket name. For more * information about access point ARNs, see Using * access points in the Amazon S3 User Guide.

When you use this * action with Amazon S3 on Outposts, you must direct requests to the S3 on * Outposts hostname. The S3 on Outposts hostname takes the form * AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. * When you use this action with S3 on Outposts through the Amazon Web Services * SDKs, you provide the Outposts access point ARN in place of the bucket name. For * more information about S3 on Outposts ARNs, see What * is S3 on Outposts? in the Amazon S3 User Guide.

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

The name of the bucket containing the object.

When using this action * with an access point, you must direct requests to the access point hostname. The * access point hostname takes the form * AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. * When using this action with an access point through the Amazon Web Services * SDKs, you provide the access point ARN in place of the bucket name. For more * information about access point ARNs, see Using * access points in the Amazon S3 User Guide.

When you use this * action with Amazon S3 on Outposts, you must direct requests to the S3 on * Outposts hostname. The S3 on Outposts hostname takes the form * AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. * When you use this action with S3 on Outposts through the Amazon Web Services * SDKs, you provide the Outposts access point ARN in place of the bucket name. For * more information about S3 on Outposts ARNs, see What * is S3 on Outposts? in the Amazon S3 User Guide.

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

The name of the bucket containing the object.

When using this action * with an access point, you must direct requests to the access point hostname. The * access point hostname takes the form * AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. * When using this action with an access point through the Amazon Web Services * SDKs, you provide the access point ARN in place of the bucket name. For more * information about access point ARNs, see Using * access points in the Amazon S3 User Guide.

When you use this * action with Amazon S3 on Outposts, you must direct requests to the S3 on * Outposts hostname. The S3 on Outposts hostname takes the form * AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. * When you use this action with S3 on Outposts through the Amazon Web Services * SDKs, you provide the Outposts access point ARN in place of the bucket name. For * more information about S3 on Outposts ARNs, see What * is S3 on Outposts? in the Amazon S3 User Guide.

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

The name of the bucket containing the object.

When using this action * with an access point, you must direct requests to the access point hostname. The * access point hostname takes the form * AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. * When using this action with an access point through the Amazon Web Services * SDKs, you provide the access point ARN in place of the bucket name. For more * information about access point ARNs, see Using * access points in the Amazon S3 User Guide.

When you use this * action with Amazon S3 on Outposts, you must direct requests to the S3 on * Outposts hostname. The S3 on Outposts hostname takes the form * AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. * When you use this action with S3 on Outposts through the Amazon Web Services * SDKs, you provide the Outposts access point ARN in place of the bucket name. For * more information about S3 on Outposts ARNs, see What * is S3 on Outposts? in the Amazon S3 User Guide.

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

The name of the bucket containing the object.

When using this action * with an access point, you must direct requests to the access point hostname. The * access point hostname takes the form * AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. * When using this action with an access point through the Amazon Web Services * SDKs, you provide the access point ARN in place of the bucket name. For more * information about access point ARNs, see Using * access points in the Amazon S3 User Guide.

When you use this * action with Amazon S3 on Outposts, you must direct requests to the S3 on * Outposts hostname. The S3 on Outposts hostname takes the form * AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. * When you use this action with S3 on Outposts through the Amazon Web Services * SDKs, you provide the Outposts access point ARN in place of the bucket name. For * more information about S3 on Outposts ARNs, see What * is S3 on Outposts? in the Amazon S3 User Guide.

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

The name of the bucket containing the object.

When using this action * with an access point, you must direct requests to the access point hostname. The * access point hostname takes the form * AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. * When using this action with an access point through the Amazon Web Services * SDKs, you provide the access point ARN in place of the bucket name. For more * information about access point ARNs, see Using * access points in the Amazon S3 User Guide.

When you use this * action with Amazon S3 on Outposts, you must direct requests to the S3 on * Outposts hostname. The S3 on Outposts hostname takes the form * AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. * When you use this action with S3 on Outposts through the Amazon Web Services * SDKs, you provide the Outposts access point ARN in place of the bucket name. For * more information about S3 on Outposts ARNs, see What * is S3 on Outposts? in the Amazon S3 User Guide.

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

Return the object only if its entity tag (ETag) is the same as the one * specified; otherwise, return a 412 (precondition failed) error.

*/ inline const Aws::String& GetIfMatch() const{ return m_ifMatch; } /** *

Return the object only if its entity tag (ETag) is the same as the one * specified; otherwise, return a 412 (precondition failed) error.

*/ inline bool IfMatchHasBeenSet() const { return m_ifMatchHasBeenSet; } /** *

Return the object only if its entity tag (ETag) is the same as the one * specified; otherwise, return a 412 (precondition failed) error.

*/ inline void SetIfMatch(const Aws::String& value) { m_ifMatchHasBeenSet = true; m_ifMatch = value; } /** *

Return the object only if its entity tag (ETag) is the same as the one * specified; otherwise, return a 412 (precondition failed) error.

*/ inline void SetIfMatch(Aws::String&& value) { m_ifMatchHasBeenSet = true; m_ifMatch = std::move(value); } /** *

Return the object only if its entity tag (ETag) is the same as the one * specified; otherwise, return a 412 (precondition failed) error.

*/ inline void SetIfMatch(const char* value) { m_ifMatchHasBeenSet = true; m_ifMatch.assign(value); } /** *

Return the object only if its entity tag (ETag) is the same as the one * specified; otherwise, return a 412 (precondition failed) error.

*/ inline HeadObjectRequest& WithIfMatch(const Aws::String& value) { SetIfMatch(value); return *this;} /** *

Return the object only if its entity tag (ETag) is the same as the one * specified; otherwise, return a 412 (precondition failed) error.

*/ inline HeadObjectRequest& WithIfMatch(Aws::String&& value) { SetIfMatch(std::move(value)); return *this;} /** *

Return the object only if its entity tag (ETag) is the same as the one * specified; otherwise, return a 412 (precondition failed) error.

*/ inline HeadObjectRequest& WithIfMatch(const char* value) { SetIfMatch(value); return *this;} /** *

Return the object only if it has been modified since the specified time; * otherwise, return a 304 (not modified) error.

*/ inline const Aws::Utils::DateTime& GetIfModifiedSince() const{ return m_ifModifiedSince; } /** *

Return the object only if it has been modified since the specified time; * otherwise, return a 304 (not modified) error.

*/ inline bool IfModifiedSinceHasBeenSet() const { return m_ifModifiedSinceHasBeenSet; } /** *

Return the object only if it has been modified since the specified time; * otherwise, return a 304 (not modified) error.

*/ inline void SetIfModifiedSince(const Aws::Utils::DateTime& value) { m_ifModifiedSinceHasBeenSet = true; m_ifModifiedSince = value; } /** *

Return the object only if it has been modified since the specified time; * otherwise, return a 304 (not modified) error.

*/ inline void SetIfModifiedSince(Aws::Utils::DateTime&& value) { m_ifModifiedSinceHasBeenSet = true; m_ifModifiedSince = std::move(value); } /** *

Return the object only if it has been modified since the specified time; * otherwise, return a 304 (not modified) error.

*/ inline HeadObjectRequest& WithIfModifiedSince(const Aws::Utils::DateTime& value) { SetIfModifiedSince(value); return *this;} /** *

Return the object only if it has been modified since the specified time; * otherwise, return a 304 (not modified) error.

*/ inline HeadObjectRequest& WithIfModifiedSince(Aws::Utils::DateTime&& value) { SetIfModifiedSince(std::move(value)); return *this;} /** *

Return the object only if its entity tag (ETag) is different from the one * specified; otherwise, return a 304 (not modified) error.

*/ inline const Aws::String& GetIfNoneMatch() const{ return m_ifNoneMatch; } /** *

Return the object only if its entity tag (ETag) is different from the one * specified; otherwise, return a 304 (not modified) error.

*/ inline bool IfNoneMatchHasBeenSet() const { return m_ifNoneMatchHasBeenSet; } /** *

Return the object only if its entity tag (ETag) is different from the one * specified; otherwise, return a 304 (not modified) error.

*/ inline void SetIfNoneMatch(const Aws::String& value) { m_ifNoneMatchHasBeenSet = true; m_ifNoneMatch = value; } /** *

Return the object only if its entity tag (ETag) is different from the one * specified; otherwise, return a 304 (not modified) error.

*/ inline void SetIfNoneMatch(Aws::String&& value) { m_ifNoneMatchHasBeenSet = true; m_ifNoneMatch = std::move(value); } /** *

Return the object only if its entity tag (ETag) is different from the one * specified; otherwise, return a 304 (not modified) error.

*/ inline void SetIfNoneMatch(const char* value) { m_ifNoneMatchHasBeenSet = true; m_ifNoneMatch.assign(value); } /** *

Return the object only if its entity tag (ETag) is different from the one * specified; otherwise, return a 304 (not modified) error.

*/ inline HeadObjectRequest& WithIfNoneMatch(const Aws::String& value) { SetIfNoneMatch(value); return *this;} /** *

Return the object only if its entity tag (ETag) is different from the one * specified; otherwise, return a 304 (not modified) error.

*/ inline HeadObjectRequest& WithIfNoneMatch(Aws::String&& value) { SetIfNoneMatch(std::move(value)); return *this;} /** *

Return the object only if its entity tag (ETag) is different from the one * specified; otherwise, return a 304 (not modified) error.

*/ inline HeadObjectRequest& WithIfNoneMatch(const char* value) { SetIfNoneMatch(value); return *this;} /** *

Return the object only if it has not been modified since the specified time; * otherwise, return a 412 (precondition failed) error.

*/ inline const Aws::Utils::DateTime& GetIfUnmodifiedSince() const{ return m_ifUnmodifiedSince; } /** *

Return the object only if it has not been modified since the specified time; * otherwise, return a 412 (precondition failed) error.

*/ inline bool IfUnmodifiedSinceHasBeenSet() const { return m_ifUnmodifiedSinceHasBeenSet; } /** *

Return the object only if it has not been modified since the specified time; * otherwise, return a 412 (precondition failed) error.

*/ inline void SetIfUnmodifiedSince(const Aws::Utils::DateTime& value) { m_ifUnmodifiedSinceHasBeenSet = true; m_ifUnmodifiedSince = value; } /** *

Return the object only if it has not been modified since the specified time; * otherwise, return a 412 (precondition failed) error.

*/ inline void SetIfUnmodifiedSince(Aws::Utils::DateTime&& value) { m_ifUnmodifiedSinceHasBeenSet = true; m_ifUnmodifiedSince = std::move(value); } /** *

Return the object only if it has not been modified since the specified time; * otherwise, return a 412 (precondition failed) error.

*/ inline HeadObjectRequest& WithIfUnmodifiedSince(const Aws::Utils::DateTime& value) { SetIfUnmodifiedSince(value); return *this;} /** *

Return the object only if it has not been modified since the specified time; * otherwise, return a 412 (precondition failed) error.

*/ inline HeadObjectRequest& WithIfUnmodifiedSince(Aws::Utils::DateTime&& value) { SetIfUnmodifiedSince(std::move(value)); return *this;} /** *

The object key.

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

The object key.

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

The object key.

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

The object key.

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

The object key.

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

The object key.

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

The object key.

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

The object key.

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

HeadObject returns only the metadata for an object. If the Range is * satisfiable, only the ContentLength is affected in the response. If * the Range is not satisfiable, S3 returns a 416 - Requested Range Not * Satisfiable error.

*/ inline const Aws::String& GetRange() const{ return m_range; } /** *

HeadObject returns only the metadata for an object. If the Range is * satisfiable, only the ContentLength is affected in the response. If * the Range is not satisfiable, S3 returns a 416 - Requested Range Not * Satisfiable error.

*/ inline bool RangeHasBeenSet() const { return m_rangeHasBeenSet; } /** *

HeadObject returns only the metadata for an object. If the Range is * satisfiable, only the ContentLength is affected in the response. If * the Range is not satisfiable, S3 returns a 416 - Requested Range Not * Satisfiable error.

*/ inline void SetRange(const Aws::String& value) { m_rangeHasBeenSet = true; m_range = value; } /** *

HeadObject returns only the metadata for an object. If the Range is * satisfiable, only the ContentLength is affected in the response. If * the Range is not satisfiable, S3 returns a 416 - Requested Range Not * Satisfiable error.

*/ inline void SetRange(Aws::String&& value) { m_rangeHasBeenSet = true; m_range = std::move(value); } /** *

HeadObject returns only the metadata for an object. If the Range is * satisfiable, only the ContentLength is affected in the response. If * the Range is not satisfiable, S3 returns a 416 - Requested Range Not * Satisfiable error.

*/ inline void SetRange(const char* value) { m_rangeHasBeenSet = true; m_range.assign(value); } /** *

HeadObject returns only the metadata for an object. If the Range is * satisfiable, only the ContentLength is affected in the response. If * the Range is not satisfiable, S3 returns a 416 - Requested Range Not * Satisfiable error.

*/ inline HeadObjectRequest& WithRange(const Aws::String& value) { SetRange(value); return *this;} /** *

HeadObject returns only the metadata for an object. If the Range is * satisfiable, only the ContentLength is affected in the response. If * the Range is not satisfiable, S3 returns a 416 - Requested Range Not * Satisfiable error.

*/ inline HeadObjectRequest& WithRange(Aws::String&& value) { SetRange(std::move(value)); return *this;} /** *

HeadObject returns only the metadata for an object. If the Range is * satisfiable, only the ContentLength is affected in the response. If * the Range is not satisfiable, S3 returns a 416 - Requested Range Not * Satisfiable error.

*/ inline HeadObjectRequest& WithRange(const char* value) { SetRange(value); return *this;} /** *

VersionId used to reference a specific version of the object.

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

VersionId used to reference a specific version of the object.

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

VersionId used to reference a specific version of the object.

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

VersionId used to reference a specific version of the object.

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

VersionId used to reference a specific version of the object.

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

VersionId used to reference a specific version of the object.

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

VersionId used to reference a specific version of the object.

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

VersionId used to reference a specific version of the object.

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

Specifies the algorithm to use to when encrypting the object (for example, * AES256).

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

Specifies the algorithm to use to when encrypting the object (for example, * AES256).

*/ inline bool SSECustomerAlgorithmHasBeenSet() const { return m_sSECustomerAlgorithmHasBeenSet; } /** *

Specifies the algorithm to use to when encrypting the object (for example, * AES256).

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

Specifies the algorithm to use to when encrypting the object (for example, * AES256).

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

Specifies the algorithm to use to when encrypting the object (for example, * AES256).

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

Specifies the algorithm to use to when encrypting the object (for example, * AES256).

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

Specifies the algorithm to use to when encrypting the object (for example, * AES256).

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

Specifies the algorithm to use to when encrypting the object (for example, * AES256).

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

Specifies the customer-provided encryption key for Amazon S3 to use in * encrypting data. This value is used to store the object and then it is * discarded; Amazon S3 does not store the encryption key. The key must be * appropriate for use with the algorithm specified in the * x-amz-server-side-encryption-customer-algorithm header.

*/ inline const Aws::String& GetSSECustomerKey() const{ return m_sSECustomerKey; } /** *

Specifies the customer-provided encryption key for Amazon S3 to use in * encrypting data. This value is used to store the object and then it is * discarded; Amazon S3 does not store the encryption key. The key must be * appropriate for use with the algorithm specified in the * x-amz-server-side-encryption-customer-algorithm header.

*/ inline bool SSECustomerKeyHasBeenSet() const { return m_sSECustomerKeyHasBeenSet; } /** *

Specifies the customer-provided encryption key for Amazon S3 to use in * encrypting data. This value is used to store the object and then it is * discarded; Amazon S3 does not store the encryption key. The key must be * appropriate for use with the algorithm specified in the * x-amz-server-side-encryption-customer-algorithm header.

*/ inline void SetSSECustomerKey(const Aws::String& value) { m_sSECustomerKeyHasBeenSet = true; m_sSECustomerKey = value; } /** *

Specifies the customer-provided encryption key for Amazon S3 to use in * encrypting data. This value is used to store the object and then it is * discarded; Amazon S3 does not store the encryption key. The key must be * appropriate for use with the algorithm specified in the * x-amz-server-side-encryption-customer-algorithm header.

*/ inline void SetSSECustomerKey(Aws::String&& value) { m_sSECustomerKeyHasBeenSet = true; m_sSECustomerKey = std::move(value); } /** *

Specifies the customer-provided encryption key for Amazon S3 to use in * encrypting data. This value is used to store the object and then it is * discarded; Amazon S3 does not store the encryption key. The key must be * appropriate for use with the algorithm specified in the * x-amz-server-side-encryption-customer-algorithm header.

*/ inline void SetSSECustomerKey(const char* value) { m_sSECustomerKeyHasBeenSet = true; m_sSECustomerKey.assign(value); } /** *

Specifies the customer-provided encryption key for Amazon S3 to use in * encrypting data. This value is used to store the object and then it is * discarded; Amazon S3 does not store the encryption key. The key must be * appropriate for use with the algorithm specified in the * x-amz-server-side-encryption-customer-algorithm header.

*/ inline HeadObjectRequest& WithSSECustomerKey(const Aws::String& value) { SetSSECustomerKey(value); return *this;} /** *

Specifies the customer-provided encryption key for Amazon S3 to use in * encrypting data. This value is used to store the object and then it is * discarded; Amazon S3 does not store the encryption key. The key must be * appropriate for use with the algorithm specified in the * x-amz-server-side-encryption-customer-algorithm header.

*/ inline HeadObjectRequest& WithSSECustomerKey(Aws::String&& value) { SetSSECustomerKey(std::move(value)); return *this;} /** *

Specifies the customer-provided encryption key for Amazon S3 to use in * encrypting data. This value is used to store the object and then it is * discarded; Amazon S3 does not store the encryption key. The key must be * appropriate for use with the algorithm specified in the * x-amz-server-side-encryption-customer-algorithm header.

*/ inline HeadObjectRequest& WithSSECustomerKey(const char* value) { SetSSECustomerKey(value); return *this;} /** *

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. * Amazon S3 uses this header for a message integrity check to ensure that the * encryption key was transmitted without error.

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

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. * Amazon S3 uses this header for a message integrity check to ensure that the * encryption key was transmitted without error.

*/ inline bool SSECustomerKeyMD5HasBeenSet() const { return m_sSECustomerKeyMD5HasBeenSet; } /** *

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. * Amazon S3 uses this header for a message integrity check to ensure that the * encryption key was transmitted without error.

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

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. * Amazon S3 uses this header for a message integrity check to ensure that the * encryption key was transmitted without error.

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

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. * Amazon S3 uses this header for a message integrity check to ensure that the * encryption key was transmitted without error.

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

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. * Amazon S3 uses this header for a message integrity check to ensure that the * encryption key was transmitted without error.

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

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. * Amazon S3 uses this header for a message integrity check to ensure that the * encryption key was transmitted without error.

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

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. * Amazon S3 uses this header for a message integrity check to ensure that the * encryption key was transmitted without error.

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

Part number of the object being read. This is a positive integer between 1 * and 10,000. Effectively performs a 'ranged' HEAD request for the part specified. * Useful querying about the size of the part and the number of parts in this * object.

*/ inline int GetPartNumber() const{ return m_partNumber; } /** *

Part number of the object being read. This is a positive integer between 1 * and 10,000. Effectively performs a 'ranged' HEAD request for the part specified. * Useful querying about the size of the part and the number of parts in this * object.

*/ inline bool PartNumberHasBeenSet() const { return m_partNumberHasBeenSet; } /** *

Part number of the object being read. This is a positive integer between 1 * and 10,000. Effectively performs a 'ranged' HEAD request for the part specified. * Useful querying about the size of the part and the number of parts in this * object.

*/ inline void SetPartNumber(int value) { m_partNumberHasBeenSet = true; m_partNumber = value; } /** *

Part number of the object being read. This is a positive integer between 1 * and 10,000. Effectively performs a 'ranged' HEAD request for the part specified. * Useful querying about the size of the part and the number of parts in this * object.

*/ inline HeadObjectRequest& WithPartNumber(int value) { SetPartNumber(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 HeadObjectRequest& 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 HeadObjectRequest& 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 HeadObjectRequest& WithExpectedBucketOwner(const char* value) { SetExpectedBucketOwner(value); return *this;} /** *

To retrieve the checksum, this parameter must be enabled.

In addition, * if you enable ChecksumMode and the object is encrypted with Amazon * Web Services Key Management Service (Amazon Web Services KMS), you must have * permission to use the kms:Decrypt action for the request to * succeed.

*/ inline const ChecksumMode& GetChecksumMode() const{ return m_checksumMode; } /** *

To retrieve the checksum, this parameter must be enabled.

In addition, * if you enable ChecksumMode and the object is encrypted with Amazon * Web Services Key Management Service (Amazon Web Services KMS), you must have * permission to use the kms:Decrypt action for the request to * succeed.

*/ inline bool ChecksumModeHasBeenSet() const { return m_checksumModeHasBeenSet; } /** *

To retrieve the checksum, this parameter must be enabled.

In addition, * if you enable ChecksumMode and the object is encrypted with Amazon * Web Services Key Management Service (Amazon Web Services KMS), you must have * permission to use the kms:Decrypt action for the request to * succeed.

*/ inline void SetChecksumMode(const ChecksumMode& value) { m_checksumModeHasBeenSet = true; m_checksumMode = value; } /** *

To retrieve the checksum, this parameter must be enabled.

In addition, * if you enable ChecksumMode and the object is encrypted with Amazon * Web Services Key Management Service (Amazon Web Services KMS), you must have * permission to use the kms:Decrypt action for the request to * succeed.

*/ inline void SetChecksumMode(ChecksumMode&& value) { m_checksumModeHasBeenSet = true; m_checksumMode = std::move(value); } /** *

To retrieve the checksum, this parameter must be enabled.

In addition, * if you enable ChecksumMode and the object is encrypted with Amazon * Web Services Key Management Service (Amazon Web Services KMS), you must have * permission to use the kms:Decrypt action for the request to * succeed.

*/ inline HeadObjectRequest& WithChecksumMode(const ChecksumMode& value) { SetChecksumMode(value); return *this;} /** *

To retrieve the checksum, this parameter must be enabled.

In addition, * if you enable ChecksumMode and the object is encrypted with Amazon * Web Services Key Management Service (Amazon Web Services KMS), you must have * permission to use the kms:Decrypt action for the request to * succeed.

*/ inline HeadObjectRequest& WithChecksumMode(ChecksumMode&& value) { SetChecksumMode(std::move(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 HeadObjectRequest& WithCustomizedAccessLogTag(const Aws::Map& value) { SetCustomizedAccessLogTag(value); return *this;} inline HeadObjectRequest& WithCustomizedAccessLogTag(Aws::Map&& value) { SetCustomizedAccessLogTag(std::move(value)); return *this;} inline HeadObjectRequest& AddCustomizedAccessLogTag(const Aws::String& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; } inline HeadObjectRequest& AddCustomizedAccessLogTag(Aws::String&& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; } inline HeadObjectRequest& AddCustomizedAccessLogTag(const Aws::String& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; } inline HeadObjectRequest& AddCustomizedAccessLogTag(Aws::String&& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), std::move(value)); return *this; } inline HeadObjectRequest& AddCustomizedAccessLogTag(const char* key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; } inline HeadObjectRequest& AddCustomizedAccessLogTag(Aws::String&& key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; } inline HeadObjectRequest& 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_ifMatch; bool m_ifMatchHasBeenSet = false; Aws::Utils::DateTime m_ifModifiedSince; bool m_ifModifiedSinceHasBeenSet = false; Aws::String m_ifNoneMatch; bool m_ifNoneMatchHasBeenSet = false; Aws::Utils::DateTime m_ifUnmodifiedSince; bool m_ifUnmodifiedSinceHasBeenSet = false; Aws::String m_key; bool m_keyHasBeenSet = false; Aws::String m_range; bool m_rangeHasBeenSet = false; Aws::String m_versionId; bool m_versionIdHasBeenSet = false; Aws::String m_sSECustomerAlgorithm; bool m_sSECustomerAlgorithmHasBeenSet = false; Aws::String m_sSECustomerKey; bool m_sSECustomerKeyHasBeenSet = false; Aws::String m_sSECustomerKeyMD5; bool m_sSECustomerKeyMD5HasBeenSet = false; RequestPayer m_requestPayer; bool m_requestPayerHasBeenSet = false; int m_partNumber; bool m_partNumberHasBeenSet = false; Aws::String m_expectedBucketOwner; bool m_expectedBucketOwnerHasBeenSet = false; ChecksumMode m_checksumMode; bool m_checksumModeHasBeenSet = false; Aws::Map m_customizedAccessLogTag; bool m_customizedAccessLogTagHasBeenSet = false; }; } // namespace Model } // namespace S3Crt } // namespace Aws