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

#include <HeadObjectRequest.h>

+ Inheritance diagram for Aws::S3::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::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::S3::S3Request
virtual ~S3Request ()
 
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::S3::Model::HeadObjectRequest::HeadObjectRequest ( )

Member Function Documentation

◆ AddCustomizedAccessLogTag() [1/7]

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

Definition at line 664 of file HeadObjectRequest.h.

◆ AddCustomizedAccessLogTag() [2/7]

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

Definition at line 667 of file HeadObjectRequest.h.

◆ AddCustomizedAccessLogTag() [3/7]

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

Definition at line 670 of file HeadObjectRequest.h.

◆ AddCustomizedAccessLogTag() [4/7]

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

Definition at line 673 of file HeadObjectRequest.h.

◆ AddCustomizedAccessLogTag() [5/7]

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

Definition at line 676 of file HeadObjectRequest.h.

◆ AddCustomizedAccessLogTag() [6/7]

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

Definition at line 679 of file HeadObjectRequest.h.

◆ AddCustomizedAccessLogTag() [7/7]

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

Definition at line 682 of file HeadObjectRequest.h.

◆ AddQueryStringParameters()

void Aws::S3::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::S3::Model::HeadObjectRequest::BucketHasBeenSet ( ) const
inline

The name of the bucket containing the object.

Definition at line 54 of file HeadObjectRequest.h.

◆ CustomizedAccessLogTagHasBeenSet()

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

Definition at line 649 of file HeadObjectRequest.h.

◆ GetBucket()

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

The name of the bucket containing the object.

Definition at line 49 of file HeadObjectRequest.h.

◆ GetCustomizedAccessLogTag()

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

Definition at line 646 of file HeadObjectRequest.h.

◆ GetIfMatch()

const Aws::String& Aws::S3::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 91 of file HeadObjectRequest.h.

◆ GetIfModifiedSince()

const Aws::Utils::DateTime& Aws::S3::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 140 of file HeadObjectRequest.h.

◆ GetIfNoneMatch()

const Aws::String& Aws::S3::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 177 of file HeadObjectRequest.h.

◆ GetIfUnmodifiedSince()

const Aws::Utils::DateTime& Aws::S3::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 226 of file HeadObjectRequest.h.

◆ GetKey()

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

The object key.

Definition at line 262 of file HeadObjectRequest.h.

◆ GetPartNumber()

int Aws::S3::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 618 of file HeadObjectRequest.h.

◆ GetRange()

const Aws::String& Aws::S3::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 307 of file HeadObjectRequest.h.

◆ GetRequestPayer()

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

Definition at line 594 of file HeadObjectRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::S3::S3Request.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file HeadObjectRequest.h.

◆ GetSSECustomerAlgorithm()

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

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

Definition at line 418 of file HeadObjectRequest.h.

◆ GetSSECustomerKey()

const Aws::String& Aws::S3::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 470 of file HeadObjectRequest.h.

◆ GetSSECustomerKeyMD5()

const Aws::String& Aws::S3::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 541 of file HeadObjectRequest.h.

◆ GetVersionId()

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

VersionId used to reference a specific version of the object.

Definition at line 376 of file HeadObjectRequest.h.

◆ IfMatchHasBeenSet()

bool Aws::S3::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 97 of file HeadObjectRequest.h.

◆ IfModifiedSinceHasBeenSet()

bool Aws::S3::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 146 of file HeadObjectRequest.h.

◆ IfNoneMatchHasBeenSet()

bool Aws::S3::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 183 of file HeadObjectRequest.h.

◆ IfUnmodifiedSinceHasBeenSet()

bool Aws::S3::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 232 of file HeadObjectRequest.h.

◆ KeyHasBeenSet()

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

The object key.

Definition at line 267 of file HeadObjectRequest.h.

◆ PartNumberHasBeenSet()

bool Aws::S3::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 626 of file HeadObjectRequest.h.

◆ RangeHasBeenSet()

bool Aws::S3::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 316 of file HeadObjectRequest.h.

◆ RequestPayerHasBeenSet()

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

Definition at line 597 of file HeadObjectRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetBucket() [1/3]

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

The name of the bucket containing the object.

Definition at line 59 of file HeadObjectRequest.h.

◆ SetBucket() [2/3]

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

The name of the bucket containing the object.

Definition at line 64 of file HeadObjectRequest.h.

◆ SetBucket() [3/3]

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

The name of the bucket containing the object.

Definition at line 69 of file HeadObjectRequest.h.

◆ SetCustomizedAccessLogTag() [1/2]

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

Definition at line 652 of file HeadObjectRequest.h.

◆ SetCustomizedAccessLogTag() [2/2]

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

Definition at line 655 of file HeadObjectRequest.h.

◆ SetIfMatch() [1/3]

void Aws::S3::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 103 of file HeadObjectRequest.h.

◆ SetIfMatch() [2/3]

void Aws::S3::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 109 of file HeadObjectRequest.h.

◆ SetIfMatch() [3/3]

void Aws::S3::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 115 of file HeadObjectRequest.h.

◆ SetIfModifiedSince() [1/2]

void Aws::S3::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 152 of file HeadObjectRequest.h.

◆ SetIfModifiedSince() [2/2]

void Aws::S3::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 158 of file HeadObjectRequest.h.

◆ SetIfNoneMatch() [1/3]

void Aws::S3::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 189 of file HeadObjectRequest.h.

◆ SetIfNoneMatch() [2/3]

void Aws::S3::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 195 of file HeadObjectRequest.h.

◆ SetIfNoneMatch() [3/3]

void Aws::S3::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 201 of file HeadObjectRequest.h.

◆ SetIfUnmodifiedSince() [1/2]

void Aws::S3::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 238 of file HeadObjectRequest.h.

◆ SetIfUnmodifiedSince() [2/2]

void Aws::S3::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 244 of file HeadObjectRequest.h.

◆ SetKey() [1/3]

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

The object key.

Definition at line 272 of file HeadObjectRequest.h.

◆ SetKey() [2/3]

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

The object key.

Definition at line 277 of file HeadObjectRequest.h.

◆ SetKey() [3/3]

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

The object key.

Definition at line 282 of file HeadObjectRequest.h.

◆ SetPartNumber()

void Aws::S3::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 634 of file HeadObjectRequest.h.

◆ SetRange() [1/3]

void Aws::S3::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 325 of file HeadObjectRequest.h.

◆ SetRange() [2/3]

void Aws::S3::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 334 of file HeadObjectRequest.h.

◆ SetRange() [3/3]

void Aws::S3::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 343 of file HeadObjectRequest.h.

◆ SetRequestPayer() [1/2]

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

Definition at line 600 of file HeadObjectRequest.h.

◆ SetRequestPayer() [2/2]

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

Definition at line 603 of file HeadObjectRequest.h.

◆ SetSSECustomerAlgorithm() [1/3]

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

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

Definition at line 430 of file HeadObjectRequest.h.

◆ SetSSECustomerAlgorithm() [2/3]

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

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

Definition at line 436 of file HeadObjectRequest.h.

◆ SetSSECustomerAlgorithm() [3/3]

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

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

Definition at line 442 of file HeadObjectRequest.h.

◆ SetSSECustomerKey() [1/3]

void Aws::S3::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 488 of file HeadObjectRequest.h.

◆ SetSSECustomerKey() [2/3]

void Aws::S3::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 497 of file HeadObjectRequest.h.

◆ SetSSECustomerKey() [3/3]

void Aws::S3::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 506 of file HeadObjectRequest.h.

◆ SetSSECustomerKeyMD5() [1/3]

void Aws::S3::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 555 of file HeadObjectRequest.h.

◆ SetSSECustomerKeyMD5() [2/3]

void Aws::S3::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 562 of file HeadObjectRequest.h.

◆ SetSSECustomerKeyMD5() [3/3]

void Aws::S3::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 569 of file HeadObjectRequest.h.

◆ SetVersionId() [1/3]

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

VersionId used to reference a specific version of the object.

Definition at line 386 of file HeadObjectRequest.h.

◆ SetVersionId() [2/3]

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

VersionId used to reference a specific version of the object.

Definition at line 391 of file HeadObjectRequest.h.

◆ SetVersionId() [3/3]

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

VersionId used to reference a specific version of the object.

Definition at line 396 of file HeadObjectRequest.h.

◆ SSECustomerAlgorithmHasBeenSet()

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

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

Definition at line 424 of file HeadObjectRequest.h.

◆ SSECustomerKeyHasBeenSet()

bool Aws::S3::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 479 of file HeadObjectRequest.h.

◆ SSECustomerKeyMD5HasBeenSet()

bool Aws::S3::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 548 of file HeadObjectRequest.h.

◆ VersionIdHasBeenSet()

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

VersionId used to reference a specific version of the object.

Definition at line 381 of file HeadObjectRequest.h.

◆ WithBucket() [1/3]

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

The name of the bucket containing the object.

Definition at line 74 of file HeadObjectRequest.h.

◆ WithBucket() [2/3]

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

The name of the bucket containing the object.

Definition at line 79 of file HeadObjectRequest.h.

◆ WithBucket() [3/3]

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

The name of the bucket containing the object.

Definition at line 84 of file HeadObjectRequest.h.

◆ WithCustomizedAccessLogTag() [1/2]

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

Definition at line 658 of file HeadObjectRequest.h.

◆ WithCustomizedAccessLogTag() [2/2]

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

Definition at line 661 of file HeadObjectRequest.h.

◆ WithIfMatch() [1/3]

HeadObjectRequest& Aws::S3::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 121 of file HeadObjectRequest.h.

◆ WithIfMatch() [2/3]

HeadObjectRequest& Aws::S3::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 127 of file HeadObjectRequest.h.

◆ WithIfMatch() [3/3]

HeadObjectRequest& Aws::S3::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 133 of file HeadObjectRequest.h.

◆ WithIfModifiedSince() [1/2]

HeadObjectRequest& Aws::S3::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 164 of file HeadObjectRequest.h.

◆ WithIfModifiedSince() [2/2]

HeadObjectRequest& Aws::S3::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 170 of file HeadObjectRequest.h.

◆ WithIfNoneMatch() [1/3]

HeadObjectRequest& Aws::S3::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 207 of file HeadObjectRequest.h.

◆ WithIfNoneMatch() [2/3]

HeadObjectRequest& Aws::S3::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 213 of file HeadObjectRequest.h.

◆ WithIfNoneMatch() [3/3]

HeadObjectRequest& Aws::S3::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 219 of file HeadObjectRequest.h.

◆ WithIfUnmodifiedSince() [1/2]

HeadObjectRequest& Aws::S3::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 250 of file HeadObjectRequest.h.

◆ WithIfUnmodifiedSince() [2/2]

HeadObjectRequest& Aws::S3::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 256 of file HeadObjectRequest.h.

◆ WithKey() [1/3]

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

The object key.

Definition at line 287 of file HeadObjectRequest.h.

◆ WithKey() [2/3]

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

The object key.

Definition at line 292 of file HeadObjectRequest.h.

◆ WithKey() [3/3]

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

The object key.

Definition at line 297 of file HeadObjectRequest.h.

◆ WithPartNumber()

HeadObjectRequest& Aws::S3::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 642 of file HeadObjectRequest.h.

◆ WithRange() [1/3]

HeadObjectRequest& Aws::S3::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 352 of file HeadObjectRequest.h.

◆ WithRange() [2/3]

HeadObjectRequest& Aws::S3::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 361 of file HeadObjectRequest.h.

◆ WithRange() [3/3]

HeadObjectRequest& Aws::S3::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 370 of file HeadObjectRequest.h.

◆ WithRequestPayer() [1/2]

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

Definition at line 606 of file HeadObjectRequest.h.

◆ WithRequestPayer() [2/2]

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

Definition at line 609 of file HeadObjectRequest.h.

◆ WithSSECustomerAlgorithm() [1/3]

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

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

Definition at line 448 of file HeadObjectRequest.h.

◆ WithSSECustomerAlgorithm() [2/3]

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

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

Definition at line 454 of file HeadObjectRequest.h.

◆ WithSSECustomerAlgorithm() [3/3]

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

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

Definition at line 460 of file HeadObjectRequest.h.

◆ WithSSECustomerKey() [1/3]

HeadObjectRequest& Aws::S3::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 515 of file HeadObjectRequest.h.

◆ WithSSECustomerKey() [2/3]

HeadObjectRequest& Aws::S3::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 524 of file HeadObjectRequest.h.

◆ WithSSECustomerKey() [3/3]

HeadObjectRequest& Aws::S3::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 533 of file HeadObjectRequest.h.

◆ WithSSECustomerKeyMD5() [1/3]

HeadObjectRequest& Aws::S3::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 576 of file HeadObjectRequest.h.

◆ WithSSECustomerKeyMD5() [2/3]

HeadObjectRequest& Aws::S3::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 583 of file HeadObjectRequest.h.

◆ WithSSECustomerKeyMD5() [3/3]

HeadObjectRequest& Aws::S3::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 590 of file HeadObjectRequest.h.

◆ WithVersionId() [1/3]

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

VersionId used to reference a specific version of the object.

Definition at line 401 of file HeadObjectRequest.h.

◆ WithVersionId() [2/3]

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

VersionId used to reference a specific version of the object.

Definition at line 406 of file HeadObjectRequest.h.

◆ WithVersionId() [3/3]

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

VersionId used to reference a specific version of the object.

Definition at line 411 of file HeadObjectRequest.h.


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