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

#include <UploadPartRequest.h>

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

Public Member Functions

 UploadPartRequest ()
 
virtual const char * GetServiceRequestName () 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)
 
UploadPartRequestWithBucket (const Aws::String &value)
 
UploadPartRequestWithBucket (Aws::String &&value)
 
UploadPartRequestWithBucket (const char *value)
 
long long GetContentLength () const
 
bool ContentLengthHasBeenSet () const
 
void SetContentLength (long long value)
 
UploadPartRequestWithContentLength (long long value)
 
const Aws::StringGetContentMD5 () const
 
bool ContentMD5HasBeenSet () const
 
void SetContentMD5 (const Aws::String &value)
 
void SetContentMD5 (Aws::String &&value)
 
void SetContentMD5 (const char *value)
 
UploadPartRequestWithContentMD5 (const Aws::String &value)
 
UploadPartRequestWithContentMD5 (Aws::String &&value)
 
UploadPartRequestWithContentMD5 (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)
 
UploadPartRequestWithKey (const Aws::String &value)
 
UploadPartRequestWithKey (Aws::String &&value)
 
UploadPartRequestWithKey (const char *value)
 
int GetPartNumber () const
 
bool PartNumberHasBeenSet () const
 
void SetPartNumber (int value)
 
UploadPartRequestWithPartNumber (int value)
 
const Aws::StringGetUploadId () const
 
bool UploadIdHasBeenSet () const
 
void SetUploadId (const Aws::String &value)
 
void SetUploadId (Aws::String &&value)
 
void SetUploadId (const char *value)
 
UploadPartRequestWithUploadId (const Aws::String &value)
 
UploadPartRequestWithUploadId (Aws::String &&value)
 
UploadPartRequestWithUploadId (const char *value)
 
const Aws::StringGetSSECustomerAlgorithm () const
 
bool SSECustomerAlgorithmHasBeenSet () const
 
void SetSSECustomerAlgorithm (const Aws::String &value)
 
void SetSSECustomerAlgorithm (Aws::String &&value)
 
void SetSSECustomerAlgorithm (const char *value)
 
UploadPartRequestWithSSECustomerAlgorithm (const Aws::String &value)
 
UploadPartRequestWithSSECustomerAlgorithm (Aws::String &&value)
 
UploadPartRequestWithSSECustomerAlgorithm (const char *value)
 
const Aws::StringGetSSECustomerKey () const
 
bool SSECustomerKeyHasBeenSet () const
 
void SetSSECustomerKey (const Aws::String &value)
 
void SetSSECustomerKey (Aws::String &&value)
 
void SetSSECustomerKey (const char *value)
 
UploadPartRequestWithSSECustomerKey (const Aws::String &value)
 
UploadPartRequestWithSSECustomerKey (Aws::String &&value)
 
UploadPartRequestWithSSECustomerKey (const char *value)
 
const Aws::StringGetSSECustomerKeyMD5 () const
 
bool SSECustomerKeyMD5HasBeenSet () const
 
void SetSSECustomerKeyMD5 (const Aws::String &value)
 
void SetSSECustomerKeyMD5 (Aws::String &&value)
 
void SetSSECustomerKeyMD5 (const char *value)
 
UploadPartRequestWithSSECustomerKeyMD5 (const Aws::String &value)
 
UploadPartRequestWithSSECustomerKeyMD5 (Aws::String &&value)
 
UploadPartRequestWithSSECustomerKeyMD5 (const char *value)
 
const RequestPayerGetRequestPayer () const
 
bool RequestPayerHasBeenSet () const
 
void SetRequestPayer (const RequestPayer &value)
 
void SetRequestPayer (RequestPayer &&value)
 
UploadPartRequestWithRequestPayer (const RequestPayer &value)
 
UploadPartRequestWithRequestPayer (RequestPayer &&value)
 
const Aws::StringGetExpectedBucketOwner () const
 
bool ExpectedBucketOwnerHasBeenSet () const
 
void SetExpectedBucketOwner (const Aws::String &value)
 
void SetExpectedBucketOwner (Aws::String &&value)
 
void SetExpectedBucketOwner (const char *value)
 
