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

#include <GetObjectRequest.h>

+ Inheritance diagram for Aws::S3::Model::GetObjectRequest:

Public Member Functions

 GetObjectRequest ()
 
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)
 
GetObjectRequestWithBucket (const Aws::String &value)
 
GetObjectRequestWithBucket (Aws::String &&value)
 
GetObjectRequestWithBucket (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)
 
GetObjectRequestWithIfMatch (const Aws::String &value)
 
GetObjectRequestWithIfMatch (Aws::String &&value)
 
GetObjectRequestWithIfMatch (const char *value)
 
const Aws::Utils::DateTimeGetIfModifiedSince () const
 
bool IfModifiedSinceHasBeenSet () const
 
void SetIfModifiedSince (const Aws::Utils::DateTime &value)
 
void SetIfModifiedSince (Aws::Utils::DateTime &&value)
 
GetObjectRequestWithIfModifiedSince (const Aws::Utils::DateTime &value)
 
GetObjectRequestWithIfModifiedSince (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)
 
GetObjectRequestWithIfNoneMatch (const Aws::String &value)
 
GetObjectRequestWithIfNoneMatch (Aws::String &&value)
 
GetObjectRequestWithIfNoneMatch (const char *value)
 
const Aws::Utils::DateTimeGetIfUnmodifiedSince () const
 
bool IfUnmodifiedSinceHasBeenSet () const
 
void SetIfUnmodifiedSince (const Aws::Utils::DateTime &value)
 
void SetIfUnmodifiedSince (Aws::Utils::DateTime &&value)
 
GetObjectRequestWithIfUnmodifiedSince (const Aws::Utils::DateTime &value)
 
GetObjectRequestWithIfUnmodifiedSince (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)
 
GetObjectRequestWithKey (const Aws::String &value)
 
GetObjectRequestWithKey (Aws::String &&value)
 
GetObjectRequestWithKey (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)
 
GetObjectRequestWithRange (const Aws::String &value)
 
GetObjectRequestWithRange (Aws::String &&value)
 
GetObjectRequestWithRange (const char *value)
 
const Aws::StringGetResponseCacheControl () const
 
bool ResponseCacheControlHasBeenSet () const
 
void SetResponseCacheControl (const Aws::String &value)
 
void SetResponseCacheControl (Aws::String &&value)
 
void SetResponseCacheControl (const char *value)
 
GetObjectRequestWithResponseCacheControl (const Aws::String &value)
 
GetObjectRequestWithResponseCacheControl (Aws::String &&value)
 
GetObjectRequestWithResponseCacheControl (const char *value)
 
const Aws::StringGetResponseContentDisposition () const
 
bool ResponseContentDispositionHasBeenSet () const
 
void SetResponseContentDisposition (const Aws::String &value)
 
void SetResponseContentDisposition (Aws::String &&value)
 
void SetResponseContentDisposition (const char *value)
 
GetObjectRequestWithResponseContentDisposition (const Aws::String &value)
 
GetObjectRequestWithResponseContentDisposition (Aws::String &&value)
 
GetObjectRequestWithResponseContentDisposition (const char *value)
 
const Aws::StringGetResponseContentEncoding () const
 
bool ResponseContentEncodingHasBeenSet () const
 
void SetResponseContentEncoding (const Aws::String &value)
 
void SetResponseContentEncoding (Aws::String &&value)
 
void SetResponseContentEncoding (const char *value)
 
GetObjectRequestWithResponseContentEncoding (const Aws::String &value)
 
GetObjectRequestWithResponseContentEncoding (Aws::String &&value)
 
GetObjectRequestWithResponseContentEncoding (const char *value)
 
const Aws::StringGetResponseContentLanguage () const
 
bool ResponseContentLanguageHasBeenSet () const
 
void SetResponseContentLanguage (const Aws::String &value)
 
void SetResponseContentLanguage (Aws::String &&value)
 
void SetResponseContentLanguage (const char *value)
 
GetObjectRequestWithResponseContentLanguage (const Aws::String &value)
 
GetObjectRequestWithResponseContentLanguage (Aws::String &&value)
 
GetObjectRequestWithResponseContentLanguage (const char *value)
 
const Aws::StringGetResponseContentType () const
 
bool ResponseContentTypeHasBeenSet () const
 
void SetResponseContentType (const Aws::String &value)
 
void SetResponseContentType (Aws::String &&value)
 
void SetResponseContentType (const char *value)
 
GetObjectRequestWithResponseContentType (const Aws::String &value)
 
GetObjectRequestWithResponseContentType (Aws::String &&value)
 
