AWS SDK for C++  1.9.161
AWS SDK for C++
Public Member Functions | List of all members
Aws::S3Crt::Model::HeadObjectRequest Class Reference

#include <HeadObjectRequest.h>

+ Inheritance diagram for Aws::S3Crt::Model::HeadObjectRequest:

Public Member Functions

 HeadObjectRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
void AddQueryStringParameters (Aws::Http::URI &uri) const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetBucket () const
 
bool BucketHasBeenSet () const
 
void SetBucket (const Aws::String &value)
 
void SetBucket (Aws::String &&value)
 
void SetBucket (const char *value)
 
HeadObjectRequestWithBucket (const Aws::String &value)
 
HeadObjectRequestWithBucket (Aws::String &&value)
 
HeadObjectRequestWithBucket (const char *value)
 
const Aws::StringGetIfMatch () const
 
bool IfMatchHasBeenSet () const
 
void SetIfMatch (const Aws::String &value)
 
void SetIfMatch (Aws::String &&value)
 
void SetIfMatch (const char *value)
 
HeadObjectRequestWithIfMatch (const Aws::String &value)
 
HeadObjectRequestWithIfMatch (Aws::String &&value)
 
HeadObjectRequestWithIfMatch (const char *value)
 
const Aws::Utils::DateTimeGetIfModifiedSince () const
 
bool IfModifiedSinceHasBeenSet () const
 
void SetIfModifiedSince (const Aws::Utils::DateTime &value)
 
void SetIfModifiedSince (Aws::Utils::DateTime &&value)
 
HeadObjectRequestWithIfModifiedSince (const Aws::Utils::DateTime &value)
 
HeadObjectRequestWithIfModifiedSince (Aws::Utils::DateTime &&value)
 
const Aws::StringGetIfNoneMatch () const
 
bool IfNoneMatchHasBeenSet () const
 
void SetIfNoneMatch (const Aws::String &value)
 
void SetIfNoneMatch (Aws::String &&value)
 
void SetIfNoneMatch (const char *value)
 
HeadObjectRequestWithIfNoneMatch (const Aws::String &value)
 
HeadObjectRequestWithIfNoneMatch (Aws::String &&value)
 
HeadObjectRequestWithIfNoneMatch (const char *value)
 
const Aws::Utils::DateTimeGetIfUnmodifiedSince () const
 
bool IfUnmodifiedSinceHasBeenSet () const
 
void SetIfUnmodifiedSince (const Aws::Utils::DateTime &value)
 
void SetIfUnmodifiedSince (Aws::Utils::DateTime &&value)
 
HeadObjectRequestWithIfUnmodifiedSince (const Aws::Utils::DateTime &value)
 
HeadObjectRequestWithIfUnmodifiedSince (Aws::Utils::DateTime &&value)
 
const Aws::StringGetKey () const
 
bool KeyHasBeenSet () const
 
void SetKey (const Aws::String &value)
 
void SetKey (Aws::String &&value)
 
void SetKey (const char *value)
 
HeadObjectRequestWithKey (const Aws::String &value)
 
HeadObjectRequestWithKey (Aws::String &&value)
 
HeadObjectRequestWithKey (const char *value)
 
const Aws::StringGetRange () const
 
bool RangeHasBeenSet () const
 
void SetRange (const Aws::String &value)
 
void SetRange (Aws::String &&value)
 
void SetRange (const char *value)
 
HeadObjectRequestWithRange (const Aws::String &value)
 
HeadObjectRequestWithRange (Aws::String &&value)
 
HeadObjectRequestWithRange (const char *value)
 
const Aws::StringGetVersionId () const
 
bool VersionIdHasBeenSet () const
 
void SetVersionId (const Aws::String &value)
 
void SetVersionId (Aws::String &&value)
 
void SetVersionId (const char *value)
 
HeadObjectRequestWithVersionId (const Aws::String &value)
 
HeadObjectRequestWithVersionId (Aws::String &&value)
 
HeadObjectRequestWithVersionId (const char *value)
 
const Aws::StringGetSSECustomerAlgorithm () const
 
bool SSECustomerAlgorithmHasBeenSet () const
 
void SetSSECustomerAlgorithm (const Aws::String &value)
 
void SetSSECustomerAlgorithm (Aws::String &&value)
 
void SetSSECustomerAlgorithm (const char *value)
 
