diff options
author | Devtools Arcadia <arcadia-devtools@yandex-team.ru> | 2022-02-07 18:08:42 +0300 |
---|---|---|
committer | Devtools Arcadia <arcadia-devtools@mous.vla.yp-c.yandex.net> | 2022-02-07 18:08:42 +0300 |
commit | 1110808a9d39d4b808aef724c861a2e1a38d2a69 (patch) | |
tree | e26c9fed0de5d9873cce7e00bc214573dc2195b7 /contrib/libs/aws-sdk-cpp/aws-cpp-sdk-s3/include/aws/s3/model/HeadObjectRequest.h | |
download | ydb-1110808a9d39d4b808aef724c861a2e1a38d2a69.tar.gz |
intermediate changes
ref:cde9a383711a11544ce7e107a78147fb96cc4029
Diffstat (limited to 'contrib/libs/aws-sdk-cpp/aws-cpp-sdk-s3/include/aws/s3/model/HeadObjectRequest.h')
-rw-r--r-- | contrib/libs/aws-sdk-cpp/aws-cpp-sdk-s3/include/aws/s3/model/HeadObjectRequest.h | 935 |
1 files changed, 935 insertions, 0 deletions
diff --git a/contrib/libs/aws-sdk-cpp/aws-cpp-sdk-s3/include/aws/s3/model/HeadObjectRequest.h b/contrib/libs/aws-sdk-cpp/aws-cpp-sdk-s3/include/aws/s3/model/HeadObjectRequest.h new file mode 100644 index 0000000000..d7de0c5ab2 --- /dev/null +++ b/contrib/libs/aws-sdk-cpp/aws-cpp-sdk-s3/include/aws/s3/model/HeadObjectRequest.h @@ -0,0 +1,935 @@ +/** + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0. + */ + +#pragma once +#include <aws/s3/S3_EXPORTS.h> +#include <aws/s3/S3Request.h> +#include <aws/core/utils/memory/stl/AWSString.h> +#include <aws/core/utils/DateTime.h> +#include <aws/s3/model/RequestPayer.h> +#include <aws/core/utils/memory/stl/AWSMap.h> +#include <utility> + +namespace Aws +{ +namespace Http +{ + class URI; +} //namespace Http +namespace S3 +{ +namespace Model +{ + + /** + */ + class AWS_S3_API HeadObjectRequest : public S3Request + { + public: + 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::String SerializePayload() const override; + + void AddQueryStringParameters(Aws::Http::URI& uri) const override; + + Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; + + + /** + * <p>The name of the bucket containing the object.</p> <p>When using this API with + * an access point, you must direct requests to the access point hostname. The + * access point hostname takes the form + * <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. + * When using this operation with an access point through the AWS SDKs, you provide + * the access point ARN in place of the bucket name. For more information about + * access point ARNs, see <a + * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html">Using + * Access Points</a> in the <i>Amazon Simple Storage Service Developer + * Guide</i>.</p> <p>When using this API with Amazon S3 on Outposts, you must + * direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname + * takes the form + * <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com. + * When using this operation using S3 on Outposts through the AWS SDKs, you provide + * the Outposts bucket ARN in place of the bucket name. For more information about + * S3 on Outposts ARNs, see <a + * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html">Using + * S3 on Outposts</a> in the <i>Amazon Simple Storage Service Developer + * Guide</i>.</p> + */ + inline const Aws::String& GetBucket() const{ return m_bucket; } + + /** + * <p>The name of the bucket containing the object.</p> <p>When using this API with + * an access point, you must direct requests to the access point hostname. The + * access point hostname takes the form + * <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. + * When using this operation with an access point through the AWS SDKs, you provide + * the access point ARN in place of the bucket name. For more information about + * access point ARNs, see <a + * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html">Using + * Access Points</a> in the <i>Amazon Simple Storage Service Developer + * Guide</i>.</p> <p>When using this API with Amazon S3 on Outposts, you must + * direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname + * takes the form + * <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com. + * When using this operation using S3 on Outposts through the AWS SDKs, you provide + * the Outposts bucket ARN in place of the bucket name. For more information about + * S3 on Outposts ARNs, see <a + * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html">Using + * S3 on Outposts</a> in the <i>Amazon Simple Storage Service Developer + * Guide</i>.</p> + */ + inline bool BucketHasBeenSet() const { return m_bucketHasBeenSet; } + + /** + * <p>The name of the bucket containing the object.</p> <p>When using this API with + * an access point, you must direct requests to the access point hostname. The + * access point hostname takes the form + * <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. + * When using this operation with an access point through the AWS SDKs, you provide + * the access point ARN in place of the bucket name. For more information about + * access point ARNs, see <a + * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html">Using + * Access Points</a> in the <i>Amazon Simple Storage Service Developer + * Guide</i>.</p> <p>When using this API with Amazon S3 on Outposts, you must + * direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname + * takes the form + * <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com. + * When using this operation using S3 on Outposts through the AWS SDKs, you provide + * the Outposts bucket ARN in place of the bucket name. For more information about + * S3 on Outposts ARNs, see <a + * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html">Using + * S3 on Outposts</a> in the <i>Amazon Simple Storage Service Developer + * Guide</i>.</p> + */ + inline void SetBucket(const Aws::String& value) { m_bucketHasBeenSet = true; m_bucket = value; } + + /** + * <p>The name of the bucket containing the object.</p> <p>When using this API with + * an access point, you must direct requests to the access point hostname. The + * access point hostname takes the form + * <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. + * When using this operation with an access point through the AWS SDKs, you provide + * the access point ARN in place of the bucket name. For more information about + * access point ARNs, see <a + * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html">Using + * Access Points</a> in the <i>Amazon Simple Storage Service Developer + * Guide</i>.</p> <p>When using this API with Amazon S3 on Outposts, you must + * direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname + * takes the form + * <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com. + * When using this operation using S3 on Outposts through the AWS SDKs, you provide + * the Outposts bucket ARN in place of the bucket name. For more information about + * S3 on Outposts ARNs, see <a + * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html">Using + * S3 on Outposts</a> in the <i>Amazon Simple Storage Service Developer + * Guide</i>.</p> + */ + inline void SetBucket(Aws::String&& value) { m_bucketHasBeenSet = true; m_bucket = std::move(value); } + + /** + * <p>The name of the bucket containing the object.</p> <p>When using this API with + * an access point, you must direct requests to the access point hostname. The + * access point hostname takes the form + * <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. + * When using this operation with an access point through the AWS SDKs, you provide + * the access point ARN in place of the bucket name. For more information about + * access point ARNs, see <a + * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html">Using + * Access Points</a> in the <i>Amazon Simple Storage Service Developer + * Guide</i>.</p> <p>When using this API with Amazon S3 on Outposts, you must + * direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname + * takes the form + * <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com. + * When using this operation using S3 on Outposts through the AWS SDKs, you provide + * the Outposts bucket ARN in place of the bucket name. For more information about + * S3 on Outposts ARNs, see <a + * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html">Using + * S3 on Outposts</a> in the <i>Amazon Simple Storage Service Developer + * Guide</i>.</p> + */ + inline void SetBucket(const char* value) { m_bucketHasBeenSet = true; m_bucket.assign(value); } + + /** + * <p>The name of the bucket containing the object.</p> <p>When using this API with + * an access point, you must direct requests to the access point hostname. The + * access point hostname takes the form + * <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. + * When using this operation with an access point through the AWS SDKs, you provide + * the access point ARN in place of the bucket name. For more information about + * access point ARNs, see <a + * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html">Using + * Access Points</a> in the <i>Amazon Simple Storage Service Developer + * Guide</i>.</p> <p>When using this API with Amazon S3 on Outposts, you must + * direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname + * takes the form + * <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com. + * When using this operation using S3 on Outposts through the AWS SDKs, you provide + * the Outposts bucket ARN in place of the bucket name. For more information about + * S3 on Outposts ARNs, see <a + * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html">Using + * S3 on Outposts</a> in the <i>Amazon Simple Storage Service Developer + * Guide</i>.</p> + */ + inline HeadObjectRequest& WithBucket(const Aws::String& value) { SetBucket(value); return *this;} + + /** + * <p>The name of the bucket containing the object.</p> <p>When using this API with + * an access point, you must direct requests to the access point hostname. The + * access point hostname takes the form + * <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. + * When using this operation with an access point through the AWS SDKs, you provide + * the access point ARN in place of the bucket name. For more information about + * access point ARNs, see <a + * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html">Using + * Access Points</a> in the <i>Amazon Simple Storage Service Developer + * Guide</i>.</p> <p>When using this API with Amazon S3 on Outposts, you must + * direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname + * takes the form + * <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com. + * When using this operation using S3 on Outposts through the AWS SDKs, you provide + * the Outposts bucket ARN in place of the bucket name. For more information about + * S3 on Outposts ARNs, see <a + * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html">Using + * S3 on Outposts</a> in the <i>Amazon Simple Storage Service Developer + * Guide</i>.</p> + */ + inline HeadObjectRequest& WithBucket(Aws::String&& value) { SetBucket(std::move(value)); return *this;} + + /** + * <p>The name of the bucket containing the object.</p> <p>When using this API with + * an access point, you must direct requests to the access point hostname. The + * access point hostname takes the form + * <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. + * When using this operation with an access point through the AWS SDKs, you provide + * the access point ARN in place of the bucket name. For more information about + * access point ARNs, see <a + * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html">Using + * Access Points</a> in the <i>Amazon Simple Storage Service Developer + * Guide</i>.</p> <p>When using this API with Amazon S3 on Outposts, you must + * direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname + * takes the form + * <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com. + * When using this operation using S3 on Outposts through the AWS SDKs, you provide + * the Outposts bucket ARN in place of the bucket name. For more information about + * S3 on Outposts ARNs, see <a + * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html">Using + * S3 on Outposts</a> in the <i>Amazon Simple Storage Service Developer + * Guide</i>.</p> + */ + inline HeadObjectRequest& WithBucket(const char* value) { SetBucket(value); return *this;} + + + /** + * <p>Return the object only if its entity tag (ETag) is the same as the one + * specified, otherwise return a 412 (precondition failed).</p> + */ + inline const Aws::String& GetIfMatch() const{ return m_ifMatch; } + + /** + * <p>Return the object only if its entity tag (ETag) is the same as the one + * specified, otherwise return a 412 (precondition failed).</p> + */ + inline bool IfMatchHasBeenSet() const { return m_ifMatchHasBeenSet; } + + /** + * <p>Return the object only if its entity tag (ETag) is the same as the one + * specified, otherwise return a 412 (precondition failed).</p> + */ + inline void SetIfMatch(const Aws::String& value) { m_ifMatchHasBeenSet = true; m_ifMatch = value; } + + /** + * <p>Return the object only if its entity tag (ETag) is the same as the one + * specified, otherwise return a 412 (precondition failed).</p> + */ + inline void SetIfMatch(Aws::String&& value) { m_ifMatchHasBeenSet = true; m_ifMatch = std::move(value); } + + /** + * <p>Return the object only if its entity tag (ETag) is the same as the one + * specified, otherwise return a 412 (precondition failed).</p> + */ + inline void SetIfMatch(const char* value) { m_ifMatchHasBeenSet = true; m_ifMatch.assign(value); } + + /** + * <p>Return the object only if its entity tag (ETag) is the same as the one + * specified, otherwise return a 412 (precondition failed).</p> + */ + inline HeadObjectRequest& WithIfMatch(const Aws::String& value) { SetIfMatch(value); return *this;} + + /** + * <p>Return the object only if its entity tag (ETag) is the same as the one + * specified, otherwise return a 412 (precondition failed).</p> + */ + inline HeadObjectRequest& WithIfMatch(Aws::String&& value) { SetIfMatch(std::move(value)); return *this;} + + /** + * <p>Return the object only if its entity tag (ETag) is the same as the one + * specified, otherwise return a 412 (precondition failed).</p> + */ + inline HeadObjectRequest& WithIfMatch(const char* value) { SetIfMatch(value); return *this;} + + + /** + * <p>Return the object only if it has been modified since the specified time, + * otherwise return a 304 (not modified).</p> + */ + inline const Aws::Utils::DateTime& GetIfModifiedSince() const{ return m_ifModifiedSince; } + + /** + * <p>Return the object only if it has been modified since the specified time, + * otherwise return a 304 (not modified).</p> + */ + inline bool IfModifiedSinceHasBeenSet() const { return m_ifModifiedSinceHasBeenSet; } + + /** + * <p>Return the object only if it has been modified since the specified time, + * otherwise return a 304 (not modified).</p> + */ + inline void SetIfModifiedSince(const Aws::Utils::DateTime& value) { m_ifModifiedSinceHasBeenSet = true; m_ifModifiedSince = value; } + + /** + * <p>Return the object only if it has been modified since the specified time, + * otherwise return a 304 (not modified).</p> + */ + inline void SetIfModifiedSince(Aws::Utils::DateTime&& value) { m_ifModifiedSinceHasBeenSet = true; m_ifModifiedSince = std::move(value); } + + /** + * <p>Return the object only if it has been modified since the specified time, + * otherwise return a 304 (not modified).</p> + */ + inline HeadObjectRequest& WithIfModifiedSince(const Aws::Utils::DateTime& value) { SetIfModifiedSince(value); return *this;} + + /** + * <p>Return the object only if it has been modified since the specified time, + * otherwise return a 304 (not modified).</p> + */ + inline HeadObjectRequest& WithIfModifiedSince(Aws::Utils::DateTime&& value) { SetIfModifiedSince(std::move(value)); return *this;} + + + /** + * <p>Return the object only if its entity tag (ETag) is different from the one + * specified, otherwise return a 304 (not modified).</p> + */ + inline const Aws::String& GetIfNoneMatch() const{ return m_ifNoneMatch; } + + /** + * <p>Return the object only if its entity tag (ETag) is different from the one + * specified, otherwise return a 304 (not modified).</p> + */ + inline bool IfNoneMatchHasBeenSet() const { return m_ifNoneMatchHasBeenSet; } + + /** + * <p>Return the object only if its entity tag (ETag) is different from the one + * specified, otherwise return a 304 (not modified).</p> + */ + inline void SetIfNoneMatch(const Aws::String& value) { m_ifNoneMatchHasBeenSet = true; m_ifNoneMatch = value; } + + /** + * <p>Return the object only if its entity tag (ETag) is different from the one + * specified, otherwise return a 304 (not modified).</p> + */ + inline void SetIfNoneMatch(Aws::String&& value) { m_ifNoneMatchHasBeenSet = true; m_ifNoneMatch = std::move(value); } + + /** + * <p>Return the object only if its entity tag (ETag) is different from the one + * specified, otherwise return a 304 (not modified).</p> + */ + inline void SetIfNoneMatch(const char* value) { m_ifNoneMatchHasBeenSet = true; m_ifNoneMatch.assign(value); } + + /** + * <p>Return the object only if its entity tag (ETag) is different from the one + * specified, otherwise return a 304 (not modified).</p> + */ + inline HeadObjectRequest& WithIfNoneMatch(const Aws::String& value) { SetIfNoneMatch(value); return *this;} + + /** + * <p>Return the object only if its entity tag (ETag) is different from the one + * specified, otherwise return a 304 (not modified).</p> + */ + inline HeadObjectRequest& WithIfNoneMatch(Aws::String&& value) { SetIfNoneMatch(std::move(value)); return *this;} + + /** + * <p>Return the object only if its entity tag (ETag) is different from the one + * specified, otherwise return a 304 (not modified).</p> + */ + inline HeadObjectRequest& WithIfNoneMatch(const char* value) { SetIfNoneMatch(value); return *this;} + + + /** + * <p>Return the object only if it has not been modified since the specified time, + * otherwise return a 412 (precondition failed).</p> + */ + inline const Aws::Utils::DateTime& GetIfUnmodifiedSince() const{ return m_ifUnmodifiedSince; } + + /** + * <p>Return the object only if it has not been modified since the specified time, + * otherwise return a 412 (precondition failed).</p> + */ + inline bool IfUnmodifiedSinceHasBeenSet() const { return m_ifUnmodifiedSinceHasBeenSet; } + + /** + * <p>Return the object only if it has not been modified since the specified time, + * otherwise return a 412 (precondition failed).</p> + */ + inline void SetIfUnmodifiedSince(const Aws::Utils::DateTime& value) { m_ifUnmodifiedSinceHasBeenSet = true; m_ifUnmodifiedSince = value; } + + /** + * <p>Return the object only if it has not been modified since the specified time, + * otherwise return a 412 (precondition failed).</p> + */ + inline void SetIfUnmodifiedSince(Aws::Utils::DateTime&& value) { m_ifUnmodifiedSinceHasBeenSet = true; m_ifUnmodifiedSince = std::move(value); } + + /** + * <p>Return the object only if it has not been modified since the specified time, + * otherwise return a 412 (precondition failed).</p> + */ + inline HeadObjectRequest& WithIfUnmodifiedSince(const Aws::Utils::DateTime& value) { SetIfUnmodifiedSince(value); return *this;} + + /** + * <p>Return the object only if it has not been modified since the specified time, + * otherwise return a 412 (precondition failed).</p> + */ + inline HeadObjectRequest& WithIfUnmodifiedSince(Aws::Utils::DateTime&& value) { SetIfUnmodifiedSince(std::move(value)); return *this;} + + + /** + * <p>The object key.</p> + */ + inline const Aws::String& GetKey() const{ return m_key; } + + /** + * <p>The object key.</p> + */ + inline bool KeyHasBeenSet() const { return m_keyHasBeenSet; } + + /** + * <p>The object key.</p> + */ + inline void SetKey(const Aws::String& value) { m_keyHasBeenSet = true; m_key = value; } + + /** + * <p>The object key.</p> + */ + inline void SetKey(Aws::String&& value) { m_keyHasBeenSet = true; m_key = std::move(value); } + + /** + * <p>The object key.</p> + */ + inline void SetKey(const char* value) { m_keyHasBeenSet = true; m_key.assign(value); } + + /** + * <p>The object key.</p> + */ + inline HeadObjectRequest& WithKey(const Aws::String& value) { SetKey(value); return *this;} + + /** + * <p>The object key.</p> + */ + inline HeadObjectRequest& WithKey(Aws::String&& value) { SetKey(std::move(value)); return *this;} + + /** + * <p>The object key.</p> + */ + inline HeadObjectRequest& WithKey(const char* value) { SetKey(value); return *this;} + + + /** + * <p>Downloads the specified range bytes of an object. For more information about + * the HTTP Range header, see <a + * href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35</a>.</p> + * <p>Amazon S3 doesn't support retrieving multiple ranges of data per + * <code>GET</code> request.</p> + */ + inline const Aws::String& GetRange() const{ return m_range; } + + /** + * <p>Downloads the specified range bytes of an object. For more information about + * the HTTP Range header, see <a + * href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35</a>.</p> + * <p>Amazon S3 doesn't support retrieving multiple ranges of data per + * <code>GET</code> request.</p> + */ + inline bool RangeHasBeenSet() const { return m_rangeHasBeenSet; } + + /** + * <p>Downloads the specified range bytes of an object. For more information about + * the HTTP Range header, see <a + * href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35</a>.</p> + * <p>Amazon S3 doesn't support retrieving multiple ranges of data per + * <code>GET</code> request.</p> + */ + inline void SetRange(const Aws::String& value) { m_rangeHasBeenSet = true; m_range = value; } + + /** + * <p>Downloads the specified range bytes of an object. For more information about + * the HTTP Range header, see <a + * href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35</a>.</p> + * <p>Amazon S3 doesn't support retrieving multiple ranges of data per + * <code>GET</code> request.</p> + */ + inline void SetRange(Aws::String&& value) { m_rangeHasBeenSet = true; m_range = std::move(value); } + + /** + * <p>Downloads the specified range bytes of an object. For more information about + * the HTTP Range header, see <a + * href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35</a>.</p> + * <p>Amazon S3 doesn't support retrieving multiple ranges of data per + * <code>GET</code> request.</p> + */ + inline void SetRange(const char* value) { m_rangeHasBeenSet = true; m_range.assign(value); } + + /** + * <p>Downloads the specified range bytes of an object. For more information about + * the HTTP Range header, see <a + * href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35</a>.</p> + * <p>Amazon S3 doesn't support retrieving multiple ranges of data per + * <code>GET</code> request.</p> + */ + inline HeadObjectRequest& WithRange(const Aws::String& value) { SetRange(value); return *this;} + + /** + * <p>Downloads the specified range bytes of an object. For more information about + * the HTTP Range header, see <a + * href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35</a>.</p> + * <p>Amazon S3 doesn't support retrieving multiple ranges of data per + * <code>GET</code> request.</p> + */ + inline HeadObjectRequest& WithRange(Aws::String&& value) { SetRange(std::move(value)); return *this;} + + /** + * <p>Downloads the specified range bytes of an object. For more information about + * the HTTP Range header, see <a + * href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35</a>.</p> + * <p>Amazon S3 doesn't support retrieving multiple ranges of data per + * <code>GET</code> request.</p> + */ + inline HeadObjectRequest& WithRange(const char* value) { SetRange(value); return *this;} + + + /** + * <p>VersionId used to reference a specific version of the object.</p> + */ + inline const Aws::String& GetVersionId() const{ return m_versionId; } + + /** + * <p>VersionId used to reference a specific version of the object.</p> + */ + inline bool VersionIdHasBeenSet() const { return m_versionIdHasBeenSet; } + + /** + * <p>VersionId used to reference a specific version of the object.</p> + */ + inline void SetVersionId(const Aws::String& value) { m_versionIdHasBeenSet = true; m_versionId = value; } + + /** + * <p>VersionId used to reference a specific version of the object.</p> + */ + inline void SetVersionId(Aws::String&& value) { m_versionIdHasBeenSet = true; m_versionId = std::move(value); } + + /** + * <p>VersionId used to reference a specific version of the object.</p> + */ + inline void SetVersionId(const char* value) { m_versionIdHasBeenSet = true; m_versionId.assign(value); } + + /** + * <p>VersionId used to reference a specific version of the object.</p> + */ + inline HeadObjectRequest& WithVersionId(const Aws::String& value) { SetVersionId(value); return *this;} + + /** + * <p>VersionId used to reference a specific version of the object.</p> + */ + inline HeadObjectRequest& WithVersionId(Aws::String&& value) { SetVersionId(std::move(value)); return *this;} + + /** + * <p>VersionId used to reference a specific version of the object.</p> + */ + inline HeadObjectRequest& WithVersionId(const char* value) { SetVersionId(value); return *this;} + + + /** + * <p>Specifies the algorithm to use to when encrypting the object (for example, + * AES256).</p> + */ + inline const Aws::String& GetSSECustomerAlgorithm() const{ return m_sSECustomerAlgorithm; } + + /** + * <p>Specifies the algorithm to use to when encrypting the object (for example, + * AES256).</p> + */ + inline bool SSECustomerAlgorithmHasBeenSet() const { return m_sSECustomerAlgorithmHasBeenSet; } + + /** + * <p>Specifies the algorithm to use to when encrypting the object (for example, + * AES256).</p> + */ + inline void SetSSECustomerAlgorithm(const Aws::String& value) { m_sSECustomerAlgorithmHasBeenSet = true; m_sSECustomerAlgorithm = value; } + + /** + * <p>Specifies the algorithm to use to when encrypting the object (for example, + * AES256).</p> + */ + inline void SetSSECustomerAlgorithm(Aws::String&& value) { m_sSECustomerAlgorithmHasBeenSet = true; m_sSECustomerAlgorithm = std::move(value); } + + /** + * <p>Specifies the algorithm to use to when encrypting the object (for example, + * AES256).</p> + */ + inline void SetSSECustomerAlgorithm(const char* value) { m_sSECustomerAlgorithmHasBeenSet = true; m_sSECustomerAlgorithm.assign(value); } + + /** + * <p>Specifies the algorithm to use to when encrypting the object (for example, + * AES256).</p> + */ + inline HeadObjectRequest& WithSSECustomerAlgorithm(const Aws::String& value) { SetSSECustomerAlgorithm(value); return *this;} + + /** + * <p>Specifies the algorithm to use to when encrypting the object (for example, + * AES256).</p> + */ + inline HeadObjectRequest& WithSSECustomerAlgorithm(Aws::String&& value) { SetSSECustomerAlgorithm(std::move(value)); return *this;} + + /** + * <p>Specifies the algorithm to use to when encrypting the object (for example, + * AES256).</p> + */ + inline HeadObjectRequest& WithSSECustomerAlgorithm(const char* value) { SetSSECustomerAlgorithm(value); return *this;} + + + /** + * <p>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 + * <code>x-amz-server-side-encryption-customer-algorithm</code> header.</p> + */ + inline const Aws::String& GetSSECustomerKey() const{ return m_sSECustomerKey; } + + /** + * <p>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 + * <code>x-amz-server-side-encryption-customer-algorithm</code> header.</p> + */ + inline bool SSECustomerKeyHasBeenSet() const { return m_sSECustomerKeyHasBeenSet; } + + /** + * <p>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 + * <code>x-amz-server-side-encryption-customer-algorithm</code> header.</p> + */ + inline void SetSSECustomerKey(const Aws::String& value) { m_sSECustomerKeyHasBeenSet = true; m_sSECustomerKey = value; } + + /** + * <p>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 + * <code>x-amz-server-side-encryption-customer-algorithm</code> header.</p> + */ + inline void SetSSECustomerKey(Aws::String&& value) { m_sSECustomerKeyHasBeenSet = true; m_sSECustomerKey = std::move(value); } + + /** + * <p>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 + * <code>x-amz-server-side-encryption-customer-algorithm</code> header.</p> + */ + inline void SetSSECustomerKey(const char* value) { m_sSECustomerKeyHasBeenSet = true; m_sSECustomerKey.assign(value); } + + /** + * <p>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 + * <code>x-amz-server-side-encryption-customer-algorithm</code> header.</p> + */ + inline HeadObjectRequest& WithSSECustomerKey(const Aws::String& value) { SetSSECustomerKey(value); return *this;} + + /** + * <p>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 + * <code>x-amz-server-side-encryption-customer-algorithm</code> header.</p> + */ + inline HeadObjectRequest& WithSSECustomerKey(Aws::String&& value) { SetSSECustomerKey(std::move(value)); return *this;} + + /** + * <p>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 + * <code>x-amz-server-side-encryption-customer-algorithm</code> header.</p> + */ + inline HeadObjectRequest& WithSSECustomerKey(const char* value) { SetSSECustomerKey(value); return *this;} + + + /** + * <p>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.</p> + */ + inline const Aws::String& GetSSECustomerKeyMD5() const{ return m_sSECustomerKeyMD5; } + + /** + * <p>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.</p> + */ + inline bool SSECustomerKeyMD5HasBeenSet() const { return m_sSECustomerKeyMD5HasBeenSet; } + + /** + * <p>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.</p> + */ + inline void SetSSECustomerKeyMD5(const Aws::String& value) { m_sSECustomerKeyMD5HasBeenSet = true; m_sSECustomerKeyMD5 = value; } + + /** + * <p>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.</p> + */ + inline void SetSSECustomerKeyMD5(Aws::String&& value) { m_sSECustomerKeyMD5HasBeenSet = true; m_sSECustomerKeyMD5 = std::move(value); } + + /** + * <p>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.</p> + */ + inline void SetSSECustomerKeyMD5(const char* value) { m_sSECustomerKeyMD5HasBeenSet = true; m_sSECustomerKeyMD5.assign(value); } + + /** + * <p>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.</p> + */ + inline HeadObjectRequest& WithSSECustomerKeyMD5(const Aws::String& value) { SetSSECustomerKeyMD5(value); return *this;} + + /** + * <p>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.</p> + */ + inline HeadObjectRequest& WithSSECustomerKeyMD5(Aws::String&& value) { SetSSECustomerKeyMD5(std::move(value)); return *this;} + + /** + * <p>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.</p> + */ + 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;} + + + /** + * <p>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.</p> + */ + inline int GetPartNumber() const{ return m_partNumber; } + + /** + * <p>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.</p> + */ + inline bool PartNumberHasBeenSet() const { return m_partNumberHasBeenSet; } + + /** + * <p>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.</p> + */ + inline void SetPartNumber(int value) { m_partNumberHasBeenSet = true; m_partNumber = value; } + + /** + * <p>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.</p> + */ + inline HeadObjectRequest& WithPartNumber(int value) { SetPartNumber(value); return *this;} + + + /** + * <p>The account id of the expected bucket owner. If the bucket is owned by a + * different account, the request will fail with an HTTP <code>403 (Access + * Denied)</code> error.</p> + */ + inline const Aws::String& GetExpectedBucketOwner() const{ return m_expectedBucketOwner; } + + /** + * <p>The account id of the expected bucket owner. If the bucket is owned by a + * different account, the request will fail with an HTTP <code>403 (Access + * Denied)</code> error.</p> + */ + inline bool ExpectedBucketOwnerHasBeenSet() const { return m_expectedBucketOwnerHasBeenSet; } + + /** + * <p>The account id of the expected bucket owner. If the bucket is owned by a + * different account, the request will fail with an HTTP <code>403 (Access + * Denied)</code> error.</p> + */ + inline void SetExpectedBucketOwner(const Aws::String& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = value; } + + /** + * <p>The account id of the expected bucket owner. If the bucket is owned by a + * different account, the request will fail with an HTTP <code>403 (Access + * Denied)</code> error.</p> + */ + inline void SetExpectedBucketOwner(Aws::String&& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = std::move(value); } + + /** + * <p>The account id of the expected bucket owner. If the bucket is owned by a + * different account, the request will fail with an HTTP <code>403 (Access + * Denied)</code> error.</p> + */ + inline void SetExpectedBucketOwner(const char* value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner.assign(value); } + + /** + * <p>The account id of the expected bucket owner. If the bucket is owned by a + * different account, the request will fail with an HTTP <code>403 (Access + * Denied)</code> error.</p> + */ + inline HeadObjectRequest& WithExpectedBucketOwner(const Aws::String& value) { SetExpectedBucketOwner(value); return *this;} + + /** + * <p>The account id of the expected bucket owner. If the bucket is owned by a + * different account, the request will fail with an HTTP <code>403 (Access + * Denied)</code> error.</p> + */ + inline HeadObjectRequest& WithExpectedBucketOwner(Aws::String&& value) { SetExpectedBucketOwner(std::move(value)); return *this;} + + /** + * <p>The account id of the expected bucket owner. If the bucket is owned by a + * different account, the request will fail with an HTTP <code>403 (Access + * Denied)</code> error.</p> + */ + inline HeadObjectRequest& WithExpectedBucketOwner(const char* value) { SetExpectedBucketOwner(value); return *this;} + + + + inline const Aws::Map<Aws::String, Aws::String>& GetCustomizedAccessLogTag() const{ return m_customizedAccessLogTag; } + + + inline bool CustomizedAccessLogTagHasBeenSet() const { return m_customizedAccessLogTagHasBeenSet; } + + + inline void SetCustomizedAccessLogTag(const Aws::Map<Aws::String, Aws::String>& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = value; } + + + inline void SetCustomizedAccessLogTag(Aws::Map<Aws::String, Aws::String>&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = std::move(value); } + + + inline HeadObjectRequest& WithCustomizedAccessLogTag(const Aws::Map<Aws::String, Aws::String>& value) { SetCustomizedAccessLogTag(value); return *this;} + + + inline HeadObjectRequest& WithCustomizedAccessLogTag(Aws::Map<Aws::String, Aws::String>&& 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; + + Aws::String m_ifMatch; + bool m_ifMatchHasBeenSet; + + Aws::Utils::DateTime m_ifModifiedSince; + bool m_ifModifiedSinceHasBeenSet; + + Aws::String m_ifNoneMatch; + bool m_ifNoneMatchHasBeenSet; + + Aws::Utils::DateTime m_ifUnmodifiedSince; + bool m_ifUnmodifiedSinceHasBeenSet; + + Aws::String m_key; + bool m_keyHasBeenSet; + + Aws::String m_range; + bool m_rangeHasBeenSet; + + Aws::String m_versionId; + bool m_versionIdHasBeenSet; + + Aws::String m_sSECustomerAlgorithm; + bool m_sSECustomerAlgorithmHasBeenSet; + + Aws::String m_sSECustomerKey; + bool m_sSECustomerKeyHasBeenSet; + + Aws::String m_sSECustomerKeyMD5; + bool m_sSECustomerKeyMD5HasBeenSet; + + RequestPayer m_requestPayer; + bool m_requestPayerHasBeenSet; + + int m_partNumber; + bool m_partNumberHasBeenSet; + + Aws::String m_expectedBucketOwner; + bool m_expectedBucketOwnerHasBeenSet; + + Aws::Map<Aws::String, Aws::String> m_customizedAccessLogTag; + bool m_customizedAccessLogTagHasBeenSet; + }; + +} // namespace Model +} // namespace S3 +} // namespace Aws |