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

#include <PutObjectTaggingRequest.h>

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

Public Member Functions

 PutObjectTaggingRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
void AddQueryStringParameters (Aws::Http::URI &uri) 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)
 
PutObjectTaggingRequestWithBucket (const Aws::String &value)
 
PutObjectTaggingRequestWithBucket (Aws::String &&value)
 
PutObjectTaggingRequestWithBucket (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)
 
PutObjectTaggingRequestWithKey (const Aws::String &value)
 
PutObjectTaggingRequestWithKey (Aws::String &&value)
 
PutObjectTaggingRequestWithKey (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)
 
PutObjectTaggingRequestWithVersionId (const Aws::String &value)
 
PutObjectTaggingRequestWithVersionId (Aws::String &&value)
 
PutObjectTaggingRequestWithVersionId (const char *value)
 
const TaggingGetTagging () const
 
bool TaggingHasBeenSet () const
 
void SetTagging (const Tagging &value)
 
void SetTagging (Tagging &&value)
 
PutObjectTaggingRequestWithTagging (const Tagging &value)
 
PutObjectTaggingRequestWithTagging (Tagging &&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)
 
PutObjectTaggingRequestWithCustomizedAccessLogTag (const Aws::Map< Aws::String, Aws::String > &value)
 
PutObjectTaggingRequestWithCustomizedAccessLogTag (Aws::Map< Aws::String, Aws::String > &&value)
 
PutObjectTaggingRequestAddCustomizedAccessLogTag (const Aws::String &key, const Aws::String &value)
 
PutObjectTaggingRequestAddCustomizedAccessLogTag (Aws::String &&key, const Aws::String &value)
 
PutObjectTaggingRequestAddCustomizedAccessLogTag (const Aws::String &key, Aws::String &&value)
 
PutObjectTaggingRequestAddCustomizedAccessLogTag (Aws::String &&key, Aws::String &&value)
 
PutObjectTaggingRequestAddCustomizedAccessLogTag (const char *key, Aws::String &&value)
 
PutObjectTaggingRequestAddCustomizedAccessLogTag (Aws::String &&key, const char *value)
 
