HeadObjectRequest.h

 
#pragma once
#include <aws/core/utils/DateTime.h>
#include <aws/core/utils/memory/stl/AWSMap.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/s3/S3Request.h>
#include <aws/s3/S3_EXPORTS.h>
#include <aws/s3/model/ChecksumMode.h>
#include <aws/s3/model/RequestPayer.h>
 
#include <utility>
 
namespace Aws {
namespace Http {
class URI;
}  // namespace Http
namespace S3 {
namespace Model {
 
class HeadObjectRequest : public S3Request {
 public:
  AWS_S3_API HeadObjectRequest() = default;
 
  // 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_S3_API Aws::String SerializePayload() const override;
 
  AWS_S3_API void AddQueryStringParameters(Aws::Http::URI& uri) const override;
 
  AWS_S3_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
 
  AWS_S3_API bool HasEmbeddedError(IOStream& body, const Http::HeaderValueCollection& header) const override;
  AWS_S3_API EndpointParameters GetEndpointContextParams() const override;
 
 
  inline const Aws::String& GetBucket() const { return m_bucket; }
  inline bool BucketHasBeenSet() const { return m_bucketHasBeenSet; }
  template <typename BucketT = Aws::String>
  void SetBucket(BucketT&& value) {
    m_bucketHasBeenSet = true;
    m_bucket = std::forward<BucketT>(value);
  }
  template <typename BucketT = Aws::String>
  HeadObjectRequest& WithBucket(BucketT&& value) {
    SetBucket(std::forward<BucketT>(value));
    return *this;
  }
 
 
  inline const Aws::String& GetIfMatch() const { return m_ifMatch; }
  inline bool IfMatchHasBeenSet() const { return m_ifMatchHasBeenSet; }
  template <typename IfMatchT = Aws::String>
  void SetIfMatch(IfMatchT&& value) {
    m_ifMatchHasBeenSet = true;
    m_ifMatch = std::forward<IfMatchT>(value);
  }
  template <typename IfMatchT = Aws::String>
  HeadObjectRequest& WithIfMatch(IfMatchT&& value) {
    SetIfMatch(std::forward<IfMatchT>(value));
    return *this;
  }
 
 
  inline const Aws::Utils::DateTime& GetIfModifiedSince() const { return m_ifModifiedSince; }
  inline bool IfModifiedSinceHasBeenSet() const { return m_ifModifiedSinceHasBeenSet; }
  template <typename IfModifiedSinceT = Aws::Utils::DateTime>
  void SetIfModifiedSince(IfModifiedSinceT&& value) {
    m_ifModifiedSinceHasBeenSet = true;
    m_ifModifiedSince = std::forward<IfModifiedSinceT>(value);
  }
  template <typename IfModifiedSinceT = Aws::Utils::DateTime>
  HeadObjectRequest& WithIfModifiedSince(IfModifiedSinceT&& value) {
    SetIfModifiedSince(std::forward<IfModifiedSinceT>(value));
    return *this;
  }
 
 
  inline const Aws::String& GetIfNoneMatch() const { return m_ifNoneMatch; }
  inline bool IfNoneMatchHasBeenSet() const { return m_ifNoneMatchHasBeenSet; }
  template <typename IfNoneMatchT = Aws::String>
  void SetIfNoneMatch(IfNoneMatchT&& value) {
    m_ifNoneMatchHasBeenSet = true;
    m_ifNoneMatch = std::forward<IfNoneMatchT>(value);
  }
  template <typename IfNoneMatchT = Aws::String>
  HeadObjectRequest& WithIfNoneMatch(IfNoneMatchT&& value) {
    SetIfNoneMatch(std::forward<IfNoneMatchT>(value));
    return *this;
  }
 
 
  inline const Aws::Utils::DateTime& GetIfUnmodifiedSince() const { return m_ifUnmodifiedSince; }
  inline bool IfUnmodifiedSinceHasBeenSet() const { return m_ifUnmodifiedSinceHasBeenSet; }
  template <typename IfUnmodifiedSinceT = Aws::Utils::DateTime>
  void SetIfUnmodifiedSince(IfUnmodifiedSinceT&& value) {
    m_ifUnmodifiedSinceHasBeenSet = true;
    m_ifUnmodifiedSince = std::forward<IfUnmodifiedSinceT>(value);
  }
  template <typename IfUnmodifiedSinceT = Aws::Utils::DateTime>
  HeadObjectRequest& WithIfUnmodifiedSince(IfUnmodifiedSinceT&& value) {
    SetIfUnmodifiedSince(std::forward<IfUnmodifiedSinceT>(value));
    return *this;
  }
 
 
  inline const Aws::String& GetKey() const { return m_key; }
  inline bool KeyHasBeenSet() const { return m_keyHasBeenSet; }
  template <typename KeyT = Aws::String>
  void SetKey(KeyT&& value) {
    m_keyHasBeenSet = true;
    m_key = std::forward<KeyT>(value);
  }
  template <typename KeyT = Aws::String>
  HeadObjectRequest& WithKey(KeyT&& value) {
    SetKey(std::forward<KeyT>(value));
    return *this;
  }
 
 
  inline const Aws::String& GetRange() const { return m_range; }
  inline bool RangeHasBeenSet() const { return m_rangeHasBeenSet; }
  template <typename RangeT = Aws::String>
  void SetRange(RangeT&& value) {
    m_rangeHasBeenSet = true;
    m_range = std::forward<RangeT>(value);
  }
  template <typename RangeT = Aws::String>
  HeadObjectRequest& WithRange(RangeT&& value) {
    SetRange(std::forward<RangeT>(value));
    return *this;
  }
 
 
  inline const Aws::String& GetResponseCacheControl() const { return m_responseCacheControl; }
  inline bool ResponseCacheControlHasBeenSet() const { return m_responseCacheControlHasBeenSet; }
  template <typename ResponseCacheControlT = Aws::String>
  void SetResponseCacheControl(ResponseCacheControlT&& value) {
    m_responseCacheControlHasBeenSet = true;
    m_responseCacheControl = std::forward<ResponseCacheControlT>(value);
  }
  template <typename ResponseCacheControlT = Aws::String>
  HeadObjectRequest& WithResponseCacheControl(ResponseCacheControlT&& value) {
    SetResponseCacheControl(std::forward<ResponseCacheControlT>(value));
    return *this;
  }
 
 
  inline const Aws::String& GetResponseContentDisposition() const { return m_responseContentDisposition; }
  inline bool ResponseContentDispositionHasBeenSet() const { return m_responseContentDispositionHasBeenSet; }
  template <typename ResponseContentDispositionT = Aws::String>
  void SetResponseContentDisposition(ResponseContentDispositionT&& value) {
    m_responseContentDispositionHasBeenSet = true;
    m_responseContentDisposition = std::forward<ResponseContentDispositionT>(value);
  }
  template <typename ResponseContentDispositionT = Aws::String>
  HeadObjectRequest& WithResponseContentDisposition(ResponseContentDispositionT&& value) {
    SetResponseContentDisposition(std::forward<ResponseContentDispositionT>(value));
    return *this;
  }
 
 
  inline const Aws::String& GetResponseContentEncoding() const { return m_responseContentEncoding; }
  inline bool ResponseContentEncodingHasBeenSet() const { return m_responseContentEncodingHasBeenSet; }
  template <typename ResponseContentEncodingT = Aws::String>
  void SetResponseContentEncoding(ResponseContentEncodingT&& value) {
    m_responseContentEncodingHasBeenSet = true;
    m_responseContentEncoding = std::forward<ResponseContentEncodingT>(value);
  }
  template <typename ResponseContentEncodingT = Aws::String>
  HeadObjectRequest& WithResponseContentEncoding(ResponseContentEncodingT&& value) {
    SetResponseContentEncoding(std::forward<ResponseContentEncodingT>(value));
    return *this;
  }
 
 
  inline const Aws::String& GetResponseContentLanguage() const { return m_responseContentLanguage; }
  inline bool ResponseContentLanguageHasBeenSet() const { return m_responseContentLanguageHasBeenSet; }
  template <typename ResponseContentLanguageT = Aws::String>
  void SetResponseContentLanguage(ResponseContentLanguageT&& value) {
    m_responseContentLanguageHasBeenSet = true;
    m_responseContentLanguage = std::forward<ResponseContentLanguageT>(value);
  }
  template <typename ResponseContentLanguageT = Aws::String>
  HeadObjectRequest& WithResponseContentLanguage(ResponseContentLanguageT&& value) {
    SetResponseContentLanguage(std::forward<ResponseContentLanguageT>(value));
    return *this;
  }
 
 
  inline const Aws::String& GetResponseContentType() const { return m_responseContentType; }
  inline bool ResponseContentTypeHasBeenSet() const { return m_responseContentTypeHasBeenSet; }
  template <typename ResponseContentTypeT = Aws::String>
  void SetResponseContentType(ResponseContentTypeT&& value) {
    m_responseContentTypeHasBeenSet = true;
    m_responseContentType = std::forward<ResponseContentTypeT>(value);
  }
  template <typename ResponseContentTypeT = Aws::String>
  HeadObjectRequest& WithResponseContentType(ResponseContentTypeT&& value) {
    SetResponseContentType(std::forward<ResponseContentTypeT>(value));
    return *this;
  }
 
 
  inline const Aws::Utils::DateTime& GetResponseExpires() const { return m_responseExpires; }
  inline bool ResponseExpiresHasBeenSet() const { return m_responseExpiresHasBeenSet; }
  template <typename ResponseExpiresT = Aws::Utils::DateTime>
  void SetResponseExpires(ResponseExpiresT&& value) {
    m_responseExpiresHasBeenSet = true;
    m_responseExpires = std::forward<ResponseExpiresT>(value);
  }
  template <typename ResponseExpiresT = Aws::Utils::DateTime>
  HeadObjectRequest& WithResponseExpires(ResponseExpiresT&& value) {
    SetResponseExpires(std::forward<ResponseExpiresT>(value));
    return *this;
  }
 
 
  inline const Aws::String& GetVersionId() const { return m_versionId; }
  inline bool VersionIdHasBeenSet() const { return m_versionIdHasBeenSet; }
  template <typename VersionIdT = Aws::String>
  void SetVersionId(VersionIdT&& value) {
    m_versionIdHasBeenSet = true;
    m_versionId = std::forward<VersionIdT>(value);
  }
  template <typename VersionIdT = Aws::String>
  HeadObjectRequest& WithVersionId(VersionIdT&& value) {
    SetVersionId(std::forward<VersionIdT>(value));
    return *this;
  }
 
 
  inline const Aws::String& GetSSECustomerAlgorithm() const { return m_sSECustomerAlgorithm; }
  inline bool SSECustomerAlgorithmHasBeenSet() const { return m_sSECustomerAlgorithmHasBeenSet; }
  template <typename SSECustomerAlgorithmT = Aws::String>
  void SetSSECustomerAlgorithm(SSECustomerAlgorithmT&& value) {
    m_sSECustomerAlgorithmHasBeenSet = true;
    m_sSECustomerAlgorithm = std::forward<SSECustomerAlgorithmT>(value);
  }
  template <typename SSECustomerAlgorithmT = Aws::String>
  HeadObjectRequest& WithSSECustomerAlgorithm(SSECustomerAlgorithmT&& value) {
    SetSSECustomerAlgorithm(std::forward<SSECustomerAlgorithmT>(value));
    return *this;
  }
 
 
  inline const Aws::String& GetSSECustomerKey() const { return m_sSECustomerKey; }
  inline bool SSECustomerKeyHasBeenSet() const { return m_sSECustomerKeyHasBeenSet; }
  template <typename SSECustomerKeyT = Aws::String>
  void SetSSECustomerKey(SSECustomerKeyT&& value) {
    m_sSECustomerKeyHasBeenSet = true;
    m_sSECustomerKey = std::forward<SSECustomerKeyT>(value);
  }
  template <typename SSECustomerKeyT = Aws::String>
  HeadObjectRequest& WithSSECustomerKey(SSECustomerKeyT&& value) {
    SetSSECustomerKey(std::forward<SSECustomerKeyT>(value));
    return *this;
  }
 
 
  inline const Aws::String& GetSSECustomerKeyMD5() const { return m_sSECustomerKeyMD5; }
  inline bool SSECustomerKeyMD5HasBeenSet() const { return m_sSECustomerKeyMD5HasBeenSet; }
  template <typename SSECustomerKeyMD5T = Aws::String>
  void SetSSECustomerKeyMD5(SSECustomerKeyMD5T&& value) {
    m_sSECustomerKeyMD5HasBeenSet = true;
    m_sSECustomerKeyMD5 = std::forward<SSECustomerKeyMD5T>(value);
  }
  template <typename SSECustomerKeyMD5T = Aws::String>
  HeadObjectRequest& WithSSECustomerKeyMD5(SSECustomerKeyMD5T&& value) {
    SetSSECustomerKeyMD5(std::forward<SSECustomerKeyMD5T>(value));
    return *this;
  }
 
 
  inline RequestPayer GetRequestPayer() const { return m_requestPayer; }
  inline bool RequestPayerHasBeenSet() const { return m_requestPayerHasBeenSet; }
  inline void SetRequestPayer(RequestPayer value) {
    m_requestPayerHasBeenSet = true;
    m_requestPayer = value;
  }
  inline HeadObjectRequest& WithRequestPayer(RequestPayer value) {
    SetRequestPayer(value);
    return *this;
  }
 
 
  inline int GetPartNumber() const { return m_partNumber; }
  inline bool PartNumberHasBeenSet() const { return m_partNumberHasBeenSet; }
  inline void SetPartNumber(int value) {
    m_partNumberHasBeenSet = true;
    m_partNumber = value;
  }
  inline HeadObjectRequest& WithPartNumber(int value) {
    SetPartNumber(value);
    return *this;
  }
 
 
  inline const Aws::String& GetExpectedBucketOwner() const { return m_expectedBucketOwner; }
  inline bool ExpectedBucketOwnerHasBeenSet() const { return m_expectedBucketOwnerHasBeenSet; }
  template <typename ExpectedBucketOwnerT = Aws::String>
  void SetExpectedBucketOwner(ExpectedBucketOwnerT&& value) {
    m_expectedBucketOwnerHasBeenSet = true;
    m_expectedBucketOwner = std::forward<ExpectedBucketOwnerT>(value);
  }
  template <typename ExpectedBucketOwnerT = Aws::String>
  HeadObjectRequest& WithExpectedBucketOwner(ExpectedBucketOwnerT&& value) {
    SetExpectedBucketOwner(std::forward<ExpectedBucketOwnerT>(value));
    return *this;
  }
 
 
  inline ChecksumMode GetChecksumMode() const { return m_checksumMode; }
  inline bool ChecksumModeHasBeenSet() const { return m_checksumModeHasBeenSet; }
  inline void SetChecksumMode(ChecksumMode value) {
    m_checksumModeHasBeenSet = true;
    m_checksumMode = value;
  }
  inline HeadObjectRequest& WithChecksumMode(ChecksumMode value) {
    SetChecksumMode(value);
    return *this;
  }
 
 
  inline const Aws::Map<Aws::String, Aws::String>& GetCustomizedAccessLogTag() const { return m_customizedAccessLogTag; }
  inline bool CustomizedAccessLogTagHasBeenSet() const { return m_customizedAccessLogTagHasBeenSet; }
  template <typename CustomizedAccessLogTagT = Aws::Map<Aws::String, Aws::String>>
  void SetCustomizedAccessLogTag(CustomizedAccessLogTagT&& value) {
    m_customizedAccessLogTagHasBeenSet = true;
    m_customizedAccessLogTag = std::forward<CustomizedAccessLogTagT>(value);
  }
  template <typename CustomizedAccessLogTagT = Aws::Map<Aws::String, Aws::String>>
  HeadObjectRequest& WithCustomizedAccessLogTag(CustomizedAccessLogTagT&& value) {
    SetCustomizedAccessLogTag(std::forward<CustomizedAccessLogTagT>(value));
    return *this;
  }
  template <typename CustomizedAccessLogTagKeyT = Aws::String, typename CustomizedAccessLogTagValueT = Aws::String>
  HeadObjectRequest& AddCustomizedAccessLogTag(CustomizedAccessLogTagKeyT&& key, CustomizedAccessLogTagValueT&& value) {
    m_customizedAccessLogTagHasBeenSet = true;
    m_customizedAccessLogTag.emplace(std::forward<CustomizedAccessLogTagKeyT>(key), std::forward<CustomizedAccessLogTagValueT>(value));
    return *this;
  }
 private:
  Aws::String m_bucket;
 