UploadPartRequestWithExpectedBucketOwner (const Aws::String &value)
 
UploadPartRequestWithExpectedBucketOwner (Aws::String &&value)
 
UploadPartRequestWithExpectedBucketOwner (const char *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)
 
UploadPartRequestWithCustomizedAccessLogTag (const Aws::Map< Aws::String, Aws::String > &value)
 
UploadPartRequestWithCustomizedAccessLogTag (Aws::Map< Aws::String, Aws::String > &&value)
 
UploadPartRequestAddCustomizedAccessLogTag (const Aws::String &key, const Aws::String &value)
 
UploadPartRequestAddCustomizedAccessLogTag (Aws::String &&key, const Aws::String &value)
 
UploadPartRequestAddCustomizedAccessLogTag (const Aws::String &key, Aws::String &&value)
 
UploadPartRequestAddCustomizedAccessLogTag (Aws::String &&key, Aws::String &&value)
 
UploadPartRequestAddCustomizedAccessLogTag (const char *key, Aws::String &&value)
 
UploadPartRequestAddCustomizedAccessLogTag (Aws::String &&key, const char *value)
 
UploadPartRequestAddCustomizedAccessLogTag (const char *key, const char *value)
 
- Public Member Functions inherited from Aws::AmazonStreamingWebServiceRequest
 AmazonStreamingWebServiceRequest ()
 
virtual ~AmazonStreamingWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
void SetBody (const std::shared_ptr< Aws::IOStream > &body)
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
bool IsStreaming () const override
 
const Aws::StringGetContentType () const
 
void SetContentType (const Aws::String &contentType)
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) 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 28 of file UploadPartRequest.h.

Constructor & Destructor Documentation

◆ UploadPartRequest()

Aws::S3::Model::UploadPartRequest::UploadPartRequest ( )

Member Function Documentation

◆ AddCustomizedAccessLogTag() [1/7]

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

Definition at line 708 of file UploadPartRequest.h.

◆ AddCustomizedAccessLogTag() [2/7]

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

Definition at line 711 of file UploadPartRequest.h.

◆ AddCustomizedAccessLogTag() [3/7]

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

Definition at line 714 of file UploadPartRequest.h.

◆ AddCustomizedAccessLogTag() [4/7]

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

Definition at line 717 of file UploadPartRequest.h.

◆ AddCustomizedAccessLogTag() [5/7]

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

Definition at line 720 of file UploadPartRequest.h.

◆ AddCustomizedAccessLogTag() [6/7]

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

Definition at line 723 of file UploadPartRequest.h.

◆ AddCustomizedAccessLogTag() [7/7]

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

Definition at line 726 of file UploadPartRequest.h.

◆ AddQueryStringParameters()

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

The name of the bucket to which the multipart upload was initiated.

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 with 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.

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

Definition at line 88 of file UploadPartRequest.h.

◆ ContentLengthHasBeenSet()

bool Aws::S3::Model::UploadPartRequest::ContentLengthHasBeenSet ( ) const
inline

Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.

Definition at line 239 of file UploadPartRequest.h.

◆ ContentMD5HasBeenSet()

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

The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated when using the command from the CLI. This parameter is required if object lock parameters are specified.

Definition at line 266 of file UploadPartRequest.h.

◆ CustomizedAccessLogTagHasBeenSet()

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

Definition at line 693 of file UploadPartRequest.h.

◆ ExpectedBucketOwnerHasBeenSet()

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

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 644 of file UploadPartRequest.h.

◆ GetBucket()

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

The name of the bucket to which the multipart upload was initiated.

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 with 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.

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

Definition at line 65 of file UploadPartRequest.h.

◆ GetContentLength()

long long Aws::S3::Model::UploadPartRequest::GetContentLength ( ) const
inline

Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.

Definition at line 233 of file UploadPartRequest.h.

◆ GetContentMD5()

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

The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated when using the command from the CLI. This parameter is required if object lock parameters are specified.

Definition at line 259 of file UploadPartRequest.h.

◆ GetCustomizedAccessLogTag()

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

Definition at line 690 of file UploadPartRequest.h.

