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

#include <ListPartsRequest.h>

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

Public Member Functions

 ListPartsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
void AddQueryStringParameters (Aws::Http::URI &uri) const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetBucket () const
 
bool BucketHasBeenSet () const
 
void SetBucket (const Aws::String &value)
 
void SetBucket (Aws::String &&value)
 
void SetBucket (const char *value)
 
ListPartsRequestWithBucket (const Aws::String &value)
 
ListPartsRequestWithBucket (Aws::String &&value)
 
ListPartsRequestWithBucket (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)
 
ListPartsRequestWithKey (const Aws::String &value)
 
ListPartsRequestWithKey (Aws::String &&value)
 
ListPartsRequestWithKey (const char *value)
 
int GetMaxParts () const
 
bool MaxPartsHasBeenSet () const
 
void SetMaxParts (int value)
 
ListPartsRequestWithMaxParts (int value)
 
int GetPartNumberMarker () const
 
bool PartNumberMarkerHasBeenSet () const
 
void SetPartNumberMarker (int value)
 
ListPartsRequestWithPartNumberMarker (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)
 
ListPartsRequestWithUploadId (const Aws::String &value)
 
ListPartsRequestWithUploadId (Aws::String &&value)
 
ListPartsRequestWithUploadId (const char *value)
 
const RequestPayerGetRequestPayer () const
 
bool RequestPayerHasBeenSet () const
 
void SetRequestPayer (const RequestPayer &value)
 
void SetRequestPayer (RequestPayer &&value)
 
ListPartsRequestWithRequestPayer (const RequestPayer &value)
 
ListPartsRequestWithRequestPayer (RequestPayer &&value)
 
const Aws::Map< Aws::String, Aws::String > & GetCustomizedAccessLogTag () const
 
bool CustomizedAccessLogTagHasBeenSet () const
 
