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

#include <DeleteObjectsRequest.h>

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

Public Member Functions

 DeleteObjectsRequest ()
 
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
 
bool ShouldComputeContentMd5 () 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)
 
DeleteObjectsRequestWithBucket (const Aws::String &value)
 
DeleteObjectsRequestWithBucket (Aws::String &&value)
 
DeleteObjectsRequestWithBucket (const char *value)
 
const DeleteGetDelete () const
 
bool DeleteHasBeenSet () const
 
void SetDelete (const Delete &value)
 
void SetDelete (Delete &&value)
 
DeleteObjectsRequestWithDelete (const Delete &value)
 
DeleteObjectsRequestWithDelete (Delete &&value)
 
const Aws::StringGetMFA () const
 
bool MFAHasBeenSet () const
 
void SetMFA (const Aws::String &value)
 
void SetMFA (Aws::String &&value)
 
void SetMFA (const char *value)
 
DeleteObjectsRequestWithMFA (const Aws::String &value)
 
DeleteObjectsRequestWithMFA (Aws::String &&value)
 
DeleteObjectsRequestWithMFA (const char *value)
 
const RequestPayerGetRequestPayer () const
 
bool RequestPayerHasBeenSet () const
 
void SetRequestPayer (const RequestPayer &value)
 
void SetRequestPayer (RequestPayer &&value)
 
DeleteObjectsRequestWithRequestPayer (const RequestPayer &value)
 
DeleteObjectsRequestWithRequestPayer (RequestPayer &&value)
 
bool GetBypassGovernanceRetention () const
 
bool BypassGovernanceRetentionHasBeenSet () const
 
void SetBypassGovernanceRetention (bool value)
 
DeleteObjectsRequestWithBypassGovernanceRetention (bool 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)
 
DeleteObjectsRequestWithCustomizedAccessLogTag (const Aws::Map< Aws::String, Aws::String > &value)
 
DeleteObjectsRequestWithCustomizedAccessLogTag (Aws::Map< Aws::String, Aws::String > &&value)
 
DeleteObjectsRequestAddCustomizedAccessLogTag (const Aws::String &key, const Aws::String &value)
 
DeleteObjectsRequestAddCustomizedAccessLogTag (Aws::String &&key, const Aws::String &value)
 
DeleteObjectsRequestAddCustomizedAccessLogTag (const Aws::String &key, Aws::String &&value)
 
DeleteObjectsRequestAddCustomizedAccessLogTag (Aws::String &&key, Aws::String &&value)
 
DeleteObjectsRequestAddCustomizedAccessLogTag (const char *key, Aws::String &&value)
 
DeleteObjectsRequestAddCustomizedAccessLogTag (Aws::String &&key, const char *value)
 