◆ GetExpectedBucketOwner()

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

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 637 of file UploadPartRequest.h.

◆ GetKey()

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

Object key for which the multipart upload was initiated.

Definition at line 314 of file UploadPartRequest.h.

◆ GetPartNumber()

int Aws::S3::Model::UploadPartRequest::GetPartNumber ( ) const
inline

Part number of part being uploaded. This is a positive integer between 1 and 10,000.

Definition at line 356 of file UploadPartRequest.h.

◆ GetRequestPayer()

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

Definition at line 614 of file UploadPartRequest.h.

◆ GetRequestSpecificHeaders()

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

Override this method to put data members from a subclass into the headers collection.

Reimplemented from Aws::AmazonStreamingWebServiceRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file UploadPartRequest.h.

◆ GetSSECustomerAlgorithm()

const Aws::String& Aws::S3::Model::UploadPartRequest::GetSSECustomerAlgorithm ( ) const
inline

Specifies the algorithm to use to when encrypting the object (for example, AES256).

Definition at line 422 of file UploadPartRequest.h.

◆ GetSSECustomerKey()

const Aws::String& Aws::S3::Model::UploadPartRequest::GetSSECustomerKey ( ) const
inline

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.

Definition at line 476 of file UploadPartRequest.h.

◆ GetSSECustomerKeyMD5()

const Aws::String& Aws::S3::Model::UploadPartRequest::GetSSECustomerKeyMD5 ( ) const
inline

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

Definition at line 561 of file UploadPartRequest.h.

◆ GetUploadId()

const Aws::String& Aws::S3::Model::UploadPartRequest::GetUploadId ( ) const
inline

Upload ID identifying the multipart upload whose part is being uploaded.

Definition at line 380 of file UploadPartRequest.h.

◆ KeyHasBeenSet()

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

Object key for which the multipart upload was initiated.

Definition at line 319 of file UploadPartRequest.h.

◆ PartNumberHasBeenSet()

bool Aws::S3::Model::UploadPartRequest::PartNumberHasBeenSet ( ) const
inline

Part number of part being uploaded. This is a positive integer between 1 and 10,000.

Definition at line 362 of file UploadPartRequest.h.

◆ RequestPayerHasBeenSet()

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

Definition at line 617 of file UploadPartRequest.h.

◆ SetBucket() [1/3]

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

The name of the bucket to which the multipart upload was initiated.

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 with 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.

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

Definition at line 111 of file UploadPartRequest.h.

◆ SetBucket() [2/3]

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

The name of the bucket to which the multipart upload was initiated.

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 with 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.

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

Definition at line 134 of file UploadPartRequest.h.

◆ SetBucket() [3/3]

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

The name of the bucket to which the multipart upload was initiated.

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 with 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.

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

Definition at line 157 of file UploadPartRequest.h.

◆ SetContentLength()

void Aws::S3::Model::UploadPartRequest::SetContentLength ( long long  value)
inline

Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.

Definition at line 245 of file UploadPartRequest.h.

◆ SetContentMD5() [1/3]

void Aws::S3::Model::UploadPartRequest::SetContentMD5 ( const Aws::String value)
inline

The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated when using the command from the CLI. This parameter is required if object lock parameters are specified.

Definition at line 273 of file UploadPartRequest.h.

◆ SetContentMD5() [2/3]

void Aws::S3::Model::UploadPartRequest::SetContentMD5 ( Aws::String &&  value)
inline

The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated when using the command from the CLI. This parameter is required if object lock parameters are specified.

Definition at line 280 of file UploadPartRequest.h.

◆ SetContentMD5() [3/3]

void Aws::S3::Model::UploadPartRequest::SetContentMD5 ( const char *  value)
inline

The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated when using the command from the CLI. This parameter is required if object lock parameters are specified.

Definition at line 287 of file UploadPartRequest.h.

◆ SetCustomizedAccessLogTag() [1/2]

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

Definition at line 696 of file UploadPartRequest.h.

◆ SetCustomizedAccessLogTag() [2/2]

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

Definition at line 699 of file UploadPartRequest.h.

◆ SetExpectedBucketOwner() [1/3]

