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

#include <GetObjectRetentionRequest.h>

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

Public Member Functions

 GetObjectRetentionRequest ()
 
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)
 
GetObjectRetentionRequestWithBucket (const Aws::String &value)
 
GetObjectRetentionRequestWithBucket (Aws::String &&value)
 
GetObjectRetentionRequestWithBucket (const char *value)
 
const Aws::StringGetKey () const
 
bool KeyHasBeenSet () const
 
void SetKey (const Aws::String &value)
 
void SetKey (Aws::String &&value)
 
void SetKey (const char *value)
 
GetObjectRetentionRequestWithKey (const Aws::String &value)
 
GetObjectRetentionRequestWithKey (Aws::String &&value)
 
GetObjectRetentionRequestWithKey (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)
 
GetObjectRetentionRequestWithVersionId (const Aws::String &value)
 
GetObjectRetentionRequestWithVersionId (Aws::String &&value)
 
GetObjectRetentionRequestWithVersionId (const char *value)
 
const RequestPayerGetRequestPayer () const
 
bool RequestPayerHasBeenSet () const
 
void SetRequestPayer (const RequestPayer &value)
 
void SetRequestPayer (RequestPayer &&value)
 
GetObjectRetentionRequestWithRequestPayer (const RequestPayer &value)
 
GetObjectRetentionRequestWithRequestPayer (RequestPayer &&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)
 
GetObjectRetentionRequestWithCustomizedAccessLogTag (const Aws::Map< Aws::String, Aws::String > &value)
 
GetObjectRetentionRequestWithCustomizedAccessLogTag (Aws::Map< Aws::String, Aws::String > &&value)
 
GetObjectRetentionRequestAddCustomizedAccessLogTag (const Aws::String &key, const Aws::String &value)
 
GetObjectRetentionRequestAddCustomizedAccessLogTag (Aws::String &&key, const Aws::String &value)
 
GetObjectRetentionRequestAddCustomizedAccessLogTag (const Aws::String &key, Aws::String &&value)
 
GetObjectRetentionRequestAddCustomizedAccessLogTag (Aws::String &&key, Aws::String &&value)
 
GetObjectRetentionRequestAddCustomizedAccessLogTag (const char *key, Aws::String &&value)
 
GetObjectRetentionRequestAddCustomizedAccessLogTag (Aws::String &&key, const char *value)
 
GetObjectRetentionRequestAddCustomizedAccessLogTag (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 27 of file GetObjectRetentionRequest.h.

Constructor & Destructor Documentation

◆ GetObjectRetentionRequest()

Aws::S3::Model::GetObjectRetentionRequest::GetObjectRetentionRequest ( )

Member Function Documentation

◆ AddCustomizedAccessLogTag() [1/7]

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

Definition at line 294 of file GetObjectRetentionRequest.h.

◆ AddCustomizedAccessLogTag() [2/7]

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

Definition at line 297 of file GetObjectRetentionRequest.h.

◆ AddCustomizedAccessLogTag() [3/7]

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

Definition at line 300 of file GetObjectRetentionRequest.h.

◆ AddCustomizedAccessLogTag() [4/7]

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

Definition at line 303 of file GetObjectRetentionRequest.h.

◆ AddCustomizedAccessLogTag() [5/7]

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

Definition at line 306 of file GetObjectRetentionRequest.h.

◆ AddCustomizedAccessLogTag() [6/7]

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

Definition at line 309 of file GetObjectRetentionRequest.h.

◆ AddCustomizedAccessLogTag() [7/7]

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

Definition at line 312 of file GetObjectRetentionRequest.h.

◆ AddQueryStringParameters()

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

The bucket name containing the object whose retention settings you want to retrieve.

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 71 of file GetObjectRetentionRequest.h.

◆ CustomizedAccessLogTagHasBeenSet()

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

Definition at line 279 of file GetObjectRetentionRequest.h.

◆ GetBucket()

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

The bucket name containing the object whose retention settings you want to retrieve.

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 57 of file GetObjectRetentionRequest.h.

◆ GetCustomizedAccessLogTag()

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

Definition at line 276 of file GetObjectRetentionRequest.h.

◆ GetKey()

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

The key name for the object whose retention settings you want to retrieve.

Definition at line 162 of file GetObjectRetentionRequest.h.

◆ GetRequestPayer()

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

Definition at line 257 of file GetObjectRetentionRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::S3::S3Request.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file GetObjectRetentionRequest.h.

◆ GetVersionId()

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

The version ID for the object whose retention settings you want to retrieve.

Definition at line 211 of file GetObjectRetentionRequest.h.

◆ KeyHasBeenSet()

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

The key name for the object whose retention settings you want to retrieve.

Definition at line 168 of file GetObjectRetentionRequest.h.

◆ RequestPayerHasBeenSet()

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

Definition at line 260 of file GetObjectRetentionRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetBucket() [1/3]

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

The bucket name containing the object whose retention settings you want to retrieve.

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 85 of file GetObjectRetentionRequest.h.

◆ SetBucket() [2/3]

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

The bucket name containing the object whose retention settings you want to retrieve.

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 99 of file GetObjectRetentionRequest.h.

◆ SetBucket() [3/3]

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

The bucket name containing the object whose retention settings you want to retrieve.

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 113 of file GetObjectRetentionRequest.h.

◆ SetCustomizedAccessLogTag() [1/2]

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

Definition at line 282 of file GetObjectRetentionRequest.h.

◆ SetCustomizedAccessLogTag() [2/2]

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

Definition at line 285 of file GetObjectRetentionRequest.h.

◆ SetKey() [1/3]

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

The key name for the object whose retention settings you want to retrieve.

Definition at line 174 of file GetObjectRetentionRequest.h.

◆ SetKey() [2/3]

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

The key name for the object whose retention settings you want to retrieve.

Definition at line 180 of file GetObjectRetentionRequest.h.

◆ SetKey() [3/3]

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

The key name for the object whose retention settings you want to retrieve.

Definition at line 186 of file GetObjectRetentionRequest.h.

◆ SetRequestPayer() [1/2]

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

Definition at line 263 of file GetObjectRetentionRequest.h.

◆ SetRequestPayer() [2/2]

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

Definition at line 266 of file GetObjectRetentionRequest.h.

◆ SetVersionId() [1/3]

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

The version ID for the object whose retention settings you want to retrieve.

Definition at line 223 of file GetObjectRetentionRequest.h.

◆ SetVersionId() [2/3]

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

The version ID for the object whose retention settings you want to retrieve.

Definition at line 229 of file GetObjectRetentionRequest.h.

◆ SetVersionId() [3/3]

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

The version ID for the object whose retention settings you want to retrieve.

Definition at line 235 of file GetObjectRetentionRequest.h.

◆ VersionIdHasBeenSet()

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

The version ID for the object whose retention settings you want to retrieve.

Definition at line 217 of file GetObjectRetentionRequest.h.

◆ WithBucket() [1/3]

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

The bucket name containing the object whose retention settings you want to retrieve.

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 127 of file GetObjectRetentionRequest.h.

◆ WithBucket() [2/3]

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

The bucket name containing the object whose retention settings you want to retrieve.

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 141 of file GetObjectRetentionRequest.h.

◆ WithBucket() [3/3]

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

The bucket name containing the object whose retention settings you want to retrieve.

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 155 of file GetObjectRetentionRequest.h.

◆ WithCustomizedAccessLogTag() [1/2]

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

Definition at line 288 of file GetObjectRetentionRequest.h.

◆ WithCustomizedAccessLogTag() [2/2]

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

Definition at line 291 of file GetObjectRetentionRequest.h.

◆ WithKey() [1/3]

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

The key name for the object whose retention settings you want to retrieve.

Definition at line 192 of file GetObjectRetentionRequest.h.

◆ WithKey() [2/3]

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

The key name for the object whose retention settings you want to retrieve.

Definition at line 198 of file GetObjectRetentionRequest.h.

◆ WithKey() [3/3]

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

The key name for the object whose retention settings you want to retrieve.

Definition at line 204 of file GetObjectRetentionRequest.h.

◆ WithRequestPayer() [1/2]

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

Definition at line 269 of file GetObjectRetentionRequest.h.

◆ WithRequestPayer() [2/2]

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

Definition at line 272 of file GetObjectRetentionRequest.h.

◆ WithVersionId() [1/3]

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

The version ID for the object whose retention settings you want to retrieve.

Definition at line 241 of file GetObjectRetentionRequest.h.

◆ WithVersionId() [2/3]

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

The version ID for the object whose retention settings you want to retrieve.

Definition at line 247 of file GetObjectRetentionRequest.h.

◆ WithVersionId() [3/3]

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

The version ID for the object whose retention settings you want to retrieve.

Definition at line 253 of file GetObjectRetentionRequest.h.


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