DeleteObjectsRequestAddCustomizedAccessLogTag (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
 

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 DeleteObjectsRequest.h.

Constructor & Destructor Documentation

◆ DeleteObjectsRequest()

Aws::S3::Model::DeleteObjectsRequest::DeleteObjectsRequest ( )

Member Function Documentation

◆ AddCustomizedAccessLogTag() [1/7]

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

Definition at line 324 of file DeleteObjectsRequest.h.

◆ AddCustomizedAccessLogTag() [2/7]

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

Definition at line 327 of file DeleteObjectsRequest.h.

◆ AddCustomizedAccessLogTag() [3/7]

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

Definition at line 330 of file DeleteObjectsRequest.h.

◆ AddCustomizedAccessLogTag() [4/7]

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

Definition at line 333 of file DeleteObjectsRequest.h.

◆ AddCustomizedAccessLogTag() [5/7]

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

Definition at line 336 of file DeleteObjectsRequest.h.

◆ AddCustomizedAccessLogTag() [6/7]

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

Definition at line 339 of file DeleteObjectsRequest.h.

◆ AddCustomizedAccessLogTag() [7/7]

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

Definition at line 342 of file DeleteObjectsRequest.h.

◆ AddQueryStringParameters()

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

The bucket name containing the objects to delete.

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 74 of file DeleteObjectsRequest.h.

◆ BypassGovernanceRetentionHasBeenSet()

bool Aws::S3::Model::DeleteObjectsRequest::BypassGovernanceRetentionHasBeenSet ( ) const
inline

Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place. You must have sufficient permissions to perform this operation.

Definition at line 288 of file DeleteObjectsRequest.h.

◆ CustomizedAccessLogTagHasBeenSet()

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

Definition at line 309 of file DeleteObjectsRequest.h.

◆ DeleteHasBeenSet()

bool Aws::S3::Model::DeleteObjectsRequest::DeleteHasBeenSet ( ) const
inline

Container for the request.

Definition at line 169 of file DeleteObjectsRequest.h.

◆ GetBucket()

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

The bucket name containing the objects to delete.

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 60 of file DeleteObjectsRequest.h.

◆ GetBypassGovernanceRetention()

bool Aws::S3::Model::DeleteObjectsRequest::GetBypassGovernanceRetention ( ) const
inline

Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place. You must have sufficient permissions to perform this operation.

Definition at line 281 of file DeleteObjectsRequest.h.

◆ GetCustomizedAccessLogTag()

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

Definition at line 306 of file DeleteObjectsRequest.h.

◆ GetDelete()

const Delete& Aws::S3::Model::DeleteObjectsRequest::GetDelete ( ) const
inline

Container for the request.

Definition at line 164 of file DeleteObjectsRequest.h.

◆ GetMFA()

const Aws::String& Aws::S3::Model::DeleteObjectsRequest::GetMFA ( ) const
inline

The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.

Definition at line 198 of file DeleteObjectsRequest.h.

◆ GetRequestPayer()

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

Definition at line 258 of file DeleteObjectsRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::S3::S3Request.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file DeleteObjectsRequest.h.

◆ MFAHasBeenSet()

bool Aws::S3::Model::DeleteObjectsRequest::MFAHasBeenSet ( ) const
inline

The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.

Definition at line 206 of file DeleteObjectsRequest.h.

◆ RequestPayerHasBeenSet()

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

Definition at line 261 of file DeleteObjectsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetBucket() [1/3]

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

The bucket name containing the objects to delete.

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 88 of file DeleteObjectsRequest.h.

◆ SetBucket() [2/3]

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

The bucket name containing the objects to delete.

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 102 of file DeleteObjectsRequest.h.

◆ SetBucket() [3/3]

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

The bucket name containing the objects to delete.

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 116 of file DeleteObjectsRequest.h.

◆ SetBypassGovernanceRetention()

void Aws::S3::Model::DeleteObjectsRequest::SetBypassGovernanceRetention ( bool  value)
inline

Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place. You must have sufficient permissions to perform this operation.

Definition at line 295 of file DeleteObjectsRequest.h.

◆ SetCustomizedAccessLogTag() [1/2]

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

Definition at line 312 of file DeleteObjectsRequest.h.

◆ SetCustomizedAccessLogTag() [2/2]

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

Definition at line 315 of file DeleteObjectsRequest.h.

◆ SetDelete() [1/2]

void Aws::S3::Model::DeleteObjectsRequest::SetDelete ( const Delete value)
inline

Container for the request.

Definition at line 174 of file DeleteObjectsRequest.h.

◆ SetDelete() [2/2]

void Aws::S3::Model::DeleteObjectsRequest::SetDelete ( Delete &&  value)
inline

Container for the request.

Definition at line 179 of file DeleteObjectsRequest.h.

◆ SetMFA() [1/3]

void Aws::S3::Model::DeleteObjectsRequest::SetMFA ( const Aws::String value)
inline

The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.

Definition at line 214 of file DeleteObjectsRequest.h.

◆ SetMFA() [2/3]

void Aws::S3::Model::DeleteObjectsRequest::SetMFA ( Aws::String &&  value)
inline

The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.

Definition at line 222 of file DeleteObjectsRequest.h.

◆ SetMFA() [3/3]

void Aws::S3::Model::DeleteObjectsRequest::SetMFA ( const char *  value)
inline

The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.

Definition at line 230 of file DeleteObjectsRequest.h.

◆ SetRequestPayer() [1/2]

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

Definition at line 264 of file DeleteObjectsRequest.h.

◆ SetRequestPayer() [2/2]

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

Definition at line 267 of file DeleteObjectsRequest.h.

◆ ShouldComputeContentMd5()

bool Aws::S3::Model::DeleteObjectsRequest::ShouldComputeContentMd5 ( ) const
inlineoverridevirtual

If this is set to true, content-md5 needs to be computed and set on the request

Reimplemented from Aws::AmazonWebServiceRequest.

Definition at line 45 of file DeleteObjectsRequest.h.

◆ WithBucket() [1/3]

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

The bucket name containing the objects to delete.

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 130 of file DeleteObjectsRequest.h.

◆ WithBucket() [2/3]

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

The bucket name containing the objects to delete.

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 144 of file DeleteObjectsRequest.h.

◆ WithBucket() [3/3]

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

The bucket name containing the objects to delete.

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 158 of file DeleteObjectsRequest.h.

◆ WithBypassGovernanceRetention()

DeleteObjectsRequest& Aws::S3::Model::DeleteObjectsRequest::WithBypassGovernanceRetention ( bool  value)
inline

Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place. You must have sufficient permissions to perform this operation.

Definition at line 302 of file DeleteObjectsRequest.h.

◆ WithCustomizedAccessLogTag() [1/2]

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

Definition at line 318 of file DeleteObjectsRequest.h.

◆ WithCustomizedAccessLogTag() [2/2]

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

Definition at line 321 of file DeleteObjectsRequest.h.

◆ WithDelete() [1/2]

DeleteObjectsRequest& Aws::S3::Model::DeleteObjectsRequest::WithDelete ( const Delete value)
inline

Container for the request.

Definition at line 184 of file DeleteObjectsRequest.h.

◆ WithDelete() [2/2]

DeleteObjectsRequest& Aws::S3::Model::DeleteObjectsRequest::WithDelete ( Delete &&  value)
inline

Container for the request.

Definition at line 189 of file DeleteObjectsRequest.h.

◆ WithMFA() [1/3]

DeleteObjectsRequest& Aws::S3::Model::DeleteObjectsRequest::WithMFA ( const Aws::String value)
inline

The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.

Definition at line 238 of file DeleteObjectsRequest.h.

◆ WithMFA() [2/3]

DeleteObjectsRequest& Aws::S3::Model::DeleteObjectsRequest::WithMFA ( Aws::String &&  value)
inline

The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.

Definition at line 246 of file DeleteObjectsRequest.h.

◆ WithMFA() [3/3]

DeleteObjectsRequest& Aws::S3::Model::DeleteObjectsRequest::WithMFA ( const char *  value)
inline

The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.

Definition at line 254 of file DeleteObjectsRequest.h.

◆ WithRequestPayer() [1/2]

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

Definition at line 270 of file DeleteObjectsRequest.h.

◆ WithRequestPayer() [2/2]

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

Definition at line 273 of file DeleteObjectsRequest.h.


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