void Aws::S3::Model::UploadPartRequest::SetExpectedBucketOwner ( const Aws::String value)
inline

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 651 of file UploadPartRequest.h.

◆ SetExpectedBucketOwner() [2/3]

void Aws::S3::Model::UploadPartRequest::SetExpectedBucketOwner ( Aws::String &&  value)
inline

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 658 of file UploadPartRequest.h.

◆ SetExpectedBucketOwner() [3/3]

void Aws::S3::Model::UploadPartRequest::SetExpectedBucketOwner ( const char *  value)
inline

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 665 of file UploadPartRequest.h.

◆ SetKey() [1/3]

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

Object key for which the multipart upload was initiated.

Definition at line 324 of file UploadPartRequest.h.

◆ SetKey() [2/3]

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

Object key for which the multipart upload was initiated.

Definition at line 329 of file UploadPartRequest.h.

◆ SetKey() [3/3]

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

Object key for which the multipart upload was initiated.

Definition at line 334 of file UploadPartRequest.h.

◆ SetPartNumber()

void Aws::S3::Model::UploadPartRequest::SetPartNumber ( int  value)
inline

Part number of part being uploaded. This is a positive integer between 1 and 10,000.

Definition at line 368 of file UploadPartRequest.h.

◆ SetRequestPayer() [1/2]

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

Definition at line 620 of file UploadPartRequest.h.

◆ SetRequestPayer() [2/2]

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

Definition at line 623 of file UploadPartRequest.h.

◆ SetSSECustomerAlgorithm() [1/3]

void Aws::S3::Model::UploadPartRequest::SetSSECustomerAlgorithm ( const Aws::String value)
inline

Specifies the algorithm to use to when encrypting the object (for example, AES256).

Definition at line 434 of file UploadPartRequest.h.

◆ SetSSECustomerAlgorithm() [2/3]

void Aws::S3::Model::UploadPartRequest::SetSSECustomerAlgorithm ( Aws::String &&  value)
inline

Specifies the algorithm to use to when encrypting the object (for example, AES256).

Definition at line 440 of file UploadPartRequest.h.

◆ SetSSECustomerAlgorithm() [3/3]

void Aws::S3::Model::UploadPartRequest::SetSSECustomerAlgorithm ( const char *  value)
inline

Specifies the algorithm to use to when encrypting the object (for example, AES256).

Definition at line 446 of file UploadPartRequest.h.

◆ SetSSECustomerKey() [1/3]

void Aws::S3::Model::UploadPartRequest::SetSSECustomerKey ( const Aws::String value)
inline

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.

Definition at line 498 of file UploadPartRequest.h.

◆ SetSSECustomerKey() [2/3]

void Aws::S3::Model::UploadPartRequest::SetSSECustomerKey ( Aws::String &&  value)
inline

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.

Definition at line 509 of file UploadPartRequest.h.

◆ SetSSECustomerKey() [3/3]

void Aws::S3::Model::UploadPartRequest::SetSSECustomerKey ( const char *  value)
inline

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.

Definition at line 520 of file UploadPartRequest.h.

◆ SetSSECustomerKeyMD5() [1/3]

void Aws::S3::Model::UploadPartRequest::SetSSECustomerKeyMD5 ( const Aws::String value)
inline

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

Definition at line 575 of file UploadPartRequest.h.

◆ SetSSECustomerKeyMD5() [2/3]

void Aws::S3::Model::UploadPartRequest::SetSSECustomerKeyMD5 ( Aws::String &&  value)
inline

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

Definition at line 582 of file UploadPartRequest.h.

◆ SetSSECustomerKeyMD5() [3/3]

void Aws::S3::Model::UploadPartRequest::SetSSECustomerKeyMD5 ( const char *  value)
inline

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

Definition at line 589 of file UploadPartRequest.h.

◆ SetUploadId() [1/3]

void Aws::S3::Model::UploadPartRequest::SetUploadId ( const Aws::String value)
inline

Upload ID identifying the multipart upload whose part is being uploaded.

Definition at line 390 of file UploadPartRequest.h.

◆ SetUploadId() [2/3]

void Aws::S3::Model::UploadPartRequest::SetUploadId ( Aws::String &&  value)
inline

