AWS SDK for C++

AWS SDK for C++ Version 1.11.617

Loading...
Searching...
No Matches
Public Member Functions | List of all members
Aws::S3::Model::PutObjectLockConfigurationRequest Class Reference

#include <PutObjectLockConfigurationRequest.h>

Inheritance diagram for Aws::S3::Model::PutObjectLockConfigurationRequest:
[legend]

Public Member Functions

AWS_S3_API PutObjectLockConfigurationRequest ()=default
 
virtual const char * GetServiceRequestName () const override
 
AWS_S3_API Aws::String SerializePayload () const override
 
AWS_S3_API void AddQueryStringParameters (Aws::Http::URI &uri) const override
 
 
AWS_S3_API bool HasEmbeddedError (IOStream &body, const Http::HeaderValueCollection &header) const override
 
AWS_S3_API Aws::String GetChecksumAlgorithmName () const override
 
bool RequestChecksumRequired () const override
 
AWS_S3_API EndpointParameters GetEndpointContextParams () const override
 
const Aws::StringGetBucket () const
 
bool BucketHasBeenSet () const
 
template<typename BucketT = Aws::String>
void SetBucket (BucketT &&value)
 
template<typename BucketT = Aws::String>
 
 
 
template<typename ObjectLockConfigurationT = ObjectLockConfiguration>
void SetObjectLockConfiguration (ObjectLockConfigurationT &&value)
 
template<typename ObjectLockConfigurationT = ObjectLockConfiguration>
 
 
bool RequestPayerHasBeenSet () const
 
 
 
const Aws::StringGetToken () const
 
bool TokenHasBeenSet () const
 
template<typename TokenT = Aws::String>
void SetToken (TokenT &&value)
 
template<typename TokenT = Aws::String>
 
const Aws::StringGetContentMD5 () const
 
bool ContentMD5HasBeenSet () const
 
template<typename ContentMD5T = Aws::String>
void SetContentMD5 (ContentMD5T &&value)
 
template<typename ContentMD5T = Aws::String>
 
 
 
 
 
 
 
template<typename ExpectedBucketOwnerT = Aws::String>
void SetExpectedBucketOwner (ExpectedBucketOwnerT &&value)
 
template<typename ExpectedBucketOwnerT = Aws::String>
 
 
 
template<typename CustomizedAccessLogTagT = Aws::Map<Aws::String, Aws::String>>
void SetCustomizedAccessLogTag (CustomizedAccessLogTagT &&value)
 
template<typename CustomizedAccessLogTagT = Aws::Map<Aws::String, Aws::String>>
 
template<typename CustomizedAccessLogTagKeyT = Aws::String, typename CustomizedAccessLogTagValueT = Aws::String>
PutObjectLockConfigurationRequestAddCustomizedAccessLogTag (CustomizedAccessLogTagKeyT &&key, CustomizedAccessLogTagValueT &&value)
 

Public Member Functions inherited from Aws::S3::S3Request

virtual ~S3Request ()
 
 
 

Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest

 
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 

Public Member Functions inherited from Aws::AmazonWebServiceRequest

 
virtual ~AmazonWebServiceRequest ()=default
 
 
virtual void SetAdditionalCustomHeaderValue (const Aws::String &headerName, const Aws::String &headerValue)
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool HasEventStreamResponse () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
 
 
 
 
 
 
 
 
virtual bool ShouldComputeContentMd5 () const
 
virtual bool ShouldValidateResponseChecksum () const
 
 
virtual void SetServiceSpecificParameters (const std::shared_ptr< Http::ServiceSpecificParameters > &serviceSpecificParameters) const
 
 
 
 
 
virtual void SetHeadersReceivedEventHandler (const Aws::Http::HeadersReceivedEventHandler &headersReceivedEventHandler)
 
virtual void SetHeadersReceivedEventHandler (Aws::Http::HeadersReceivedEventHandler &&headersReceivedEventHandler)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
 
virtual void SetHeadersReceivedEventHandler (const Aws::Http::HeadersReceivedEventHandler &headersReceivedEventHandler)
 