GetObjectRequestWithResponseContentType (const char *value)
 
const Aws::Utils::DateTimeGetResponseExpires () const
 
bool ResponseExpiresHasBeenSet () const
 
void SetResponseExpires (const Aws::Utils::DateTime &value)
 
void SetResponseExpires (Aws::Utils::DateTime &&value)
 
GetObjectRequestWithResponseExpires (const Aws::Utils::DateTime &value)
 
GetObjectRequestWithResponseExpires (Aws::Utils::DateTime &&value)
 
const Aws::StringGetVersionId () const
 
bool VersionIdHasBeenSet () const
 
void SetVersionId (const Aws::String &value)
 
void SetVersionId (Aws::String &&value)
 
void SetVersionId (const char *value)
 
GetObjectRequestWithVersionId (const Aws::String &value)
 
GetObjectRequestWithVersionId (Aws::String &&value)
 
GetObjectRequestWithVersionId (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)
 
GetObjectRequestWithSSECustomerAlgorithm (const Aws::String &value)
 
GetObjectRequestWithSSECustomerAlgorithm (Aws::String &&value)
 
GetObjectRequestWithSSECustomerAlgorithm (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)
 
GetObjectRequestWithSSECustomerKey (const Aws::String &value)
 
GetObjectRequestWithSSECustomerKey (Aws::String &&value)
 
GetObjectRequestWithSSECustomerKey (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)
 
GetObjectRequestWithSSECustomerKeyMD5 (const Aws::String &value)
 
GetObjectRequestWithSSECustomerKeyMD5 (Aws::String &&value)
 
GetObjectRequestWithSSECustomerKeyMD5 (const char *value)
 
const RequestPayerGetRequestPayer () const
 
bool RequestPayerHasBeenSet () const
 
void SetRequestPayer (const RequestPayer &value)
 
void SetRequestPayer (RequestPayer &&value)
 
GetObjectRequestWithRequestPayer (const RequestPayer &value)
 
GetObjectRequestWithRequestPayer (RequestPayer &&value)
 
int GetPartNumber () const
 
bool PartNumberHasBeenSet () const
 
void SetPartNumber (int value)
 
GetObjectRequestWithPartNumber (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)
 
GetObjectRequestWithCustomizedAccessLogTag (const Aws::Map< Aws::String, Aws::String > &value)
 
GetObjectRequestWithCustomizedAccessLogTag (Aws::Map< Aws::String, Aws::String > &&value)
 
GetObjectRequestAddCustomizedAccessLogTag (const Aws::String &key, const Aws::String &value)
 
GetObjectRequestAddCustomizedAccessLogTag (Aws::String &&key, const Aws::String &value)
 
GetObjectRequestAddCustomizedAccessLogTag (const Aws::String &key, Aws::String &&value)
 
GetObjectRequestAddCustomizedAccessLogTag (Aws::String &&key, Aws::String &&value)
 
GetObjectRequestAddCustomizedAccessLogTag (const char *key, Aws::String &&value)
 
GetObjectRequestAddCustomizedAccessLogTag (Aws::String &&key, const char *value)
 
