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

#include <GetObjectLegalHoldRequest.h>

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

Public Member Functions

 GetObjectLegalHoldRequest ()
 
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)
 
GetObjectLegalHoldRequestWithBucket (const Aws::String &value)
 
GetObjectLegalHoldRequestWithBucket (Aws::String &&value)
 
GetObjectLegalHoldRequestWithBucket (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)
 
GetObjectLegalHoldRequestWithKey (const Aws::String &value)
 
GetObjectLegalHoldRequestWithKey (Aws::String &&value)
 
GetObjectLegalHoldRequestWithKey (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)
 
GetObjectLegalHoldRequestWithVersionId (const Aws::String &value)
 
GetObjectLegalHoldRequestWithVersionId (Aws::String &&value)
 
GetObjectLegalHoldRequestWithVersionId (const char *value)
 
const RequestPayerGetRequestPayer () const
 
bool RequestPayerHasBeenSet () const
 
void SetRequestPayer (const RequestPayer &value)
 
void SetRequestPayer (RequestPayer &&value)
 
GetObjectLegalHoldRequestWithRequestPayer (const RequestPayer &value)
 
GetObjectLegalHoldRequestWithRequestPayer (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)
 
GetObjectLegalHoldRequestWithCustomizedAccessLogTag (const Aws::Map< Aws::String, Aws::String > &value)
 
GetObjectLegalHoldRequestWithCustomizedAccessLogTag (Aws::Map< Aws::String, Aws::String > &&value)
 
GetObjectLegalHoldRequestAddCustomizedAccessLogTag (const Aws::String &key, const Aws::String &value)
 
GetObjectLegalHoldRequestAddCustomizedAccessLogTag (Aws::String &&key, const Aws::String &value)
 
GetObjectLegalHoldRequestAddCustomizedAccessLogTag (const Aws::String &key, Aws::String &&value)
 
GetObjectLegalHoldRequestAddCustomizedAccessLogTag (Aws::String &&key, Aws::String &&value)
 
GetObjectLegalHoldRequestAddCustomizedAccessLogTag (const char *key, Aws::String &&value)
 
GetObjectLegalHoldRequestAddCustomizedAccessLogTag (Aws::String &&key, const char *value)
 