virtual void SetHeadersReceivedEventHandler (Aws::Http::HeadersReceivedEventHandler &&headersReceivedEventHandler)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
 

Additional Inherited Members

Public Types inherited from Aws::S3::S3Request

 
 

Public Types inherited from Aws::AmazonWebServiceRequest

 

Protected Member Functions inherited from Aws::AmazonWebServiceRequest

virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Protected Attributes inherited from Aws::AmazonWebServiceRequest

 

Detailed Description

Definition at line 29 of file PutObjectLockConfigurationRequest.h.

Constructor & Destructor Documentation

◆ PutObjectLockConfigurationRequest()

AWS_S3_API Aws::S3::Model::PutObjectLockConfigurationRequest::PutObjectLockConfigurationRequest ( )
default

Member Function Documentation

◆ AddCustomizedAccessLogTag()

template<typename CustomizedAccessLogTagKeyT = Aws::String, typename CustomizedAccessLogTagValueT = Aws::String>
PutObjectLockConfigurationRequest & Aws::S3::Model::PutObjectLockConfigurationRequest::AddCustomizedAccessLogTag ( CustomizedAccessLogTagKeyT &&  key,
CustomizedAccessLogTagValueT &&  value 
)
inline

Definition at line 156 of file PutObjectLockConfigurationRequest.h.

◆ AddQueryStringParameters()

AWS_S3_API void Aws::S3::Model::PutObjectLockConfigurationRequest::AddQueryStringParameters ( Aws::Http::URI uri) const
overridevirtual

Reimplemented from Aws::AmazonWebServiceRequest.

◆ BucketHasBeenSet()

bool Aws::S3::Model::PutObjectLockConfigurationRequest::BucketHasBeenSet ( ) const
inline

The bucket whose Object Lock configuration you want to create or replace.

Definition at line 60 of file PutObjectLockConfigurationRequest.h.

◆ ChecksumAlgorithmHasBeenSet()

bool Aws::S3::Model::PutObjectLockConfigurationRequest::ChecksumAlgorithmHasBeenSet ( ) const
inline

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

Definition at line 128 of file PutObjectLockConfigurationRequest.h.

◆ ContentMD5HasBeenSet()

bool Aws::S3::Model::PutObjectLockConfigurationRequest::ContentMD5HasBeenSet ( ) const
inline

The MD5 hash for the request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

Definition at line 107 of file PutObjectLockConfigurationRequest.h.

◆ CustomizedAccessLogTagHasBeenSet()

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

Definition at line 150 of file PutObjectLockConfigurationRequest.h.

◆ ExpectedBucketOwnerHasBeenSet()

bool Aws::S3::Model::PutObjectLockConfigurationRequest::ExpectedBucketOwnerHasBeenSet ( ) const
inline

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

Definition at line 140 of file PutObjectLockConfigurationRequest.h.

◆ GetBucket()

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

The bucket whose Object Lock configuration you want to create or replace.

Definition at line 59 of file PutObjectLockConfigurationRequest.h.

◆ GetChecksumAlgorithm()

ChecksumAlgorithm Aws::S3::Model::PutObjectLockConfigurationRequest::GetChecksumAlgorithm ( ) const
inline

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

Definition at line 127 of file PutObjectLockConfigurationRequest.h.

◆ GetChecksumAlgorithmName()

AWS_S3_API Aws::String Aws::S3::Model::PutObjectLockConfigurationRequest::GetChecksumAlgorithmName ( ) const
overridevirtual

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetContentMD5()

const Aws::String & Aws::S3::Model::PutObjectLockConfigurationRequest::GetContentMD5 ( ) const
inline

The MD5 hash for the request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

Definition at line 106 of file PutObjectLockConfigurationRequest.h.

◆ GetCustomizedAccessLogTag()

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

Definition at line 149 of file PutObjectLockConfigurationRequest.h.

◆ GetEndpointContextParams()

AWS_S3_API EndpointParameters Aws::S3::Model::PutObjectLockConfigurationRequest::GetEndpointContextParams ( ) const
overridevirtual

Helper function to collect parameters (configurable and static hardcoded) required for endpoint computation.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetExpectedBucketOwner()