Upload ID identifying the multipart upload whose part is being uploaded.

Definition at line 395 of file UploadPartRequest.h.

◆ SetUploadId() [3/3]

void Aws::S3::Model::UploadPartRequest::SetUploadId ( const char *  value)
inline

Upload ID identifying the multipart upload whose part is being uploaded.

Definition at line 400 of file UploadPartRequest.h.

◆ SSECustomerAlgorithmHasBeenSet()

bool Aws::S3::Model::UploadPartRequest::SSECustomerAlgorithmHasBeenSet ( ) const
inline

Specifies the algorithm to use to when encrypting the object (for example, AES256).

Definition at line 428 of file UploadPartRequest.h.

◆ SSECustomerKeyHasBeenSet()

bool Aws::S3::Model::UploadPartRequest::SSECustomerKeyHasBeenSet ( ) const
inline

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.

Definition at line 487 of file UploadPartRequest.h.

◆ SSECustomerKeyMD5HasBeenSet()

bool Aws::S3::Model::UploadPartRequest::SSECustomerKeyMD5HasBeenSet ( ) const
inline

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

Definition at line 568 of file UploadPartRequest.h.

◆ UploadIdHasBeenSet()

bool Aws::S3::Model::UploadPartRequest::UploadIdHasBeenSet ( ) const
inline

Upload ID identifying the multipart upload whose part is being uploaded.

Definition at line 385 of file UploadPartRequest.h.

◆ WithBucket() [1/3]

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

The name of the bucket to which the multipart upload was initiated.

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 with 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.

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

Definition at line 180 of file UploadPartRequest.h.

◆ WithBucket() [2/3]

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

The name of the bucket to which the multipart upload was initiated.

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 with 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.

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

Definition at line 203 of file UploadPartRequest.h.

◆ WithBucket() [3/3]

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

The name of the bucket to which the multipart upload was initiated.

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 with 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.

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

Definition at line 226 of file UploadPartRequest.h.

◆ WithContentLength()

UploadPartRequest& Aws::S3::Model::UploadPartRequest::WithContentLength ( long long  value)
inline

Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.

Definition at line 251 of file UploadPartRequest.h.

◆ WithContentMD5() [1/3]

UploadPartRequest& Aws::S3::Model::UploadPartRequest::WithContentMD5 ( const Aws::String value)
inline

The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated when using the command from the CLI. This parameter is required if object lock parameters are specified.

Definition at line 294 of file UploadPartRequest.h.

◆ WithContentMD5() [2/3]

UploadPartRequest& Aws::S3::Model::UploadPartRequest::WithContentMD5 ( Aws::String &&  value)
inline

The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated when using the command from the CLI. This parameter is required if object lock parameters are specified.

Definition at line 301 of file UploadPartRequest.h.

◆ WithContentMD5() [3/3]

UploadPartRequest& Aws::S3::Model::UploadPartRequest::WithContentMD5 ( const char *  value)
inline

The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated when using the command from the CLI. This parameter is required if object lock parameters are specified.

Definition at line 308 of file UploadPartRequest.h.

◆ WithCustomizedAccessLogTag() [1/2]

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

Definition at line 702 of file UploadPartRequest.h.

◆ WithCustomizedAccessLogTag() [2/2]

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

Definition at line 705 of file UploadPartRequest.h.

◆ WithExpectedBucketOwner() [1/3]

UploadPartRequest& Aws::S3::Model::UploadPartRequest::WithExpectedBucketOwner ( const Aws::String value)
inline

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 672 of file UploadPartRequest.h.

◆ WithExpectedBucketOwner() [2/3]

UploadPartRequest& Aws::S3::Model::UploadPartRequest::WithExpectedBucketOwner ( Aws::String &&  value)
inline

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 679 of file UploadPartRequest.h.

◆ WithExpectedBucketOwner() [3/3]

UploadPartRequest& Aws::S3::Model::UploadPartRequest::WithExpectedBucketOwner ( const char *  value)
inline

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 686 of file UploadPartRequest.h.

◆ WithKey() [1/3]

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

Object key for which the multipart upload was initiated.