HeadObjectRequestWithSSECustomerAlgorithm (const Aws::String &value)
 
HeadObjectRequestWithSSECustomerAlgorithm (Aws::String &&value)
 
HeadObjectRequestWithSSECustomerAlgorithm (const char *value)
 
const Aws::StringGetSSECustomerKey () const
 
bool SSECustomerKeyHasBeenSet () const
 
void SetSSECustomerKey (const Aws::String &value)
 
void SetSSECustomerKey (Aws::String &&value)
 
void SetSSECustomerKey (const char *value)
 
HeadObjectRequestWithSSECustomerKey (const Aws::String &value)
 
HeadObjectRequestWithSSECustomerKey (Aws::String &&value)
 
HeadObjectRequestWithSSECustomerKey (const char *value)
 
const Aws::StringGetSSECustomerKeyMD5 () const
 
bool SSECustomerKeyMD5HasBeenSet () const
 
void SetSSECustomerKeyMD5 (const Aws::String &value)
 
void SetSSECustomerKeyMD5 (Aws::String &&value)
 
void SetSSECustomerKeyMD5 (const char *value)
 
HeadObjectRequestWithSSECustomerKeyMD5 (const Aws::String &value)
 
HeadObjectRequestWithSSECustomerKeyMD5 (Aws::String &&value)
 
HeadObjectRequestWithSSECustomerKeyMD5 (const char *value)
 
const RequestPayerGetRequestPayer () const
 
bool RequestPayerHasBeenSet () const
 
void SetRequestPayer (const RequestPayer &value)
 
void SetRequestPayer (RequestPayer &&value)
 
HeadObjectRequestWithRequestPayer (const RequestPayer &value)
 
HeadObjectRequestWithRequestPayer (RequestPayer &&value)
 
int GetPartNumber () const
 
bool PartNumberHasBeenSet () const
 
void SetPartNumber (int value)
 
HeadObjectRequestWithPartNumber (int value)
 
const Aws::StringGetExpectedBucketOwner () const
 
bool ExpectedBucketOwnerHasBeenSet () const
 
void SetExpectedBucketOwner (const Aws::String &value)
 
void SetExpectedBucketOwner (Aws::String &&value)
 
void SetExpectedBucketOwner (const char *value)
 
HeadObjectRequestWithExpectedBucketOwner (const Aws::String &value)
 
HeadObjectRequestWithExpectedBucketOwner (Aws::String &&value)
 