const Aws::String & Aws::S3::Model::PutObjectLockConfigurationRequest::GetExpectedBucketOwner ( ) const
inline

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

Definition at line 139 of file PutObjectLockConfigurationRequest.h.

◆ GetObjectLockConfiguration()

const ObjectLockConfiguration & Aws::S3::Model::PutObjectLockConfigurationRequest::GetObjectLockConfiguration ( ) const
inline

The Object Lock configuration that you want to apply to the specified bucket.

Definition at line 72 of file PutObjectLockConfigurationRequest.h.

◆ GetRequestPayer()

RequestPayer Aws::S3::Model::PutObjectLockConfigurationRequest::GetRequestPayer ( ) const
inline

Definition at line 82 of file PutObjectLockConfigurationRequest.h.

◆ GetRequestSpecificHeaders()

AWS_S3_API Aws::Http::HeaderValueCollection Aws::S3::Model::PutObjectLockConfigurationRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::S3::S3Request.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 38 of file PutObjectLockConfigurationRequest.h.

◆ GetToken()

const Aws::String & Aws::S3::Model::PutObjectLockConfigurationRequest::GetToken ( ) const
inline

A token to allow Object Lock to be enabled for an existing bucket.

Definition at line 92 of file PutObjectLockConfigurationRequest.h.

◆ HasEmbeddedError()

AWS_S3_API bool Aws::S3::Model::PutObjectLockConfigurationRequest::HasEmbeddedError ( IOStream body,
const Http::HeaderValueCollection header 
) const
overridevirtual

Reimplemented from Aws::AmazonWebServiceRequest.

◆ ObjectLockConfigurationHasBeenSet()

bool Aws::S3::Model::PutObjectLockConfigurationRequest::ObjectLockConfigurationHasBeenSet ( ) const
inline

The Object Lock configuration that you want to apply to the specified bucket.

Definition at line 73 of file PutObjectLockConfigurationRequest.h.

◆ RequestChecksumRequired()

bool Aws::S3::Model::PutObjectLockConfigurationRequest::RequestChecksumRequired ( ) const
inlineoverridevirtual

Reimplemented from Aws::AmazonWebServiceRequest.

Definition at line 48 of file PutObjectLockConfigurationRequest.h.

◆ RequestPayerHasBeenSet()

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

Definition at line 83 of file PutObjectLockConfigurationRequest.h.

◆ SerializePayload()

AWS_S3_API Aws::String Aws::S3::Model::PutObjectLockConfigurationRequest::SerializePayload ( ) const
overridevirtual

◆ SetBucket()

template<typename BucketT = Aws::String>
void Aws::S3::Model::PutObjectLockConfigurationRequest::SetBucket ( BucketT &&  value)
inline

The bucket whose Object Lock configuration you want to create or replace.

Definition at line 62 of file PutObjectLockConfigurationRequest.h.

◆ SetChecksumAlgorithm()

void Aws::S3::Model::PutObjectLockConfigurationRequest::SetChecksumAlgorithm ( ChecksumAlgorithm  value)
inline

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

Definition at line 129 of file PutObjectLockConfigurationRequest.h.

◆ SetContentMD5()

template<typename ContentMD5T = Aws::String>
void Aws::S3::Model::PutObjectLockConfigurationRequest::SetContentMD5 ( ContentMD5T &&  value)
inline

The MD5 hash for the request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

Definition at line 109 of file PutObjectLockConfigurationRequest.h.

◆ SetCustomizedAccessLogTag()

template<typename CustomizedAccessLogTagT = Aws::Map<Aws::String, Aws::String>>
void Aws::S3::Model::PutObjectLockConfigurationRequest::SetCustomizedAccessLogTag ( CustomizedAccessLogTagT &&  value)
inline

Definition at line 152 of file PutObjectLockConfigurationRequest.h.

◆ SetExpectedBucketOwner()

template<typename ExpectedBucketOwnerT = Aws::String>
void Aws::S3::Model::PutObjectLockConfigurationRequest::SetExpectedBucketOwner ( ExpectedBucketOwnerT &&  value)
inline

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