GetObjectLegalHoldRequestAddCustomizedAccessLogTag (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 GetObjectLegalHoldRequest.h.

Constructor & Destructor Documentation

◆ GetObjectLegalHoldRequest()

Aws::S3::Model::GetObjectLegalHoldRequest::GetObjectLegalHoldRequest ( )

Member Function Documentation

◆ AddCustomizedAccessLogTag() [1/7]

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

Definition at line 286 of file GetObjectLegalHoldRequest.h.

◆ AddCustomizedAccessLogTag() [2/7]

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

Definition at line 289 of file GetObjectLegalHoldRequest.h.

◆ AddCustomizedAccessLogTag() [3/7]

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

Definition at line 292 of file GetObjectLegalHoldRequest.h.

◆ AddCustomizedAccessLogTag() [4/7]

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

Definition at line 295 of file GetObjectLegalHoldRequest.h.

◆ AddCustomizedAccessLogTag() [5/7]

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

Definition at line 298 of file GetObjectLegalHoldRequest.h.

◆ AddCustomizedAccessLogTag() [6/7]

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

Definition at line 301 of file GetObjectLegalHoldRequest.h.

◆ AddCustomizedAccessLogTag() [7/7]

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

Definition at line 304 of file GetObjectLegalHoldRequest.h.

◆ AddQueryStringParameters()

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

The bucket name containing the object whose Legal Hold status 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 GetObjectLegalHoldRequest.h.

◆ CustomizedAccessLogTagHasBeenSet()

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

Definition at line 271 of file GetObjectLegalHoldRequest.h.

◆ GetBucket()

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

The bucket name containing the object whose Legal Hold status 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 GetObjectLegalHoldRequest.h.

◆ GetCustomizedAccessLogTag()

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

Definition at line 268 of file GetObjectLegalHoldRequest.h.

◆ GetKey()

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

The key name for the object whose Legal Hold status you want to retrieve.

Definition at line 161 of file GetObjectLegalHoldRequest.h.

◆ GetRequestPayer()

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

Definition at line 249 of file GetObjectLegalHoldRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::S3::S3Request.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file GetObjectLegalHoldRequest.h.

◆ GetVersionId()

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

The version ID of the object whose Legal Hold status you want to retrieve.

Definition at line 203 of file GetObjectLegalHoldRequest.h.

◆ KeyHasBeenSet()

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

The key name for the object whose Legal Hold status you want to retrieve.

Definition at line 166 of file GetObjectLegalHoldRequest.h.

◆ RequestPayerHasBeenSet()

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

Definition at line 252 of file GetObjectLegalHoldRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetBucket() [1/3]

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

The bucket name containing the object whose Legal Hold status 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 GetObjectLegalHoldRequest.h.

◆ SetBucket() [2/3]

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

The bucket name containing the object whose Legal Hold status 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 GetObjectLegalHoldRequest.h.

◆ SetBucket() [3/3]

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

The bucket name containing the object whose Legal Hold status 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 GetObjectLegalHoldRequest.h.

◆ SetCustomizedAccessLogTag() [1/2]

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

Definition at line 274 of file GetObjectLegalHoldRequest.h.

◆ SetCustomizedAccessLogTag() [2/2]

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

Definition at line 277 of file GetObjectLegalHoldRequest.h.

◆ SetKey() [1/3]

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

The key name for the object whose Legal Hold status you want to retrieve.

Definition at line 171 of file GetObjectLegalHoldRequest.h.

◆ SetKey() [2/3]

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

The key name for the object whose Legal Hold status you want to retrieve.

Definition at line 176 of file GetObjectLegalHoldRequest.h.

◆ SetKey() [3/3]

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

The key name for the object whose Legal Hold status you want to retrieve.

Definition at line 181 of file GetObjectLegalHoldRequest.h.

◆ SetRequestPayer() [1/2]

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

Definition at line 255 of file GetObjectLegalHoldRequest.h.

◆ SetRequestPayer() [2/2]

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

Definition at line 258 of file GetObjectLegalHoldRequest.h.

◆ SetVersionId() [1/3]

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

The version ID of the object whose Legal Hold status you want to retrieve.

Definition at line 215 of file GetObjectLegalHoldRequest.h.

◆ SetVersionId() [2/3]

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

The version ID of the object whose Legal Hold status you want to retrieve.

Definition at line 221 of file GetObjectLegalHoldRequest.h.

◆ SetVersionId() [3/3]

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

The version ID of the object whose Legal Hold status you want to retrieve.

Definition at line 227 of file GetObjectLegalHoldRequest.h.

◆ VersionIdHasBeenSet()

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

The version ID of the object whose Legal Hold status you want to retrieve.

Definition at line 209 of file GetObjectLegalHoldRequest.h.

◆ WithBucket() [1/3]

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

The bucket name containing the object whose Legal Hold status 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 GetObjectLegalHoldRequest.h.

◆ WithBucket() [2/3]

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

The bucket name containing the object whose Legal Hold status 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 GetObjectLegalHoldRequest.h.

◆ WithBucket() [3/3]

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

The bucket name containing the object whose Legal Hold status 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 GetObjectLegalHoldRequest.h.

◆ WithCustomizedAccessLogTag() [1/2]

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

Definition at line 280 of file GetObjectLegalHoldRequest.h.

◆ WithCustomizedAccessLogTag() [2/2]

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

Definition at line 283 of file GetObjectLegalHoldRequest.h.

◆ WithKey() [1/3]

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

The key name for the object whose Legal Hold status you want to retrieve.

Definition at line 186 of file GetObjectLegalHoldRequest.h.

◆ WithKey() [2/3]

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

The key name for the object whose Legal Hold status you want to retrieve.

Definition at line 191 of file GetObjectLegalHoldRequest.h.

◆ WithKey() [3/3]

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

The key name for the object whose Legal Hold status you want to retrieve.

Definition at line 196 of file GetObjectLegalHoldRequest.h.

◆ WithRequestPayer() [1/2]

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

Definition at line 261 of file GetObjectLegalHoldRequest.h.

◆ WithRequestPayer() [2/2]

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

Definition at line 264 of file GetObjectLegalHoldRequest.h.

◆ WithVersionId() [1/3]

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

The version ID of the object whose Legal Hold status you want to retrieve.

Definition at line 233 of file GetObjectLegalHoldRequest.h.

◆ WithVersionId() [2/3]

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

The version ID of the object whose Legal Hold status you want to retrieve.

Definition at line 239 of file GetObjectLegalHoldRequest.h.

◆ WithVersionId() [3/3]

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

The version ID of the object whose Legal Hold status you want to retrieve.

Definition at line 245 of file GetObjectLegalHoldRequest.h.


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