HeadObjectRequestWithExpectedBucketOwner (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetCustomizedAccessLogTag () const
 
bool CustomizedAccessLogTagHasBeenSet () const
 
void SetCustomizedAccessLogTag (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetCustomizedAccessLogTag (Aws::Map< Aws::String, Aws::String > &&value)
 
HeadObjectRequestWithCustomizedAccessLogTag (const Aws::Map< Aws::String, Aws::String > &value)
 
HeadObjectRequestWithCustomizedAccessLogTag (Aws::Map< Aws::String, Aws::String > &&value)
 
HeadObjectRequestAddCustomizedAccessLogTag (const Aws::String &key, const Aws::String &value)
 
HeadObjectRequestAddCustomizedAccessLogTag (Aws::String &&key, const Aws::String &value)
 
HeadObjectRequestAddCustomizedAccessLogTag (const Aws::String &key, Aws::String &&value)
 
HeadObjectRequestAddCustomizedAccessLogTag (Aws::String &&key, Aws::String &&value)
 
HeadObjectRequestAddCustomizedAccessLogTag (const char *key, Aws::String &&value)
 
HeadObjectRequestAddCustomizedAccessLogTag (Aws::String &&key, const char *value)
 
HeadObjectRequestAddCustomizedAccessLogTag (const char *key, const char *value)
 
- Public Member Functions inherited from Aws::S3Crt::S3CrtRequest
virtual ~S3CrtRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 28 of file HeadObjectRequest.h.

Constructor & Destructor Documentation

◆ HeadObjectRequest()

Aws::S3Crt::Model::HeadObjectRequest::HeadObjectRequest ( )

Member Function Documentation

◆ AddCustomizedAccessLogTag() [1/7]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::AddCustomizedAccessLogTag ( Aws::String &&  key,
Aws::String &&  value 
)
inline

Definition at line 858 of file HeadObjectRequest.h.

◆ AddCustomizedAccessLogTag() [2/7]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::AddCustomizedAccessLogTag ( Aws::String &&  key,
const Aws::String value 
)
inline

Definition at line 852 of file HeadObjectRequest.h.

◆ AddCustomizedAccessLogTag() [3/7]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::AddCustomizedAccessLogTag ( Aws::String &&  key,
const char *  value 
)
inline

Definition at line 864 of file HeadObjectRequest.h.

◆ AddCustomizedAccessLogTag() [4/7]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::AddCustomizedAccessLogTag ( const Aws::String key,
Aws::String &&  value 
)
inline

Definition at line 855 of file HeadObjectRequest.h.

◆ AddCustomizedAccessLogTag() [5/7]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::AddCustomizedAccessLogTag ( const Aws::String key,
const Aws::String value 
)
inline

Definition at line 849 of file HeadObjectRequest.h.

◆ AddCustomizedAccessLogTag() [6/7]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::AddCustomizedAccessLogTag ( const char *  key,
Aws::String &&  value 
)
inline

Definition at line 861 of file HeadObjectRequest.h.

◆ AddCustomizedAccessLogTag() [7/7]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::AddCustomizedAccessLogTag ( const char *  key,
const char *  value 
)
inline

Definition at line 867 of file HeadObjectRequest.h.

◆ AddQueryStringParameters()

void Aws::S3Crt::Model::HeadObjectRequest::AddQueryStringParameters ( Aws::Http::URI uri) const
overridevirtual

Do nothing virtual, override this to add query strings to the request

Reimplemented from Aws::AmazonWebServiceRequest.

◆ BucketHasBeenSet()

bool Aws::S3Crt::Model::HeadObjectRequest::BucketHasBeenSet ( ) const
inline

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 using 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 using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

Definition at line 86 of file HeadObjectRequest.h.

◆ CustomizedAccessLogTagHasBeenSet()

bool Aws::S3Crt::Model::HeadObjectRequest::CustomizedAccessLogTagHasBeenSet ( ) const
inline

Definition at line 834 of file HeadObjectRequest.h.

◆ ExpectedBucketOwnerHasBeenSet()

bool Aws::S3Crt::Model::HeadObjectRequest::ExpectedBucketOwnerHasBeenSet ( ) const
inline

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 785 of file HeadObjectRequest.h.

◆ GetBucket()

const Aws::String& Aws::S3Crt::Model::HeadObjectRequest::GetBucket ( ) const
inline

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 using 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 using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

Definition at line 65 of file HeadObjectRequest.h.

◆ GetCustomizedAccessLogTag()

const Aws::Map<Aws::String, Aws::String>& Aws::S3Crt::Model::HeadObjectRequest::GetCustomizedAccessLogTag ( ) const
inline

Definition at line 831 of file HeadObjectRequest.h.

◆ GetExpectedBucketOwner()

const Aws::String& Aws::S3Crt::Model::HeadObjectRequest::GetExpectedBucketOwner ( ) const
inline

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 778 of file HeadObjectRequest.h.

◆ GetIfMatch()

const Aws::String& Aws::S3Crt::Model::HeadObjectRequest::GetIfMatch ( ) const
inline

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

Definition at line 219 of file HeadObjectRequest.h.

◆ GetIfModifiedSince()

const Aws::Utils::DateTime& Aws::S3Crt::Model::HeadObjectRequest::GetIfModifiedSince ( ) const
inline

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

Definition at line 268 of file HeadObjectRequest.h.

◆ GetIfNoneMatch()

const Aws::String& Aws::S3Crt::Model::HeadObjectRequest::GetIfNoneMatch ( ) const
inline

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

Definition at line 305 of file HeadObjectRequest.h.

◆ GetIfUnmodifiedSince()

const Aws::Utils::DateTime& Aws::S3Crt::Model::HeadObjectRequest::GetIfUnmodifiedSince ( ) const
inline

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

Definition at line 354 of file HeadObjectRequest.h.

◆ GetKey()

const Aws::String& Aws::S3Crt::Model::HeadObjectRequest::GetKey ( ) const
inline

The object key.

Definition at line 390 of file HeadObjectRequest.h.

◆ GetPartNumber()

int Aws::S3Crt::Model::HeadObjectRequest::GetPartNumber ( ) const
inline

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.

Definition at line 746 of file HeadObjectRequest.h.

◆ GetRange()

const Aws::String& Aws::S3Crt::Model::HeadObjectRequest::GetRange ( ) const
inline

Downloads the specified range bytes of an object. For more information about the HTTP Range header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

Amazon S3 doesn't support retrieving multiple ranges of data per GET request.

Definition at line 435 of file HeadObjectRequest.h.

◆ GetRequestPayer()

const RequestPayer& Aws::S3Crt::Model::HeadObjectRequest::GetRequestPayer ( ) const
inline

Definition at line 722 of file HeadObjectRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::S3Crt::Model::HeadObjectRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::S3Crt::S3CrtRequest.

◆ GetServiceRequestName()

virtual const char* Aws::S3Crt::Model::HeadObjectRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file HeadObjectRequest.h.

◆ GetSSECustomerAlgorithm()

const Aws::String& Aws::S3Crt::Model::HeadObjectRequest::GetSSECustomerAlgorithm ( ) const
inline

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

Definition at line 546 of file HeadObjectRequest.h.

◆ GetSSECustomerKey()

const Aws::String& Aws::S3Crt::Model::HeadObjectRequest::GetSSECustomerKey ( ) const
inline

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.

Definition at line 598 of file HeadObjectRequest.h.

◆ GetSSECustomerKeyMD5()

const Aws::String& Aws::S3Crt::Model::HeadObjectRequest::GetSSECustomerKeyMD5 ( ) const
inline

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.

Definition at line 669 of file HeadObjectRequest.h.

◆ GetVersionId()

const Aws::String& Aws::S3Crt::Model::HeadObjectRequest::GetVersionId ( ) const
inline

VersionId used to reference a specific version of the object.

Definition at line 504 of file HeadObjectRequest.h.

◆ IfMatchHasBeenSet()

bool Aws::S3Crt::Model::HeadObjectRequest::IfMatchHasBeenSet ( ) const
inline

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

Definition at line 225 of file HeadObjectRequest.h.

◆ IfModifiedSinceHasBeenSet()

bool Aws::S3Crt::Model::HeadObjectRequest::IfModifiedSinceHasBeenSet ( ) const
inline

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

Definition at line 274 of file HeadObjectRequest.h.

◆ IfNoneMatchHasBeenSet()

bool Aws::S3Crt::Model::HeadObjectRequest::IfNoneMatchHasBeenSet ( ) const
inline

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

Definition at line 311 of file HeadObjectRequest.h.

◆ IfUnmodifiedSinceHasBeenSet()

bool Aws::S3Crt::Model::HeadObjectRequest::IfUnmodifiedSinceHasBeenSet ( ) const
inline

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

Definition at line 360 of file HeadObjectRequest.h.

◆ KeyHasBeenSet()

bool Aws::S3Crt::Model::HeadObjectRequest::KeyHasBeenSet ( ) const
inline

The object key.

Definition at line 395 of file HeadObjectRequest.h.

◆ PartNumberHasBeenSet()

bool Aws::S3Crt::Model::HeadObjectRequest::PartNumberHasBeenSet ( ) const
inline

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.

Definition at line 754 of file HeadObjectRequest.h.

◆ RangeHasBeenSet()

bool Aws::S3Crt::Model::HeadObjectRequest::RangeHasBeenSet ( ) const
inline

Downloads the specified range bytes of an object. For more information about the HTTP Range header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

Amazon S3 doesn't support retrieving multiple ranges of data per GET request.

Definition at line 444 of file HeadObjectRequest.h.

◆ RequestPayerHasBeenSet()

bool Aws::S3Crt::Model::HeadObjectRequest::RequestPayerHasBeenSet ( ) const
inline

Definition at line 725 of file HeadObjectRequest.h.

◆ SerializePayload()

Aws::String Aws::S3Crt::Model::HeadObjectRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetBucket() [1/3]

void Aws::S3Crt::Model::HeadObjectRequest::SetBucket ( Aws::String &&  value)
inline

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 using 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 using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

Definition at line 128 of file HeadObjectRequest.h.

◆ SetBucket() [2/3]

void Aws::S3Crt::Model::HeadObjectRequest::SetBucket ( const Aws::String value)
inline

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 using 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 using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

Definition at line 107 of file HeadObjectRequest.h.

◆ SetBucket() [3/3]

void Aws::S3Crt::Model::HeadObjectRequest::SetBucket ( const char *  value)
inline

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 using 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 using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

Definition at line 149 of file HeadObjectRequest.h.

◆ SetCustomizedAccessLogTag() [1/2]

void Aws::S3Crt::Model::HeadObjectRequest::SetCustomizedAccessLogTag ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Definition at line 840 of file HeadObjectRequest.h.

◆ SetCustomizedAccessLogTag() [2/2]

void Aws::S3Crt::Model::HeadObjectRequest::SetCustomizedAccessLogTag ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

Definition at line 837 of file HeadObjectRequest.h.

◆ SetExpectedBucketOwner() [1/3]

void Aws::S3Crt::Model::HeadObjectRequest::SetExpectedBucketOwner ( Aws::String &&  value)
inline

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 799 of file HeadObjectRequest.h.

◆ SetExpectedBucketOwner() [2/3]

void Aws::S3Crt::Model::HeadObjectRequest::SetExpectedBucketOwner ( const Aws::String value)
inline

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 792 of file HeadObjectRequest.h.

◆ SetExpectedBucketOwner() [3/3]

void Aws::S3Crt::Model::HeadObjectRequest::SetExpectedBucketOwner ( const char *  value)
inline

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 806 of file HeadObjectRequest.h.

◆ SetIfMatch() [1/3]

void Aws::S3Crt::Model::HeadObjectRequest::SetIfMatch ( Aws::String &&  value)
inline

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

Definition at line 237 of file HeadObjectRequest.h.

◆ SetIfMatch() [2/3]

void Aws::S3Crt::Model::HeadObjectRequest::SetIfMatch ( const Aws::String value)
inline

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

Definition at line 231 of file HeadObjectRequest.h.

◆ SetIfMatch() [3/3]

void Aws::S3Crt::Model::HeadObjectRequest::SetIfMatch ( const char *  value)
inline

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

Definition at line 243 of file HeadObjectRequest.h.

◆ SetIfModifiedSince() [1/2]

void Aws::S3Crt::Model::HeadObjectRequest::SetIfModifiedSince ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 286 of file HeadObjectRequest.h.

◆ SetIfModifiedSince() [2/2]

void Aws::S3Crt::Model::HeadObjectRequest::SetIfModifiedSince ( const Aws::Utils::DateTime value)
inline

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

Definition at line 280 of file HeadObjectRequest.h.

◆ SetIfNoneMatch() [1/3]

void Aws::S3Crt::Model::HeadObjectRequest::SetIfNoneMatch ( Aws::String &&  value)
inline

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

Definition at line 323 of file HeadObjectRequest.h.

◆ SetIfNoneMatch() [2/3]

void Aws::S3Crt::Model::HeadObjectRequest::SetIfNoneMatch ( const Aws::String value)
inline

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

Definition at line 317 of file HeadObjectRequest.h.

◆ SetIfNoneMatch() [3/3]

void Aws::S3Crt::Model::HeadObjectRequest::SetIfNoneMatch ( const char *  value)
inline

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

Definition at line 329 of file HeadObjectRequest.h.

◆ SetIfUnmodifiedSince() [1/2]

void Aws::S3Crt::Model::HeadObjectRequest::SetIfUnmodifiedSince ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 372 of file HeadObjectRequest.h.

◆ SetIfUnmodifiedSince() [2/2]

void Aws::S3Crt::Model::HeadObjectRequest::SetIfUnmodifiedSince ( const Aws::Utils::DateTime value)
inline

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

Definition at line 366 of file HeadObjectRequest.h.

◆ SetKey() [1/3]

void Aws::S3Crt::Model::HeadObjectRequest::SetKey ( Aws::String &&  value)
inline

The object key.

Definition at line 405 of file HeadObjectRequest.h.

◆ SetKey() [2/3]

void Aws::S3Crt::Model::HeadObjectRequest::SetKey ( const Aws::String value)
inline

The object key.

Definition at line 400 of file HeadObjectRequest.h.

◆ SetKey() [3/3]

void Aws::S3Crt::Model::HeadObjectRequest::SetKey ( const char *  value)
inline

The object key.

Definition at line 410 of file HeadObjectRequest.h.

◆ SetPartNumber()

void Aws::S3Crt::Model::HeadObjectRequest::SetPartNumber ( int  value)
inline

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.

Definition at line 762 of file HeadObjectRequest.h.

◆ SetRange() [1/3]

void Aws::S3Crt::Model::HeadObjectRequest::SetRange ( Aws::String &&  value)
inline

Downloads the specified range bytes of an object. For more information about the HTTP Range header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

Amazon S3 doesn't support retrieving multiple ranges of data per GET request.

Definition at line 462 of file HeadObjectRequest.h.

◆ SetRange() [2/3]

void Aws::S3Crt::Model::HeadObjectRequest::SetRange ( const Aws::String value)
inline

Downloads the specified range bytes of an object. For more information about the HTTP Range header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

Amazon S3 doesn't support retrieving multiple ranges of data per GET request.

Definition at line 453 of file HeadObjectRequest.h.

◆ SetRange() [3/3]

void Aws::S3Crt::Model::HeadObjectRequest::SetRange ( const char *  value)
inline

Downloads the specified range bytes of an object. For more information about the HTTP Range header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

Amazon S3 doesn't support retrieving multiple ranges of data per GET request.

Definition at line 471 of file HeadObjectRequest.h.

◆ SetRequestPayer() [1/2]

void Aws::S3Crt::Model::HeadObjectRequest::SetRequestPayer ( const RequestPayer value)
inline

Definition at line 728 of file HeadObjectRequest.h.

◆ SetRequestPayer() [2/2]

void Aws::S3Crt::Model::HeadObjectRequest::SetRequestPayer ( RequestPayer &&  value)
inline

Definition at line 731 of file HeadObjectRequest.h.

◆ SetSSECustomerAlgorithm() [1/3]

void Aws::S3Crt::Model::HeadObjectRequest::SetSSECustomerAlgorithm ( Aws::String &&  value)
inline

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

Definition at line 564 of file HeadObjectRequest.h.

◆ SetSSECustomerAlgorithm() [2/3]

void Aws::S3Crt::Model::HeadObjectRequest::SetSSECustomerAlgorithm ( const Aws::String value)
inline

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

Definition at line 558 of file HeadObjectRequest.h.

◆ SetSSECustomerAlgorithm() [3/3]

void Aws::S3Crt::Model::HeadObjectRequest::SetSSECustomerAlgorithm ( const char *  value)
inline

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

Definition at line 570 of file HeadObjectRequest.h.

◆ SetSSECustomerKey() [1/3]

void Aws::S3Crt::Model::HeadObjectRequest::SetSSECustomerKey ( Aws::String &&  value)
inline

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.

Definition at line 625 of file HeadObjectRequest.h.

◆ SetSSECustomerKey() [2/3]

void Aws::S3Crt::Model::HeadObjectRequest::SetSSECustomerKey ( const Aws::String value)
inline

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.

Definition at line 616 of file HeadObjectRequest.h.

◆ SetSSECustomerKey() [3/3]

void Aws::S3Crt::Model::HeadObjectRequest::SetSSECustomerKey ( const char *  value)
inline

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.

Definition at line 634 of file HeadObjectRequest.h.

◆ SetSSECustomerKeyMD5() [1/3]

void Aws::S3Crt::Model::HeadObjectRequest::SetSSECustomerKeyMD5 ( Aws::String &&  value)
inline

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.

Definition at line 690 of file HeadObjectRequest.h.

◆ SetSSECustomerKeyMD5() [2/3]

void Aws::S3Crt::Model::HeadObjectRequest::SetSSECustomerKeyMD5 ( const Aws::String value)
inline

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.

Definition at line 683 of file HeadObjectRequest.h.

◆ SetSSECustomerKeyMD5() [3/3]

void Aws::S3Crt::Model::HeadObjectRequest::SetSSECustomerKeyMD5 ( const char *  value)
inline

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.

Definition at line 697 of file HeadObjectRequest.h.

◆ SetVersionId() [1/3]

void Aws::S3Crt::Model::HeadObjectRequest::SetVersionId ( Aws::String &&  value)
inline

VersionId used to reference a specific version of the object.

Definition at line 519 of file HeadObjectRequest.h.

◆ SetVersionId() [2/3]

void Aws::S3Crt::Model::HeadObjectRequest::SetVersionId ( const Aws::String value)
inline

VersionId used to reference a specific version of the object.

Definition at line 514 of file HeadObjectRequest.h.

◆ SetVersionId() [3/3]

void Aws::S3Crt::Model::HeadObjectRequest::SetVersionId ( const char *  value)
inline

VersionId used to reference a specific version of the object.

Definition at line 524 of file HeadObjectRequest.h.

◆ SSECustomerAlgorithmHasBeenSet()

bool Aws::S3Crt::Model::HeadObjectRequest::SSECustomerAlgorithmHasBeenSet ( ) const
inline

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

Definition at line 552 of file HeadObjectRequest.h.

◆ SSECustomerKeyHasBeenSet()

bool Aws::S3Crt::Model::HeadObjectRequest::SSECustomerKeyHasBeenSet ( ) const
inline

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.

Definition at line 607 of file HeadObjectRequest.h.

◆ SSECustomerKeyMD5HasBeenSet()

bool Aws::S3Crt::Model::HeadObjectRequest::SSECustomerKeyMD5HasBeenSet ( ) const
inline

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.

Definition at line 676 of file HeadObjectRequest.h.

◆ VersionIdHasBeenSet()

bool Aws::S3Crt::Model::HeadObjectRequest::VersionIdHasBeenSet ( ) const
inline

VersionId used to reference a specific version of the object.

Definition at line 509 of file HeadObjectRequest.h.

◆ WithBucket() [1/3]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::WithBucket ( Aws::String &&  value)
inline

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 using 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 using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

Definition at line 191 of file HeadObjectRequest.h.

◆ WithBucket() [2/3]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::WithBucket ( const Aws::String value)
inline

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 using 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 using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

Definition at line 170 of file HeadObjectRequest.h.

◆ WithBucket() [3/3]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::WithBucket ( const char *  value)
inline

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 using 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 using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

Definition at line 212 of file HeadObjectRequest.h.

◆ WithCustomizedAccessLogTag() [1/2]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::WithCustomizedAccessLogTag ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Definition at line 846 of file HeadObjectRequest.h.

◆ WithCustomizedAccessLogTag() [2/2]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::WithCustomizedAccessLogTag ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

Definition at line 843 of file HeadObjectRequest.h.

◆ WithExpectedBucketOwner() [1/3]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::WithExpectedBucketOwner ( Aws::String &&  value)
inline

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 820 of file HeadObjectRequest.h.

◆ WithExpectedBucketOwner() [2/3]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::WithExpectedBucketOwner ( const Aws::String value)
inline

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 813 of file HeadObjectRequest.h.

◆ WithExpectedBucketOwner() [3/3]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::WithExpectedBucketOwner ( const char *  value)
inline

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 827 of file HeadObjectRequest.h.

◆ WithIfMatch() [1/3]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::WithIfMatch ( Aws::String &&  value)
inline

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

Definition at line 255 of file HeadObjectRequest.h.

◆ WithIfMatch() [2/3]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::WithIfMatch ( const Aws::String value)
inline

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

Definition at line 249 of file HeadObjectRequest.h.

◆ WithIfMatch() [3/3]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::WithIfMatch ( const char *  value)
inline

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

Definition at line 261 of file HeadObjectRequest.h.

◆ WithIfModifiedSince() [1/2]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::WithIfModifiedSince ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 298 of file HeadObjectRequest.h.

◆ WithIfModifiedSince() [2/2]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::WithIfModifiedSince ( const Aws::Utils::DateTime value)
inline

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

Definition at line 292 of file HeadObjectRequest.h.

◆ WithIfNoneMatch() [1/3]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::WithIfNoneMatch ( Aws::String &&  value)
inline

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

Definition at line 341 of file HeadObjectRequest.h.

◆ WithIfNoneMatch() [2/3]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::WithIfNoneMatch ( const Aws::String value)
inline

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

Definition at line 335 of file HeadObjectRequest.h.

◆ WithIfNoneMatch() [3/3]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::WithIfNoneMatch ( const char *  value)
inline

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

Definition at line 347 of file HeadObjectRequest.h.

◆ WithIfUnmodifiedSince() [1/2]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::WithIfUnmodifiedSince ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 384 of file HeadObjectRequest.h.

◆ WithIfUnmodifiedSince() [2/2]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::WithIfUnmodifiedSince ( const Aws::Utils::DateTime value)
inline

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

Definition at line 378 of file HeadObjectRequest.h.

◆ WithKey() [1/3]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::WithKey ( Aws::String &&  value)
inline

The object key.

Definition at line 420 of file HeadObjectRequest.h.

◆ WithKey() [2/3]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::WithKey ( const Aws::String value)
inline

The object key.

Definition at line 415 of file HeadObjectRequest.h.

◆ WithKey() [3/3]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::WithKey ( const char *  value)
inline

The object key.

Definition at line 425 of file HeadObjectRequest.h.

◆ WithPartNumber()

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::WithPartNumber ( int  value)
inline

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.

Definition at line 770 of file HeadObjectRequest.h.

◆ WithRange() [1/3]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::WithRange ( Aws::String &&  value)
inline

Downloads the specified range bytes of an object. For more information about the HTTP Range header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

Amazon S3 doesn't support retrieving multiple ranges of data per GET request.

Definition at line 489 of file HeadObjectRequest.h.

◆ WithRange() [2/3]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::WithRange ( const Aws::String value)
inline

Downloads the specified range bytes of an object. For more information about the HTTP Range header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

Amazon S3 doesn't support retrieving multiple ranges of data per GET request.

Definition at line 480 of file HeadObjectRequest.h.

◆ WithRange() [3/3]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::WithRange ( const char *  value)
inline

Downloads the specified range bytes of an object. For more information about the HTTP Range header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

Amazon S3 doesn't support retrieving multiple ranges of data per GET request.

Definition at line 498 of file HeadObjectRequest.h.

◆ WithRequestPayer() [1/2]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::WithRequestPayer ( const RequestPayer value)
inline

Definition at line 734 of file HeadObjectRequest.h.

◆ WithRequestPayer() [2/2]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::WithRequestPayer ( RequestPayer &&  value)
inline

Definition at line 737 of file HeadObjectRequest.h.

◆ WithSSECustomerAlgorithm() [1/3]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::WithSSECustomerAlgorithm ( Aws::String &&  value)
inline

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

Definition at line 582 of file HeadObjectRequest.h.

◆ WithSSECustomerAlgorithm() [2/3]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::WithSSECustomerAlgorithm ( const Aws::String value)
inline

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

Definition at line 576 of file HeadObjectRequest.h.

◆ WithSSECustomerAlgorithm() [3/3]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::WithSSECustomerAlgorithm ( const char *  value)
inline

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

Definition at line 588 of file HeadObjectRequest.h.

◆ WithSSECustomerKey() [1/3]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::WithSSECustomerKey ( Aws::String &&  value)
inline

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.

Definition at line 652 of file HeadObjectRequest.h.

◆ WithSSECustomerKey() [2/3]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::WithSSECustomerKey ( const Aws::String value)
inline

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.

Definition at line 643 of file HeadObjectRequest.h.

◆ WithSSECustomerKey() [3/3]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::WithSSECustomerKey ( const char *  value)
inline

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.

Definition at line 661 of file HeadObjectRequest.h.

◆ WithSSECustomerKeyMD5() [1/3]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::WithSSECustomerKeyMD5 ( Aws::String &&  value)
inline

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.

Definition at line 711 of file HeadObjectRequest.h.

◆ WithSSECustomerKeyMD5() [2/3]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::WithSSECustomerKeyMD5 ( const Aws::String value)
inline

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.

Definition at line 704 of file HeadObjectRequest.h.

◆ WithSSECustomerKeyMD5() [3/3]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::WithSSECustomerKeyMD5 ( const char *  value)
inline

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.

Definition at line 718 of file HeadObjectRequest.h.

◆ WithVersionId() [1/3]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::WithVersionId ( Aws::String &&  value)
inline

VersionId used to reference a specific version of the object.

Definition at line 534 of file HeadObjectRequest.h.

◆ WithVersionId() [2/3]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::WithVersionId ( const Aws::String value)
inline

VersionId used to reference a specific version of the object.

Definition at line 529 of file HeadObjectRequest.h.

◆ WithVersionId() [3/3]

HeadObjectRequest& Aws::S3Crt::Model::HeadObjectRequest::WithVersionId ( const char *  value)
inline

VersionId used to reference a specific version of the object.

Definition at line 539 of file HeadObjectRequest.h.


The documentation for this class was generated from the following file: