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

#include <ListObjectsRequest.h>

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

Public Member Functions

 ListObjectsRequest ()
 
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)
 
ListObjectsRequestWithBucket (const Aws::String &value)
 
ListObjectsRequestWithBucket (Aws::String &&value)
 
ListObjectsRequestWithBucket (const char *value)
 
const Aws::StringGetDelimiter () const
 
bool DelimiterHasBeenSet () const
 
void SetDelimiter (const Aws::String &value)
 
void SetDelimiter (Aws::String &&value)
 
void SetDelimiter (const char *value)
 
ListObjectsRequestWithDelimiter (const Aws::String &value)
 
ListObjectsRequestWithDelimiter (Aws::String &&value)
 
ListObjectsRequestWithDelimiter (const char *value)
 
const EncodingTypeGetEncodingType () const
 
bool EncodingTypeHasBeenSet () const
 
void SetEncodingType (const EncodingType &value)
 
void SetEncodingType (EncodingType &&value)
 
ListObjectsRequestWithEncodingType (const EncodingType &value)
 
ListObjectsRequestWithEncodingType (EncodingType &&value)
 
const Aws::StringGetMarker () const
 
bool MarkerHasBeenSet () const
 
void SetMarker (const Aws::String &value)
 
void SetMarker (Aws::String &&value)
 
void SetMarker (const char *value)
 
ListObjectsRequestWithMarker (const Aws::String &value)
 
ListObjectsRequestWithMarker (Aws::String &&value)
 
ListObjectsRequestWithMarker (const char *value)
 
int GetMaxKeys () const
 
bool MaxKeysHasBeenSet () const
 
void SetMaxKeys (int value)
 
ListObjectsRequestWithMaxKeys (int value)
 
const Aws::StringGetPrefix () const
 
bool PrefixHasBeenSet () const
 
void SetPrefix (const Aws::String &value)
 
void SetPrefix (Aws::String &&value)
 
void SetPrefix (const char *value)
 
ListObjectsRequestWithPrefix (const Aws::String &value)
 
ListObjectsRequestWithPrefix (Aws::String &&value)
 
ListObjectsRequestWithPrefix (const char *value)
 
const RequestPayerGetRequestPayer () const
 
bool RequestPayerHasBeenSet () const
 
void SetRequestPayer (const RequestPayer &value)
 
void SetRequestPayer (RequestPayer &&value)
 
ListObjectsRequestWithRequestPayer (const RequestPayer &value)
 
ListObjectsRequestWithRequestPayer (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)
 
ListObjectsRequestWithCustomizedAccessLogTag (const Aws::Map< Aws::String, Aws::String > &value)
 
ListObjectsRequestWithCustomizedAccessLogTag (Aws::Map< Aws::String, Aws::String > &&value)
 
ListObjectsRequestAddCustomizedAccessLogTag (const Aws::String &key, const Aws::String &value)
 
ListObjectsRequestAddCustomizedAccessLogTag (Aws::String &&key, const Aws::String &value)
 
ListObjectsRequestAddCustomizedAccessLogTag (const Aws::String &key, Aws::String &&value)
 
ListObjectsRequestAddCustomizedAccessLogTag (Aws::String &&key, Aws::String &&value)
 
ListObjectsRequestAddCustomizedAccessLogTag (const char *key, Aws::String &&value)
 
ListObjectsRequestAddCustomizedAccessLogTag (Aws::String &&key, const char *value)
 