PutObjectTaggingRequestAddCustomizedAccessLogTag (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::S3::S3Request
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 27 of file PutObjectTaggingRequest.h.

Constructor & Destructor Documentation

◆ PutObjectTaggingRequest()

Aws::S3::Model::PutObjectTaggingRequest::PutObjectTaggingRequest ( )

Member Function Documentation

◆ AddCustomizedAccessLogTag() [1/7]

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

Definition at line 290 of file PutObjectTaggingRequest.h.

◆ AddCustomizedAccessLogTag() [2/7]

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

Definition at line 293 of file PutObjectTaggingRequest.h.

◆ AddCustomizedAccessLogTag() [3/7]

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

Definition at line 296 of file PutObjectTaggingRequest.h.

◆ AddCustomizedAccessLogTag() [4/7]

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

Definition at line 299 of file PutObjectTaggingRequest.h.

◆ AddCustomizedAccessLogTag() [5/7]

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

Definition at line 302 of file PutObjectTaggingRequest.h.

◆ AddCustomizedAccessLogTag() [6/7]

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

Definition at line 305 of file PutObjectTaggingRequest.h.

◆ AddCustomizedAccessLogTag() [7/7]

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

Definition at line 308 of file PutObjectTaggingRequest.h.

◆ AddQueryStringParameters()

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

◆ CustomizedAccessLogTagHasBeenSet()

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

Definition at line 275 of file PutObjectTaggingRequest.h.

◆ GetBucket()

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

◆ GetCustomizedAccessLogTag()

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

Definition at line 272 of file PutObjectTaggingRequest.h.

◆ GetKey()

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

Name of the tag.

Definition at line 161 of file PutObjectTaggingRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file PutObjectTaggingRequest.h.

◆ GetTagging()

const Tagging& Aws::S3::Model::PutObjectTaggingRequest::GetTagging ( ) const
inline

Container for the TagSet and Tag elements

Definition at line 243 of file PutObjectTaggingRequest.h.

◆ GetVersionId()

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

The versionId of the object that the tag-set will be added to.

Definition at line 202 of file PutObjectTaggingRequest.h.

◆ KeyHasBeenSet()

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

Name of the tag.

Definition at line 166 of file PutObjectTaggingRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetBucket() [1/3]

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

◆ SetBucket() [2/3]

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

◆ SetBucket() [3/3]

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

◆ SetCustomizedAccessLogTag() [1/2]

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

Definition at line 278 of file PutObjectTaggingRequest.h.

◆ SetCustomizedAccessLogTag() [2/2]

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

Definition at line 281 of file PutObjectTaggingRequest.h.

◆ SetKey() [1/3]

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

Name of the tag.

Definition at line 171 of file PutObjectTaggingRequest.h.

◆ SetKey() [2/3]

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

Name of the tag.

Definition at line 176 of file PutObjectTaggingRequest.h.

◆ SetKey() [3/3]

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

Name of the tag.

Definition at line 181 of file PutObjectTaggingRequest.h.

◆ SetTagging() [1/2]

void Aws::S3::Model::PutObjectTaggingRequest::SetTagging ( const Tagging value)
inline

Container for the TagSet and Tag elements

Definition at line 253 of file PutObjectTaggingRequest.h.

◆ SetTagging() [2/2]

void Aws::S3::Model::PutObjectTaggingRequest::SetTagging ( Tagging &&  value)
inline

Container for the TagSet and Tag elements

Definition at line 258 of file PutObjectTaggingRequest.h.

◆ SetVersionId() [1/3]

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

The versionId of the object that the tag-set will be added to.

Definition at line 212 of file PutObjectTaggingRequest.h.

◆ SetVersionId() [2/3]

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

The versionId of the object that the tag-set will be added to.

Definition at line 217 of file PutObjectTaggingRequest.h.

◆ SetVersionId() [3/3]

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

The versionId of the object that the tag-set will be added to.

Definition at line 222 of file PutObjectTaggingRequest.h.

◆ ShouldComputeContentMd5()

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

◆ TaggingHasBeenSet()

bool Aws::S3::Model::PutObjectTaggingRequest::TaggingHasBeenSet ( ) const
inline

Container for the TagSet and Tag elements

Definition at line 248 of file PutObjectTaggingRequest.h.

◆ VersionIdHasBeenSet()

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

The versionId of the object that the tag-set will be added to.

Definition at line 207 of file PutObjectTaggingRequest.h.

◆ WithBucket() [1/3]

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

◆ WithBucket() [2/3]

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

◆ WithBucket() [3/3]

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

◆ WithCustomizedAccessLogTag() [1/2]

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

Definition at line 284 of file PutObjectTaggingRequest.h.

◆ WithCustomizedAccessLogTag() [2/2]

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

Definition at line 287 of file PutObjectTaggingRequest.h.

◆ WithKey() [1/3]

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

Name of the tag.

Definition at line 186 of file PutObjectTaggingRequest.h.

◆ WithKey() [2/3]

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

Name of the tag.

Definition at line 191 of file PutObjectTaggingRequest.h.

◆ WithKey() [3/3]

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

Name of the tag.

Definition at line 196 of file PutObjectTaggingRequest.h.

◆ WithTagging() [1/2]

PutObjectTaggingRequest& Aws::S3::Model::PutObjectTaggingRequest::WithTagging ( const Tagging value)
inline

Container for the TagSet and Tag elements

Definition at line 263 of file PutObjectTaggingRequest.h.

◆ WithTagging() [2/2]

PutObjectTaggingRequest& Aws::S3::Model::PutObjectTaggingRequest::WithTagging ( Tagging &&  value)
inline

Container for the TagSet and Tag elements

Definition at line 268 of file PutObjectTaggingRequest.h.

◆ WithVersionId() [1/3]

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

The versionId of the object that the tag-set will be added to.

Definition at line 227 of file PutObjectTaggingRequest.h.

◆ WithVersionId() [2/3]

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

The versionId of the object that the tag-set will be added to.

Definition at line 232 of file PutObjectTaggingRequest.h.

◆ WithVersionId() [3/3]

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

The versionId of the object that the tag-set will be added to.

Definition at line 237 of file PutObjectTaggingRequest.h.


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