Definition at line 142 of file PutObjectLockConfigurationRequest.h.

◆ SetObjectLockConfiguration()

template<typename ObjectLockConfigurationT = ObjectLockConfiguration>
void Aws::S3::Model::PutObjectLockConfigurationRequest::SetObjectLockConfiguration ( ObjectLockConfigurationT &&  value)
inline

The Object Lock configuration that you want to apply to the specified bucket.

Definition at line 75 of file PutObjectLockConfigurationRequest.h.

◆ SetRequestPayer()

void Aws::S3::Model::PutObjectLockConfigurationRequest::SetRequestPayer ( RequestPayer  value)
inline

Definition at line 84 of file PutObjectLockConfigurationRequest.h.

◆ SetToken()

template<typename TokenT = Aws::String>
void Aws::S3::Model::PutObjectLockConfigurationRequest::SetToken ( TokenT &&  value)
inline

A token to allow Object Lock to be enabled for an existing bucket.

Definition at line 95 of file PutObjectLockConfigurationRequest.h.

◆ TokenHasBeenSet()

bool Aws::S3::Model::PutObjectLockConfigurationRequest::TokenHasBeenSet ( ) const
inline

A token to allow Object Lock to be enabled for an existing bucket.

Definition at line 93 of file PutObjectLockConfigurationRequest.h.

◆ WithBucket()

template<typename BucketT = Aws::String>
PutObjectLockConfigurationRequest & Aws::S3::Model::PutObjectLockConfigurationRequest::WithBucket ( BucketT &&  value)
inline

The bucket whose Object Lock configuration you want to create or replace.

Definition at line 64 of file PutObjectLockConfigurationRequest.h.

◆ WithChecksumAlgorithm()

PutObjectLockConfigurationRequest & Aws::S3::Model::PutObjectLockConfigurationRequest::WithChecksumAlgorithm ( ChecksumAlgorithm  value)
inline

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

Definition at line 130 of file PutObjectLockConfigurationRequest.h.

◆ WithContentMD5()

template<typename ContentMD5T = Aws::String>
PutObjectLockConfigurationRequest & Aws::S3::Model::PutObjectLockConfigurationRequest::WithContentMD5 ( ContentMD5T &&  value)
inline

The MD5 hash for the request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

Definition at line 111 of file PutObjectLockConfigurationRequest.h.

◆ WithCustomizedAccessLogTag()

template<typename CustomizedAccessLogTagT = Aws::Map<Aws::String, Aws::String>>
PutObjectLockConfigurationRequest & Aws::S3::Model::PutObjectLockConfigurationRequest::WithCustomizedAccessLogTag ( CustomizedAccessLogTagT &&  value)
inline

Definition at line 154 of file PutObjectLockConfigurationRequest.h.

◆ WithExpectedBucketOwner()

template<typename ExpectedBucketOwnerT = Aws::String>
PutObjectLockConfigurationRequest & Aws::S3::Model::PutObjectLockConfigurationRequest::WithExpectedBucketOwner ( ExpectedBucketOwnerT &&  value)
inline

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

Definition at line 144 of file PutObjectLockConfigurationRequest.h.

◆ WithObjectLockConfiguration()

template<typename ObjectLockConfigurationT = ObjectLockConfiguration>
PutObjectLockConfigurationRequest & Aws::S3::Model::PutObjectLockConfigurationRequest::WithObjectLockConfiguration ( ObjectLockConfigurationT &&  value)
inline

The Object Lock configuration that you want to apply to the specified bucket.

Definition at line 77 of file PutObjectLockConfigurationRequest.h.

◆ WithRequestPayer()

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

Definition at line 85 of file PutObjectLockConfigurationRequest.h.

◆ WithToken()

template<typename TokenT = Aws::String>
PutObjectLockConfigurationRequest & Aws::S3::Model::PutObjectLockConfigurationRequest::WithToken ( TokenT &&  value)
inline

A token to allow Object Lock to be enabled for an existing bucket.

Definition at line 97 of file PutObjectLockConfigurationRequest.h.


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