ListObjectsRequestAddCustomizedAccessLogTag (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 28 of file ListObjectsRequest.h.

Constructor & Destructor Documentation

◆ ListObjectsRequest()

Aws::S3::Model::ListObjectsRequest::ListObjectsRequest ( )

Member Function Documentation

◆ AddCustomizedAccessLogTag() [1/7]

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

Definition at line 320 of file ListObjectsRequest.h.

◆ AddCustomizedAccessLogTag() [2/7]

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

Definition at line 323 of file ListObjectsRequest.h.

◆ AddCustomizedAccessLogTag() [3/7]

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

Definition at line 326 of file ListObjectsRequest.h.

◆ AddCustomizedAccessLogTag() [4/7]

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

Definition at line 329 of file ListObjectsRequest.h.

◆ AddCustomizedAccessLogTag() [5/7]

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

Definition at line 332 of file ListObjectsRequest.h.

◆ AddCustomizedAccessLogTag() [6/7]

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

Definition at line 335 of file ListObjectsRequest.h.

◆ AddCustomizedAccessLogTag() [7/7]

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

Definition at line 338 of file ListObjectsRequest.h.

◆ AddQueryStringParameters()

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

The name of the bucket containing the objects.

Definition at line 54 of file ListObjectsRequest.h.

◆ CustomizedAccessLogTagHasBeenSet()

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

Definition at line 305 of file ListObjectsRequest.h.

◆ DelimiterHasBeenSet()

bool Aws::S3::Model::ListObjectsRequest::DelimiterHasBeenSet ( ) const
inline

A delimiter is a character you use to group keys.

Definition at line 95 of file ListObjectsRequest.h.

◆ EncodingTypeHasBeenSet()

bool Aws::S3::Model::ListObjectsRequest::EncodingTypeHasBeenSet ( ) const
inline

Definition at line 132 of file ListObjectsRequest.h.

◆ GetBucket()

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

The name of the bucket containing the objects.

Definition at line 49 of file ListObjectsRequest.h.

◆ GetCustomizedAccessLogTag()

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

Definition at line 302 of file ListObjectsRequest.h.

◆ GetDelimiter()

const Aws::String& Aws::S3::Model::ListObjectsRequest::GetDelimiter ( ) const
inline

A delimiter is a character you use to group keys.

Definition at line 90 of file ListObjectsRequest.h.

◆ GetEncodingType()

const EncodingType& Aws::S3::Model::ListObjectsRequest::GetEncodingType ( ) const
inline

Definition at line 129 of file ListObjectsRequest.h.

◆ GetMarker()

const Aws::String& Aws::S3::Model::ListObjectsRequest::GetMarker ( ) const
inline

Specifies the key to start with when listing objects in a bucket.

Definition at line 150 of file ListObjectsRequest.h.

◆ GetMaxKeys()

int Aws::S3::Model::ListObjectsRequest::GetMaxKeys ( ) const
inline

Sets the maximum number of keys returned in the response. By default the API returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

Definition at line 193 of file ListObjectsRequest.h.

◆ GetPrefix()

const Aws::String& Aws::S3::Model::ListObjectsRequest::GetPrefix ( ) const
inline

Limits the response to keys that begin with the specified prefix.

Definition at line 220 of file ListObjectsRequest.h.

◆ GetRequestPayer()

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

Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.

Definition at line 263 of file ListObjectsRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::S3::S3Request.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file ListObjectsRequest.h.

◆ MarkerHasBeenSet()

bool Aws::S3::Model::ListObjectsRequest::MarkerHasBeenSet ( ) const
inline

Specifies the key to start with when listing objects in a bucket.

Definition at line 155 of file ListObjectsRequest.h.

◆ MaxKeysHasBeenSet()

bool Aws::S3::Model::ListObjectsRequest::MaxKeysHasBeenSet ( ) const
inline

Sets the maximum number of keys returned in the response. By default the API returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

Definition at line 200 of file ListObjectsRequest.h.

◆ PrefixHasBeenSet()

bool Aws::S3::Model::ListObjectsRequest::PrefixHasBeenSet ( ) const
inline

Limits the response to keys that begin with the specified prefix.

Definition at line 225 of file ListObjectsRequest.h.

◆ RequestPayerHasBeenSet()

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

Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.

Definition at line 270 of file ListObjectsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetBucket() [1/3]

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

The name of the bucket containing the objects.

Definition at line 59 of file ListObjectsRequest.h.

◆ SetBucket() [2/3]

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

The name of the bucket containing the objects.

Definition at line 64 of file ListObjectsRequest.h.

◆ SetBucket() [3/3]

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

The name of the bucket containing the objects.

Definition at line 69 of file ListObjectsRequest.h.

◆ SetCustomizedAccessLogTag() [1/2]

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

Definition at line 308 of file ListObjectsRequest.h.

◆ SetCustomizedAccessLogTag() [2/2]

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

Definition at line 311 of file ListObjectsRequest.h.

◆ SetDelimiter() [1/3]

void Aws::S3::Model::ListObjectsRequest::SetDelimiter ( const Aws::String value)
inline

A delimiter is a character you use to group keys.

Definition at line 100 of file ListObjectsRequest.h.

◆ SetDelimiter() [2/3]

void Aws::S3::Model::ListObjectsRequest::SetDelimiter ( Aws::String &&  value)
inline

A delimiter is a character you use to group keys.

Definition at line 105 of file ListObjectsRequest.h.

◆ SetDelimiter() [3/3]

void Aws::S3::Model::ListObjectsRequest::SetDelimiter ( const char *  value)
inline

A delimiter is a character you use to group keys.

Definition at line 110 of file ListObjectsRequest.h.

◆ SetEncodingType() [1/2]

void Aws::S3::Model::ListObjectsRequest::SetEncodingType ( const EncodingType value)
inline

Definition at line 135 of file ListObjectsRequest.h.

◆ SetEncodingType() [2/2]

void Aws::S3::Model::ListObjectsRequest::SetEncodingType ( EncodingType &&  value)
inline

Definition at line 138 of file ListObjectsRequest.h.

◆ SetMarker() [1/3]

void Aws::S3::Model::ListObjectsRequest::SetMarker ( const Aws::String value)
inline

Specifies the key to start with when listing objects in a bucket.

Definition at line 160 of file ListObjectsRequest.h.

◆ SetMarker() [2/3]

void Aws::S3::Model::ListObjectsRequest::SetMarker ( Aws::String &&  value)
inline

Specifies the key to start with when listing objects in a bucket.

Definition at line 165 of file ListObjectsRequest.h.

◆ SetMarker() [3/3]

void Aws::S3::Model::ListObjectsRequest::SetMarker ( const char *  value)
inline

Specifies the key to start with when listing objects in a bucket.

Definition at line 170 of file ListObjectsRequest.h.

◆ SetMaxKeys()

void Aws::S3::Model::ListObjectsRequest::SetMaxKeys ( int  value)
inline

Sets the maximum number of keys returned in the response. By default the API returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

Definition at line 207 of file ListObjectsRequest.h.

◆ SetPrefix() [1/3]

void Aws::S3::Model::ListObjectsRequest::SetPrefix ( const Aws::String value)
inline

Limits the response to keys that begin with the specified prefix.

Definition at line 230 of file ListObjectsRequest.h.

◆ SetPrefix() [2/3]

void Aws::S3::Model::ListObjectsRequest::SetPrefix ( Aws::String &&  value)
inline

Limits the response to keys that begin with the specified prefix.

Definition at line 235 of file ListObjectsRequest.h.

◆ SetPrefix() [3/3]

void Aws::S3::Model::ListObjectsRequest::SetPrefix ( const char *  value)
inline

Limits the response to keys that begin with the specified prefix.

Definition at line 240 of file ListObjectsRequest.h.

◆ SetRequestPayer() [1/2]

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

Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.

Definition at line 277 of file ListObjectsRequest.h.

◆ SetRequestPayer() [2/2]

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

Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.

Definition at line 284 of file ListObjectsRequest.h.

◆ WithBucket() [1/3]

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

The name of the bucket containing the objects.

Definition at line 74 of file ListObjectsRequest.h.

◆ WithBucket() [2/3]

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

The name of the bucket containing the objects.

Definition at line 79 of file ListObjectsRequest.h.

◆ WithBucket() [3/3]

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

The name of the bucket containing the objects.

Definition at line 84 of file ListObjectsRequest.h.

◆ WithCustomizedAccessLogTag() [1/2]

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

Definition at line 314 of file ListObjectsRequest.h.

◆ WithCustomizedAccessLogTag() [2/2]

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

Definition at line 317 of file ListObjectsRequest.h.

◆ WithDelimiter() [1/3]

ListObjectsRequest& Aws::S3::Model::ListObjectsRequest::WithDelimiter ( const Aws::String value)
inline

A delimiter is a character you use to group keys.

Definition at line 115 of file ListObjectsRequest.h.

◆ WithDelimiter() [2/3]

ListObjectsRequest& Aws::S3::Model::ListObjectsRequest::WithDelimiter ( Aws::String &&  value)
inline

A delimiter is a character you use to group keys.

Definition at line 120 of file ListObjectsRequest.h.

◆ WithDelimiter() [3/3]

ListObjectsRequest& Aws::S3::Model::ListObjectsRequest::WithDelimiter ( const char *  value)
inline

A delimiter is a character you use to group keys.

Definition at line 125 of file ListObjectsRequest.h.

◆ WithEncodingType() [1/2]

ListObjectsRequest& Aws::S3::Model::ListObjectsRequest::WithEncodingType ( const EncodingType value)
inline

Definition at line 141 of file ListObjectsRequest.h.

◆ WithEncodingType() [2/2]

ListObjectsRequest& Aws::S3::Model::ListObjectsRequest::WithEncodingType ( EncodingType &&  value)
inline

Definition at line 144 of file ListObjectsRequest.h.

◆ WithMarker() [1/3]

ListObjectsRequest& Aws::S3::Model::ListObjectsRequest::WithMarker ( const Aws::String value)
inline

Specifies the key to start with when listing objects in a bucket.

Definition at line 175 of file ListObjectsRequest.h.

◆ WithMarker() [2/3]

ListObjectsRequest& Aws::S3::Model::ListObjectsRequest::WithMarker ( Aws::String &&  value)
inline

Specifies the key to start with when listing objects in a bucket.

Definition at line 180 of file ListObjectsRequest.h.

◆ WithMarker() [3/3]

ListObjectsRequest& Aws::S3::Model::ListObjectsRequest::WithMarker ( const char *  value)
inline

Specifies the key to start with when listing objects in a bucket.

Definition at line 185 of file ListObjectsRequest.h.

◆ WithMaxKeys()

ListObjectsRequest& Aws::S3::Model::ListObjectsRequest::WithMaxKeys ( int  value)
inline

Sets the maximum number of keys returned in the response. By default the API returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

Definition at line 214 of file ListObjectsRequest.h.

◆ WithPrefix() [1/3]

ListObjectsRequest& Aws::S3::Model::ListObjectsRequest::WithPrefix ( const Aws::String value)
inline

Limits the response to keys that begin with the specified prefix.

Definition at line 245 of file ListObjectsRequest.h.

◆ WithPrefix() [2/3]

ListObjectsRequest& Aws::S3::Model::ListObjectsRequest::WithPrefix ( Aws::String &&  value)
inline

Limits the response to keys that begin with the specified prefix.

Definition at line 250 of file ListObjectsRequest.h.

◆ WithPrefix() [3/3]

ListObjectsRequest& Aws::S3::Model::ListObjectsRequest::WithPrefix ( const char *  value)
inline

Limits the response to keys that begin with the specified prefix.

Definition at line 255 of file ListObjectsRequest.h.

◆ WithRequestPayer() [1/2]

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

Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.

Definition at line 291 of file ListObjectsRequest.h.

◆ WithRequestPayer() [2/2]

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

Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.

Definition at line 298 of file ListObjectsRequest.h.


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