void SetCustomizedAccessLogTag (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetCustomizedAccessLogTag (Aws::Map< Aws::String, Aws::String > &&value)
 
ListPartsRequestWithCustomizedAccessLogTag (const Aws::Map< Aws::String, Aws::String > &value)
 
ListPartsRequestWithCustomizedAccessLogTag (Aws::Map< Aws::String, Aws::String > &&value)
 
ListPartsRequestAddCustomizedAccessLogTag (const Aws::String &key, const Aws::String &value)
 
ListPartsRequestAddCustomizedAccessLogTag (Aws::String &&key, const Aws::String &value)
 
ListPartsRequestAddCustomizedAccessLogTag (const Aws::String &key, Aws::String &&value)
 
ListPartsRequestAddCustomizedAccessLogTag (Aws::String &&key, Aws::String &&value)
 
ListPartsRequestAddCustomizedAccessLogTag (const char *key, Aws::String &&value)
 
ListPartsRequestAddCustomizedAccessLogTag (Aws::String &&key, const char *value)
 
ListPartsRequestAddCustomizedAccessLogTag (const char *key, const char *value)
 
- Public Member Functions inherited from Aws::S3::S3Request
virtual ~S3Request ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 27 of file ListPartsRequest.h.

Constructor & Destructor Documentation

◆ ListPartsRequest()

Aws::S3::Model::ListPartsRequest::ListPartsRequest ( )

Member Function Documentation

◆ AddCustomizedAccessLogTag() [1/7]

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

Definition at line 324 of file ListPartsRequest.h.

◆ AddCustomizedAccessLogTag() [2/7]

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

Definition at line 327 of file ListPartsRequest.h.

◆ AddCustomizedAccessLogTag() [3/7]

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

Definition at line 330 of file ListPartsRequest.h.

◆ AddCustomizedAccessLogTag() [4/7]

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

Definition at line 333 of file ListPartsRequest.h.

◆ AddCustomizedAccessLogTag() [5/7]

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

Definition at line 336 of file ListPartsRequest.h.

◆ AddCustomizedAccessLogTag() [6/7]

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

Definition at line 339 of file ListPartsRequest.h.

◆ AddCustomizedAccessLogTag() [7/7]

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

Definition at line 342 of file ListPartsRequest.h.

◆ AddQueryStringParameters()

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

Name of the bucket to which the parts are being uploaded.

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

◆ CustomizedAccessLogTagHasBeenSet()

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

Definition at line 309 of file ListPartsRequest.h.

◆ GetBucket()

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

Name of the bucket to which the parts are being uploaded.

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

◆ GetCustomizedAccessLogTag()

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

Definition at line 306 of file ListPartsRequest.h.

◆ GetKey()

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

Object key for which the multipart upload was initiated.

Definition at line 161 of file ListPartsRequest.h.

◆ GetMaxParts()

int Aws::S3::Model::ListPartsRequest::GetMaxParts ( ) const
inline

Sets the maximum number of parts to return.

Definition at line 202 of file ListPartsRequest.h.

◆ GetPartNumberMarker()

int Aws::S3::Model::ListPartsRequest::GetPartNumberMarker ( ) const
inline

Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.

Definition at line 224 of file ListPartsRequest.h.

◆ GetRequestPayer()

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

Definition at line 287 of file ListPartsRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::S3::S3Request.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file ListPartsRequest.h.

◆ GetUploadId()

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

Upload ID identifying the multipart upload whose parts are being listed.

Definition at line 248 of file ListPartsRequest.h.

◆ KeyHasBeenSet()

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

Object key for which the multipart upload was initiated.

Definition at line 166 of file ListPartsRequest.h.

◆ MaxPartsHasBeenSet()

bool Aws::S3::Model::ListPartsRequest::MaxPartsHasBeenSet ( ) const
inline

Sets the maximum number of parts to return.

Definition at line 207 of file ListPartsRequest.h.

◆ PartNumberMarkerHasBeenSet()

bool Aws::S3::Model::ListPartsRequest::PartNumberMarkerHasBeenSet ( ) const
inline

Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.

Definition at line 230 of file ListPartsRequest.h.

◆ RequestPayerHasBeenSet()

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

Definition at line 290 of file ListPartsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetBucket() [1/3]

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

Name of the bucket to which the parts are being uploaded.

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

◆ SetBucket() [2/3]

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

Name of the bucket to which the parts are being uploaded.

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

◆ SetBucket() [3/3]

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

Name of the bucket to which the parts are being uploaded.

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

◆ SetCustomizedAccessLogTag() [1/2]

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

Definition at line 312 of file ListPartsRequest.h.

◆ SetCustomizedAccessLogTag() [2/2]

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

Definition at line 315 of file ListPartsRequest.h.

◆ SetKey() [1/3]

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

Object key for which the multipart upload was initiated.

Definition at line 171 of file ListPartsRequest.h.

◆ SetKey() [2/3]

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

Object key for which the multipart upload was initiated.

Definition at line 176 of file ListPartsRequest.h.

◆ SetKey() [3/3]

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

Object key for which the multipart upload was initiated.

Definition at line 181 of file ListPartsRequest.h.

◆ SetMaxParts()

void Aws::S3::Model::ListPartsRequest::SetMaxParts ( int  value)
inline

Sets the maximum number of parts to return.

Definition at line 212 of file ListPartsRequest.h.

◆ SetPartNumberMarker()

void Aws::S3::Model::ListPartsRequest::SetPartNumberMarker ( int  value)
inline

Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.

Definition at line 236 of file ListPartsRequest.h.

◆ SetRequestPayer() [1/2]

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

Definition at line 293 of file ListPartsRequest.h.

◆ SetRequestPayer() [2/2]

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

Definition at line 296 of file ListPartsRequest.h.

◆ SetUploadId() [1/3]

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

Upload ID identifying the multipart upload whose parts are being listed.

Definition at line 258 of file ListPartsRequest.h.

◆ SetUploadId() [2/3]

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

Upload ID identifying the multipart upload whose parts are being listed.

Definition at line 263 of file ListPartsRequest.h.

◆ SetUploadId() [3/3]

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

Upload ID identifying the multipart upload whose parts are being listed.

Definition at line 268 of file ListPartsRequest.h.

◆ UploadIdHasBeenSet()

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

Upload ID identifying the multipart upload whose parts are being listed.

Definition at line 253 of file ListPartsRequest.h.

◆ WithBucket() [1/3]

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

Name of the bucket to which the parts are being uploaded.

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

◆ WithBucket() [2/3]

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

Name of the bucket to which the parts are being uploaded.

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

◆ WithBucket() [3/3]

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

Name of the bucket to which the parts are being uploaded.

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

◆ WithCustomizedAccessLogTag() [1/2]

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

Definition at line 318 of file ListPartsRequest.h.

◆ WithCustomizedAccessLogTag() [2/2]

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

Definition at line 321 of file ListPartsRequest.h.

◆ WithKey() [1/3]

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

Object key for which the multipart upload was initiated.

Definition at line 186 of file ListPartsRequest.h.

◆ WithKey() [2/3]

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

Object key for which the multipart upload was initiated.

Definition at line 191 of file ListPartsRequest.h.

◆ WithKey() [3/3]

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

Object key for which the multipart upload was initiated.

Definition at line 196 of file ListPartsRequest.h.

◆ WithMaxParts()

ListPartsRequest& Aws::S3::Model::ListPartsRequest::WithMaxParts ( int  value)
inline

Sets the maximum number of parts to return.

Definition at line 217 of file ListPartsRequest.h.

◆ WithPartNumberMarker()

ListPartsRequest& Aws::S3::Model::ListPartsRequest::WithPartNumberMarker ( int  value)
inline

Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.

Definition at line 242 of file ListPartsRequest.h.

◆ WithRequestPayer() [1/2]

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

Definition at line 299 of file ListPartsRequest.h.

◆ WithRequestPayer() [2/2]

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

Definition at line 302 of file ListPartsRequest.h.

◆ WithUploadId() [1/3]

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

Upload ID identifying the multipart upload whose parts are being listed.

Definition at line 273 of file ListPartsRequest.h.

◆ WithUploadId() [2/3]

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

Upload ID identifying the multipart upload whose parts are being listed.

Definition at line 278 of file ListPartsRequest.h.

◆ WithUploadId() [3/3]

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

Upload ID identifying the multipart upload whose parts are being listed.

Definition at line 283 of file ListPartsRequest.h.


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