  Aws::String m_ifMatch;
 
  Aws::Utils::DateTime m_ifModifiedSince{};
 
  Aws::String m_ifNoneMatch;
 
  Aws::Utils::DateTime m_ifUnmodifiedSince{};
 
  Aws::String m_key;
 
  Aws::String m_range;
 
  Aws::String m_responseCacheControl;
 
  Aws::String m_responseContentDisposition;
 
  Aws::String m_responseContentEncoding;
 
  Aws::String m_responseContentLanguage;
 
  Aws::String m_responseContentType;
 
  Aws::Utils::DateTime m_responseExpires{};
 
  Aws::String m_versionId;
 
  Aws::String m_sSECustomerAlgorithm;
 
  Aws::String m_sSECustomerKey;
 
  Aws::String m_sSECustomerKeyMD5;
 
  RequestPayer m_requestPayer{RequestPayer::NOT_SET};
 
  int m_partNumber{0};
 
  Aws::String m_expectedBucketOwner;
 
  ChecksumMode m_checksumMode{ChecksumMode::NOT_SET};
 
  Aws::Map<Aws::String, Aws::String> m_customizedAccessLogTag;
  bool m_bucketHasBeenSet = false;
  bool m_ifMatchHasBeenSet = false;
  bool m_ifModifiedSinceHasBeenSet = false;
  bool m_ifNoneMatchHasBeenSet = false;
  bool m_ifUnmodifiedSinceHasBeenSet = false;
  bool m_keyHasBeenSet = false;
  bool m_rangeHasBeenSet = false;
  bool m_responseCacheControlHasBeenSet = false;
  bool m_responseContentDispositionHasBeenSet = false;
  bool m_responseContentEncodingHasBeenSet = false;
  bool m_responseContentLanguageHasBeenSet = false;
  bool m_responseContentTypeHasBeenSet = false;
  bool m_responseExpiresHasBeenSet = false;
  bool m_versionIdHasBeenSet = false;
  bool m_sSECustomerAlgorithmHasBeenSet = false;
  bool m_sSECustomerKeyHasBeenSet = false;
  bool m_sSECustomerKeyMD5HasBeenSet = false;
  bool m_requestPayerHasBeenSet = false;
  bool m_partNumberHasBeenSet = false;
  bool m_expectedBucketOwnerHasBeenSet = false;
  bool m_checksumModeHasBeenSet = false;
  bool m_customizedAccessLogTagHasBeenSet = false;
};
 
}  // namespace Model
}  // namespace S3
}  // namespace Aws