Definition at line 339 of file UploadPartRequest.h.

◆ WithKey() [2/3]

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

Object key for which the multipart upload was initiated.

Definition at line 344 of file UploadPartRequest.h.

◆ WithKey() [3/3]

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

Object key for which the multipart upload was initiated.

Definition at line 349 of file UploadPartRequest.h.

◆ WithPartNumber()

UploadPartRequest& Aws::S3::Model::UploadPartRequest::WithPartNumber ( int  value)
inline

Part number of part being uploaded. This is a positive integer between 1 and 10,000.

Definition at line 374 of file UploadPartRequest.h.

◆ WithRequestPayer() [1/2]

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

Definition at line 626 of file UploadPartRequest.h.

◆ WithRequestPayer() [2/2]

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

Definition at line 629 of file UploadPartRequest.h.

◆ WithSSECustomerAlgorithm() [1/3]

UploadPartRequest& Aws::S3::Model::UploadPartRequest::WithSSECustomerAlgorithm ( const Aws::String value)
inline

Specifies the algorithm to use to when encrypting the object (for example, AES256).

Definition at line 452 of file UploadPartRequest.h.

◆ WithSSECustomerAlgorithm() [2/3]

UploadPartRequest& Aws::S3::Model::UploadPartRequest::WithSSECustomerAlgorithm ( Aws::String &&  value)
inline

Specifies the algorithm to use to when encrypting the object (for example, AES256).

Definition at line 458 of file UploadPartRequest.h.

◆ WithSSECustomerAlgorithm() [3/3]

UploadPartRequest& Aws::S3::Model::UploadPartRequest::WithSSECustomerAlgorithm ( const char *  value)
inline

Specifies the algorithm to use to when encrypting the object (for example, AES256).

Definition at line 464 of file UploadPartRequest.h.

◆ WithSSECustomerKey() [1/3]

UploadPartRequest& Aws::S3::Model::UploadPartRequest::WithSSECustomerKey ( const Aws::String value)
inline

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.

Definition at line 531 of file UploadPartRequest.h.

◆ WithSSECustomerKey() [2/3]

UploadPartRequest& Aws::S3::Model::UploadPartRequest::WithSSECustomerKey ( Aws::String &&  value)
inline

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.

Definition at line 542 of file UploadPartRequest.h.

◆ WithSSECustomerKey() [3/3]

UploadPartRequest& Aws::S3::Model::UploadPartRequest::WithSSECustomerKey ( const char *  value)
inline

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.

Definition at line 553 of file UploadPartRequest.h.

◆ WithSSECustomerKeyMD5() [1/3]

UploadPartRequest& Aws::S3::Model::UploadPartRequest::WithSSECustomerKeyMD5 ( const Aws::String value)
inline

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

Definition at line 596 of file UploadPartRequest.h.

◆ WithSSECustomerKeyMD5() [2/3]

UploadPartRequest& Aws::S3::Model::UploadPartRequest::WithSSECustomerKeyMD5 ( Aws::String &&  value)
inline

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

Definition at line 603 of file UploadPartRequest.h.

◆ WithSSECustomerKeyMD5() [3/3]

UploadPartRequest& Aws::S3::Model::UploadPartRequest::WithSSECustomerKeyMD5 ( const char *  value)
inline

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

Definition at line 610 of file UploadPartRequest.h.

◆ WithUploadId() [1/3]

UploadPartRequest& Aws::S3::Model::UploadPartRequest::WithUploadId ( const Aws::String value)
inline

Upload ID identifying the multipart upload whose part is being uploaded.

Definition at line 405 of file UploadPartRequest.h.

◆ WithUploadId() [2/3]

UploadPartRequest& Aws::S3::Model::UploadPartRequest::WithUploadId ( Aws::String &&  value)
inline

Upload ID identifying the multipart upload whose part is being uploaded.

Definition at line 410 of file UploadPartRequest.h.

◆ WithUploadId() [3/3]

UploadPartRequest& Aws::S3::Model::UploadPartRequest::WithUploadId ( const char *  value)
inline

Upload ID identifying the multipart upload whose part is being uploaded.

Definition at line 415 of file UploadPartRequest.h.


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