GetObjectRequestAddCustomizedAccessLogTag (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 GetObjectRequest.h.

Constructor & Destructor Documentation

◆ GetObjectRequest()

Aws::S3::Model::GetObjectRequest::GetObjectRequest ( )

Member Function Documentation

◆ AddCustomizedAccessLogTag() [1/7]

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

Definition at line 968 of file GetObjectRequest.h.

◆ AddCustomizedAccessLogTag() [2/7]

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

Definition at line 971 of file GetObjectRequest.h.

◆ AddCustomizedAccessLogTag() [3/7]

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

Definition at line 974 of file GetObjectRequest.h.

◆ AddCustomizedAccessLogTag() [4/7]

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

Definition at line 977 of file GetObjectRequest.h.

◆ AddCustomizedAccessLogTag() [5/7]

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

Definition at line 980 of file GetObjectRequest.h.

◆ AddCustomizedAccessLogTag() [6/7]

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

Definition at line 983 of file GetObjectRequest.h.

◆ AddCustomizedAccessLogTag() [7/7]

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

Definition at line 986 of file GetObjectRequest.h.

◆ AddQueryStringParameters()

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

The bucket name containing the object.

When using this API 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 operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

Definition at line 72 of file GetObjectRequest.h.

◆ CustomizedAccessLogTagHasBeenSet()

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

Definition at line 953 of file GetObjectRequest.h.

◆ GetBucket()

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

The bucket name containing the object.

When using this API 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 operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

Definition at line 58 of file GetObjectRequest.h.

◆ GetCustomizedAccessLogTag()

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

Definition at line 950 of file GetObjectRequest.h.

◆ GetIfMatch()

const Aws::String& Aws::S3::Model::GetObjectRequest::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 163 of file GetObjectRequest.h.

◆ GetIfModifiedSince()

const Aws::Utils::DateTime& Aws::S3::Model::GetObjectRequest::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 212 of file GetObjectRequest.h.

◆ GetIfNoneMatch()

const Aws::String& Aws::S3::Model::GetObjectRequest::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 249 of file GetObjectRequest.h.

◆ GetIfUnmodifiedSince()

const Aws::Utils::DateTime& Aws::S3::Model::GetObjectRequest::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 298 of file GetObjectRequest.h.

◆ GetKey()

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

Key of the object to get.

Definition at line 334 of file GetObjectRequest.h.

◆ GetPartNumber()

int Aws::S3::Model::GetObjectRequest::GetPartNumber ( ) const
inline

Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object.

Definition at line 925 of file GetObjectRequest.h.

◆ GetRange()

const Aws::String& Aws::S3::Model::GetObjectRequest::GetRange ( ) const
inline

Downloads the specified range bytes of an object. For more information about the HTTP Range header, see https://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 379 of file GetObjectRequest.h.

◆ GetRequestPayer()

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

Definition at line 902 of file GetObjectRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::S3::S3Request.

◆ GetResponseCacheControl()

const Aws::String& Aws::S3::Model::GetObjectRequest::GetResponseCacheControl ( ) const
inline

Sets the Cache-Control header of the response.

Definition at line 448 of file GetObjectRequest.h.

◆ GetResponseContentDisposition()

const Aws::String& Aws::S3::Model::GetObjectRequest::GetResponseContentDisposition ( ) const
inline

Sets the Content-Disposition header of the response

Definition at line 489 of file GetObjectRequest.h.

◆ GetResponseContentEncoding()

const Aws::String& Aws::S3::Model::GetObjectRequest::GetResponseContentEncoding ( ) const
inline

Sets the Content-Encoding header of the response.

Definition at line 530 of file GetObjectRequest.h.

◆ GetResponseContentLanguage()

const Aws::String& Aws::S3::Model::GetObjectRequest::GetResponseContentLanguage ( ) const
inline

Sets the Content-Language header of the response.

Definition at line 571 of file GetObjectRequest.h.

◆ GetResponseContentType()

const Aws::String& Aws::S3::Model::GetObjectRequest::GetResponseContentType ( ) const
inline

Sets the Content-Type header of the response.

Definition at line 612 of file GetObjectRequest.h.

◆ GetResponseExpires()

const Aws::Utils::DateTime& Aws::S3::Model::GetObjectRequest::GetResponseExpires ( ) const
inline

Sets the Expires header of the response.

Definition at line 653 of file GetObjectRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file GetObjectRequest.h.

◆ GetSSECustomerAlgorithm()

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

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

Definition at line 726 of file GetObjectRequest.h.

◆ GetSSECustomerKey()

const Aws::String& Aws::S3::Model::GetObjectRequest::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 778 of file GetObjectRequest.h.

◆ GetSSECustomerKeyMD5()

const Aws::String& Aws::S3::Model::GetObjectRequest::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 849 of file GetObjectRequest.h.

◆ GetVersionId()

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

VersionId used to reference a specific version of the object.

Definition at line 684 of file GetObjectRequest.h.

◆ IfMatchHasBeenSet()

bool Aws::S3::Model::GetObjectRequest::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 169 of file GetObjectRequest.h.

◆ IfModifiedSinceHasBeenSet()

bool Aws::S3::Model::GetObjectRequest::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 218 of file GetObjectRequest.h.

◆ IfNoneMatchHasBeenSet()

bool Aws::S3::Model::GetObjectRequest::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 255 of file GetObjectRequest.h.

◆ IfUnmodifiedSinceHasBeenSet()

bool Aws::S3::Model::GetObjectRequest::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 304 of file GetObjectRequest.h.

◆ KeyHasBeenSet()

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

Key of the object to get.

Definition at line 339 of file GetObjectRequest.h.

◆ PartNumberHasBeenSet()

bool Aws::S3::Model::GetObjectRequest::PartNumberHasBeenSet ( ) const
inline

Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object.

Definition at line 932 of file GetObjectRequest.h.

◆ RangeHasBeenSet()

bool Aws::S3::Model::GetObjectRequest::RangeHasBeenSet ( ) const
inline

Downloads the specified range bytes of an object. For more information about the HTTP Range header, see https://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 388 of file GetObjectRequest.h.

◆ RequestPayerHasBeenSet()

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

Definition at line 905 of file GetObjectRequest.h.

◆ ResponseCacheControlHasBeenSet()

bool Aws::S3::Model::GetObjectRequest::ResponseCacheControlHasBeenSet ( ) const
inline

Sets the Cache-Control header of the response.

Definition at line 453 of file GetObjectRequest.h.

◆ ResponseContentDispositionHasBeenSet()

bool Aws::S3::Model::GetObjectRequest::ResponseContentDispositionHasBeenSet ( ) const
inline

Sets the Content-Disposition header of the response

Definition at line 494 of file GetObjectRequest.h.

◆ ResponseContentEncodingHasBeenSet()

bool Aws::S3::Model::GetObjectRequest::ResponseContentEncodingHasBeenSet ( ) const
inline

Sets the Content-Encoding header of the response.

Definition at line 535 of file GetObjectRequest.h.

◆ ResponseContentLanguageHasBeenSet()

bool Aws::S3::Model::GetObjectRequest::ResponseContentLanguageHasBeenSet ( ) const
inline

Sets the Content-Language header of the response.

Definition at line 576 of file GetObjectRequest.h.

◆ ResponseContentTypeHasBeenSet()

bool Aws::S3::Model::GetObjectRequest::ResponseContentTypeHasBeenSet ( ) const
inline

Sets the Content-Type header of the response.

Definition at line 617 of file GetObjectRequest.h.

◆ ResponseExpiresHasBeenSet()

bool Aws::S3::Model::GetObjectRequest::ResponseExpiresHasBeenSet ( ) const
inline

Sets the Expires header of the response.

Definition at line 658 of file GetObjectRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetBucket() [1/3]

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

The bucket name containing the object.

When using this API 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 operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

Definition at line 86 of file GetObjectRequest.h.

◆ SetBucket() [2/3]

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

The bucket name containing the object.

When using this API 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 operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

Definition at line 100 of file GetObjectRequest.h.

◆ SetBucket() [3/3]

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

The bucket name containing the object.

When using this API 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 operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

Definition at line 114 of file GetObjectRequest.h.

◆ SetCustomizedAccessLogTag() [1/2]

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

Definition at line 956 of file GetObjectRequest.h.

◆ SetCustomizedAccessLogTag() [2/2]

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

Definition at line 959 of file GetObjectRequest.h.

◆ SetIfMatch() [1/3]

void Aws::S3::Model::GetObjectRequest::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 175 of file GetObjectRequest.h.

◆ SetIfMatch() [2/3]

void Aws::S3::Model::GetObjectRequest::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 181 of file GetObjectRequest.h.

◆ SetIfMatch() [3/3]

void Aws::S3::Model::GetObjectRequest::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 187 of file GetObjectRequest.h.

◆ SetIfModifiedSince() [1/2]

void Aws::S3::Model::GetObjectRequest::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 224 of file GetObjectRequest.h.

◆ SetIfModifiedSince() [2/2]

void Aws::S3::Model::GetObjectRequest::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 230 of file GetObjectRequest.h.

◆ SetIfNoneMatch() [1/3]

void Aws::S3::Model::GetObjectRequest::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 261 of file GetObjectRequest.h.

◆ SetIfNoneMatch() [2/3]

void Aws::S3::Model::GetObjectRequest::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 267 of file GetObjectRequest.h.

◆ SetIfNoneMatch() [3/3]

void Aws::S3::Model::GetObjectRequest::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 273 of file GetObjectRequest.h.

◆ SetIfUnmodifiedSince() [1/2]

void Aws::S3::Model::GetObjectRequest::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 310 of file GetObjectRequest.h.

◆ SetIfUnmodifiedSince() [2/2]

void Aws::S3::Model::GetObjectRequest::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 316 of file GetObjectRequest.h.

◆ SetKey() [1/3]

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

Key of the object to get.

Definition at line 344 of file GetObjectRequest.h.

◆ SetKey() [2/3]

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

Key of the object to get.

Definition at line 349 of file GetObjectRequest.h.

◆ SetKey() [3/3]

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

Key of the object to get.

Definition at line 354 of file GetObjectRequest.h.

◆ SetPartNumber()

void Aws::S3::Model::GetObjectRequest::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' GET request for the part specified. Useful for downloading just a part of an object.

Definition at line 939 of file GetObjectRequest.h.

◆ SetRange() [1/3]

void Aws::S3::Model::GetObjectRequest::SetRange ( const Aws::String value)
inline

Downloads the specified range bytes of an object. For more information about the HTTP Range header, see https://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 397 of file GetObjectRequest.h.

◆ SetRange() [2/3]

void Aws::S3::Model::GetObjectRequest::SetRange ( Aws::String &&  value)
inline

Downloads the specified range bytes of an object. For more information about the HTTP Range header, see https://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 406 of file GetObjectRequest.h.

◆ SetRange() [3/3]

void Aws::S3::Model::GetObjectRequest::SetRange ( const char *  value)
inline

Downloads the specified range bytes of an object. For more information about the HTTP Range header, see https://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 415 of file GetObjectRequest.h.

◆ SetRequestPayer() [1/2]

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

Definition at line 908 of file GetObjectRequest.h.

◆ SetRequestPayer() [2/2]

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

Definition at line 911 of file GetObjectRequest.h.

◆ SetResponseCacheControl() [1/3]

void Aws::S3::Model::GetObjectRequest::SetResponseCacheControl ( const Aws::String value)
inline

Sets the Cache-Control header of the response.

Definition at line 458 of file GetObjectRequest.h.

◆ SetResponseCacheControl() [2/3]

void Aws::S3::Model::GetObjectRequest::SetResponseCacheControl ( Aws::String &&  value)
inline

Sets the Cache-Control header of the response.

Definition at line 463 of file GetObjectRequest.h.

◆ SetResponseCacheControl() [3/3]

void Aws::S3::Model::GetObjectRequest::SetResponseCacheControl ( const char *  value)
inline

Sets the Cache-Control header of the response.

Definition at line 468 of file GetObjectRequest.h.

◆ SetResponseContentDisposition() [1/3]

void Aws::S3::Model::GetObjectRequest::SetResponseContentDisposition ( const Aws::String value)
inline

Sets the Content-Disposition header of the response

Definition at line 499 of file GetObjectRequest.h.

◆ SetResponseContentDisposition() [2/3]

void Aws::S3::Model::GetObjectRequest::SetResponseContentDisposition ( Aws::String &&  value)
inline

Sets the Content-Disposition header of the response

Definition at line 504 of file GetObjectRequest.h.

◆ SetResponseContentDisposition() [3/3]

void Aws::S3::Model::GetObjectRequest::SetResponseContentDisposition ( const char *  value)
inline

Sets the Content-Disposition header of the response

Definition at line 509 of file GetObjectRequest.h.

◆ SetResponseContentEncoding() [1/3]

void Aws::S3::Model::GetObjectRequest::SetResponseContentEncoding ( const Aws::String value)
inline

Sets the Content-Encoding header of the response.

Definition at line 540 of file GetObjectRequest.h.

◆ SetResponseContentEncoding() [2/3]

void Aws::S3::Model::GetObjectRequest::SetResponseContentEncoding ( Aws::String &&  value)
inline

Sets the Content-Encoding header of the response.

Definition at line 545 of file GetObjectRequest.h.

◆ SetResponseContentEncoding() [3/3]

void Aws::S3::Model::GetObjectRequest::SetResponseContentEncoding ( const char *  value)
inline

Sets the Content-Encoding header of the response.

Definition at line 550 of file GetObjectRequest.h.

◆ SetResponseContentLanguage() [1/3]

void Aws::S3::Model::GetObjectRequest::SetResponseContentLanguage ( const Aws::String value)
inline

Sets the Content-Language header of the response.

Definition at line 581 of file GetObjectRequest.h.

◆ SetResponseContentLanguage() [2/3]

void Aws::S3::Model::GetObjectRequest::SetResponseContentLanguage ( Aws::String &&  value)
inline

Sets the Content-Language header of the response.

Definition at line 586 of file GetObjectRequest.h.

◆ SetResponseContentLanguage() [3/3]

void Aws::S3::Model::GetObjectRequest::SetResponseContentLanguage ( const char *  value)
inline

Sets the Content-Language header of the response.

Definition at line 591 of file GetObjectRequest.h.

◆ SetResponseContentType() [1/3]

void Aws::S3::Model::GetObjectRequest::SetResponseContentType ( const Aws::String value)
inline

Sets the Content-Type header of the response.

Definition at line 622 of file GetObjectRequest.h.

◆ SetResponseContentType() [2/3]

void Aws::S3::Model::GetObjectRequest::SetResponseContentType ( Aws::String &&  value)
inline

Sets the Content-Type header of the response.

Definition at line 627 of file GetObjectRequest.h.

◆ SetResponseContentType() [3/3]

void Aws::S3::Model::GetObjectRequest::SetResponseContentType ( const char *  value)
inline

Sets the Content-Type header of the response.

Definition at line 632 of file GetObjectRequest.h.

◆ SetResponseExpires() [1/2]

void Aws::S3::Model::GetObjectRequest::SetResponseExpires ( const Aws::Utils::DateTime value)
inline

Sets the Expires header of the response.

Definition at line 663 of file GetObjectRequest.h.

◆ SetResponseExpires() [2/2]

void Aws::S3::Model::GetObjectRequest::SetResponseExpires ( Aws::Utils::DateTime &&  value)
inline

Sets the Expires header of the response.

Definition at line 668 of file GetObjectRequest.h.

◆ SetSSECustomerAlgorithm() [1/3]

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

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

Definition at line 738 of file GetObjectRequest.h.

◆ SetSSECustomerAlgorithm() [2/3]

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

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

Definition at line 744 of file GetObjectRequest.h.

◆ SetSSECustomerAlgorithm() [3/3]

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

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

Definition at line 750 of file GetObjectRequest.h.

◆ SetSSECustomerKey() [1/3]

void Aws::S3::Model::GetObjectRequest::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 796 of file GetObjectRequest.h.

◆ SetSSECustomerKey() [2/3]

void Aws::S3::Model::GetObjectRequest::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 805 of file GetObjectRequest.h.

◆ SetSSECustomerKey() [3/3]

void Aws::S3::Model::GetObjectRequest::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 814 of file GetObjectRequest.h.

◆ SetSSECustomerKeyMD5() [1/3]

void Aws::S3::Model::GetObjectRequest::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 863 of file GetObjectRequest.h.

◆ SetSSECustomerKeyMD5() [2/3]

void Aws::S3::Model::GetObjectRequest::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 870 of file GetObjectRequest.h.

◆ SetSSECustomerKeyMD5() [3/3]

void Aws::S3::Model::GetObjectRequest::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 877 of file GetObjectRequest.h.

◆ SetVersionId() [1/3]

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

VersionId used to reference a specific version of the object.

Definition at line 694 of file GetObjectRequest.h.

◆ SetVersionId() [2/3]

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

VersionId used to reference a specific version of the object.

Definition at line 699 of file GetObjectRequest.h.

◆ SetVersionId() [3/3]

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

VersionId used to reference a specific version of the object.

Definition at line 704 of file GetObjectRequest.h.

◆ SSECustomerAlgorithmHasBeenSet()

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

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

Definition at line 732 of file GetObjectRequest.h.

◆ SSECustomerKeyHasBeenSet()

bool Aws::S3::Model::GetObjectRequest::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 787 of file GetObjectRequest.h.

◆ SSECustomerKeyMD5HasBeenSet()

bool Aws::S3::Model::GetObjectRequest::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 856 of file GetObjectRequest.h.

◆ VersionIdHasBeenSet()

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

VersionId used to reference a specific version of the object.

Definition at line 689 of file GetObjectRequest.h.

◆ WithBucket() [1/3]

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

The bucket name containing the object.

When using this API 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 operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

Definition at line 128 of file GetObjectRequest.h.

◆ WithBucket() [2/3]

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

The bucket name containing the object.

When using this API 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 operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

Definition at line 142 of file GetObjectRequest.h.

◆ WithBucket() [3/3]

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

The bucket name containing the object.

When using this API 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 operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

Definition at line 156 of file GetObjectRequest.h.

◆ WithCustomizedAccessLogTag() [1/2]

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

Definition at line 962 of file GetObjectRequest.h.

◆ WithCustomizedAccessLogTag() [2/2]

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

Definition at line 965 of file GetObjectRequest.h.

◆ WithIfMatch() [1/3]

GetObjectRequest& Aws::S3::Model::GetObjectRequest::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 193 of file GetObjectRequest.h.

◆ WithIfMatch() [2/3]

GetObjectRequest& Aws::S3::Model::GetObjectRequest::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 199 of file GetObjectRequest.h.

◆ WithIfMatch() [3/3]

GetObjectRequest& Aws::S3::Model::GetObjectRequest::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 205 of file GetObjectRequest.h.

◆ WithIfModifiedSince() [1/2]

GetObjectRequest& Aws::S3::Model::GetObjectRequest::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 236 of file GetObjectRequest.h.

◆ WithIfModifiedSince() [2/2]

GetObjectRequest& Aws::S3::Model::GetObjectRequest::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 242 of file GetObjectRequest.h.

◆ WithIfNoneMatch() [1/3]

GetObjectRequest& Aws::S3::Model::GetObjectRequest::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 279 of file GetObjectRequest.h.

◆ WithIfNoneMatch() [2/3]

GetObjectRequest& Aws::S3::Model::GetObjectRequest::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 285 of file GetObjectRequest.h.

◆ WithIfNoneMatch() [3/3]

GetObjectRequest& Aws::S3::Model::GetObjectRequest::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 291 of file GetObjectRequest.h.

◆ WithIfUnmodifiedSince() [1/2]

GetObjectRequest& Aws::S3::Model::GetObjectRequest::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 322 of file GetObjectRequest.h.

◆ WithIfUnmodifiedSince() [2/2]

GetObjectRequest& Aws::S3::Model::GetObjectRequest::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 328 of file GetObjectRequest.h.

◆ WithKey() [1/3]

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

Key of the object to get.

Definition at line 359 of file GetObjectRequest.h.

◆ WithKey() [2/3]

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

Key of the object to get.

Definition at line 364 of file GetObjectRequest.h.

◆ WithKey() [3/3]

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

Key of the object to get.

Definition at line 369 of file GetObjectRequest.h.

◆ WithPartNumber()

GetObjectRequest& Aws::S3::Model::GetObjectRequest::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' GET request for the part specified. Useful for downloading just a part of an object.

Definition at line 946 of file GetObjectRequest.h.

◆ WithRange() [1/3]

GetObjectRequest& Aws::S3::Model::GetObjectRequest::WithRange ( const Aws::String value)
inline

Downloads the specified range bytes of an object. For more information about the HTTP Range header, see https://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 424 of file GetObjectRequest.h.

◆ WithRange() [2/3]

GetObjectRequest& Aws::S3::Model::GetObjectRequest::WithRange ( Aws::String &&  value)
inline

Downloads the specified range bytes of an object. For more information about the HTTP Range header, see https://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 433 of file GetObjectRequest.h.

◆ WithRange() [3/3]

GetObjectRequest& Aws::S3::Model::GetObjectRequest::WithRange ( const char *  value)
inline

Downloads the specified range bytes of an object. For more information about the HTTP Range header, see https://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 442 of file GetObjectRequest.h.

◆ WithRequestPayer() [1/2]

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

Definition at line 914 of file GetObjectRequest.h.

◆ WithRequestPayer() [2/2]

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

Definition at line 917 of file GetObjectRequest.h.

◆ WithResponseCacheControl() [1/3]

GetObjectRequest& Aws::S3::Model::GetObjectRequest::WithResponseCacheControl ( const Aws::String value)
inline

Sets the Cache-Control header of the response.

Definition at line 473 of file GetObjectRequest.h.

◆ WithResponseCacheControl() [2/3]

GetObjectRequest& Aws::S3::Model::GetObjectRequest::WithResponseCacheControl ( Aws::String &&  value)
inline

Sets the Cache-Control header of the response.

Definition at line 478 of file GetObjectRequest.h.

◆ WithResponseCacheControl() [3/3]

GetObjectRequest& Aws::S3::Model::GetObjectRequest::WithResponseCacheControl ( const char *  value)
inline

Sets the Cache-Control header of the response.

Definition at line 483 of file GetObjectRequest.h.

◆ WithResponseContentDisposition() [1/3]

GetObjectRequest& Aws::S3::Model::GetObjectRequest::WithResponseContentDisposition ( const Aws::String value)
inline

Sets the Content-Disposition header of the response

Definition at line 514 of file GetObjectRequest.h.

◆ WithResponseContentDisposition() [2/3]

GetObjectRequest& Aws::S3::Model::GetObjectRequest::WithResponseContentDisposition ( Aws::String &&  value)
inline

Sets the Content-Disposition header of the response

Definition at line 519 of file GetObjectRequest.h.

◆ WithResponseContentDisposition() [3/3]

GetObjectRequest& Aws::S3::Model::GetObjectRequest::WithResponseContentDisposition ( const char *  value)
inline

Sets the Content-Disposition header of the response

Definition at line 524 of file GetObjectRequest.h.

◆ WithResponseContentEncoding() [1/3]

GetObjectRequest& Aws::S3::Model::GetObjectRequest::WithResponseContentEncoding ( const Aws::String value)
inline

Sets the Content-Encoding header of the response.

Definition at line 555 of file GetObjectRequest.h.

◆ WithResponseContentEncoding() [2/3]

GetObjectRequest& Aws::S3::Model::GetObjectRequest::WithResponseContentEncoding ( Aws::String &&  value)
inline

Sets the Content-Encoding header of the response.

Definition at line 560 of file GetObjectRequest.h.

◆ WithResponseContentEncoding() [3/3]

GetObjectRequest& Aws::S3::Model::GetObjectRequest::WithResponseContentEncoding ( const char *  value)
inline

Sets the Content-Encoding header of the response.

Definition at line 565 of file GetObjectRequest.h.

◆ WithResponseContentLanguage() [1/3]

GetObjectRequest& Aws::S3::Model::GetObjectRequest::WithResponseContentLanguage ( const Aws::String value)
inline

Sets the Content-Language header of the response.

Definition at line 596 of file GetObjectRequest.h.

◆ WithResponseContentLanguage() [2/3]

GetObjectRequest& Aws::S3::Model::GetObjectRequest::WithResponseContentLanguage ( Aws::String &&  value)
inline

Sets the Content-Language header of the response.

Definition at line 601 of file GetObjectRequest.h.

◆ WithResponseContentLanguage() [3/3]

GetObjectRequest& Aws::S3::Model::GetObjectRequest::WithResponseContentLanguage ( const char *  value)
inline

Sets the Content-Language header of the response.

Definition at line 606 of file GetObjectRequest.h.

◆ WithResponseContentType() [1/3]

GetObjectRequest& Aws::S3::Model::GetObjectRequest::WithResponseContentType ( const Aws::String value)
inline

Sets the Content-Type header of the response.

Definition at line 637 of file GetObjectRequest.h.

◆ WithResponseContentType() [2/3]

GetObjectRequest& Aws::S3::Model::GetObjectRequest::WithResponseContentType ( Aws::String &&  value)
inline

Sets the Content-Type header of the response.

Definition at line 642 of file GetObjectRequest.h.

◆ WithResponseContentType() [3/3]

GetObjectRequest& Aws::S3::Model::GetObjectRequest::WithResponseContentType ( const char *  value)
inline

Sets the Content-Type header of the response.

Definition at line 647 of file GetObjectRequest.h.

◆ WithResponseExpires() [1/2]

GetObjectRequest& Aws::S3::Model::GetObjectRequest::WithResponseExpires ( const Aws::Utils::DateTime value)
inline

Sets the Expires header of the response.

Definition at line 673 of file GetObjectRequest.h.

◆ WithResponseExpires() [2/2]

GetObjectRequest& Aws::S3::Model::GetObjectRequest::WithResponseExpires ( Aws::Utils::DateTime &&  value)
inline

Sets the Expires header of the response.

Definition at line 678 of file GetObjectRequest.h.

◆ WithSSECustomerAlgorithm() [1/3]

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

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

Definition at line 756 of file GetObjectRequest.h.

◆ WithSSECustomerAlgorithm() [2/3]

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

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

Definition at line 762 of file GetObjectRequest.h.

◆ WithSSECustomerAlgorithm() [3/3]

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

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

Definition at line 768 of file GetObjectRequest.h.

◆ WithSSECustomerKey() [1/3]

GetObjectRequest& Aws::S3::Model::GetObjectRequest::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 823 of file GetObjectRequest.h.

◆ WithSSECustomerKey() [2/3]

GetObjectRequest& Aws::S3::Model::GetObjectRequest::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 832 of file GetObjectRequest.h.

◆ WithSSECustomerKey() [3/3]

GetObjectRequest& Aws::S3::Model::GetObjectRequest::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 841 of file GetObjectRequest.h.

◆ WithSSECustomerKeyMD5() [1/3]

GetObjectRequest& Aws::S3::Model::GetObjectRequest::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 884 of file GetObjectRequest.h.

◆ WithSSECustomerKeyMD5() [2/3]

GetObjectRequest& Aws::S3::Model::GetObjectRequest::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 891 of file GetObjectRequest.h.

◆ WithSSECustomerKeyMD5() [3/3]

GetObjectRequest& Aws::S3::Model::GetObjectRequest::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 898 of file GetObjectRequest.h.

◆ WithVersionId() [1/3]

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

VersionId used to reference a specific version of the object.

Definition at line 709 of file GetObjectRequest.h.

◆ WithVersionId() [2/3]

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

VersionId used to reference a specific version of the object.

Definition at line 714 of file GetObjectRequest.h.

◆ WithVersionId() [3/3]

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

VersionId used to reference a specific version of the object.

Definition at line 719 of file GetObjectRequest.h.


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