Aws::S3::Model::ListObjectsRequest Class Reference

#include <ListObjectsRequest.h>

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

Public Member Functions
	ListObjectsRequest ()
Aws::String	SerializePayload () const override
void	AddQueryStringParameters (Aws::Http::URI &uri) const override
const Aws::String &	GetBucket () const
void	SetBucket (const Aws::String &value)
void	SetBucket (Aws::String &&value)
void	SetBucket (const char *value)
ListObjectsRequest &	WithBucket (const Aws::String &value)
ListObjectsRequest &	WithBucket (Aws::String &&value)
ListObjectsRequest &	WithBucket (const char *value)
const Aws::String &	GetDelimiter () const
void	SetDelimiter (const Aws::String &value)
void	SetDelimiter (Aws::String &&value)
void	SetDelimiter (const char *value)
ListObjectsRequest &	WithDelimiter (const Aws::String &value)
ListObjectsRequest &	WithDelimiter (Aws::String &&value)
ListObjectsRequest &	WithDelimiter (const char *value)
const EncodingType &	GetEncodingType () const
void	SetEncodingType (const EncodingType &value)
void	SetEncodingType (EncodingType &&value)
ListObjectsRequest &	WithEncodingType (const EncodingType &value)
ListObjectsRequest &	WithEncodingType (EncodingType &&value)
const Aws::String &	GetMarker () const
void	SetMarker (const Aws::String &value)
void	SetMarker (Aws::String &&value)
void	SetMarker (const char *value)
ListObjectsRequest &	WithMarker (const Aws::String &value)
ListObjectsRequest &	WithMarker (Aws::String &&value)
ListObjectsRequest &	WithMarker (const char *value)
long	GetMaxKeys () const
void	SetMaxKeys (long value)
ListObjectsRequest &	WithMaxKeys (long value)
const Aws::String &	GetPrefix () const
void	SetPrefix (const Aws::String &value)
void	SetPrefix (Aws::String &&value)
void	SetPrefix (const char *value)
ListObjectsRequest &	WithPrefix (const Aws::String &value)
ListObjectsRequest &	WithPrefix (Aws::String &&value)
ListObjectsRequest &	WithPrefix (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::IOStream >	GetBody () const override
Public Member Functions inherited from Aws::AmazonWebServiceRequest
	AmazonWebServiceRequest ()
virtual	~AmazonWebServiceRequest ()=default
const Aws::IOStreamFactory &	GetResponseStreamFactory () 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	SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
virtual void	SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
virtual const Aws::Http::DataReceivedEventHandler &	GetDataReceivedEventHandler () const
virtual const Aws::Http::DataSentEventHandler &	GetDataSentEventHandler () const
virtual bool	ShouldComputeContentMd5 () const

Additional Inherited Members
Protected Member Functions inherited from Aws::S3::S3Request
virtual Aws::Http::HeaderValueCollection	GetRequestSpecificHeaders () const

Detailed Description

Definition at line 34 of file ListObjectsRequest.h.

Constructor & Destructor Documentation

Aws::S3::Model::ListObjectsRequest::ListObjectsRequest

(

)

Member Function Documentation

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.

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

inline

Definition at line 43 of file ListObjectsRequest.h.

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

inline

A delimiter is a character you use to group keys.

Definition at line 66 of file ListObjectsRequest.h.

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

inline

Definition at line 99 of file ListObjectsRequest.h.

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 116 of file ListObjectsRequest.h.

long Aws::S3::Model::ListObjectsRequest::GetMaxKeys ( ) const

inline

Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.

Definition at line 152 of file ListObjectsRequest.h.

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

inline

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

Definition at line 169 of file ListObjectsRequest.h.

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

overridevirtual

Convert payload into String.

Implements Aws::S3::S3Request.

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

inline

Definition at line 46 of file ListObjectsRequest.h.

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

inline

Definition at line 49 of file ListObjectsRequest.h.

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

inline

Definition at line 52 of file ListObjectsRequest.h.

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

inline

A delimiter is a character you use to group keys.

Definition at line 71 of file ListObjectsRequest.h.

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

inline

A delimiter is a character you use to group keys.

Definition at line 76 of file ListObjectsRequest.h.

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

inline

A delimiter is a character you use to group keys.

Definition at line 81 of file ListObjectsRequest.h.

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

inline

Definition at line 102 of file ListObjectsRequest.h.

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

inline

Definition at line 105 of file ListObjectsRequest.h.

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 121 of file ListObjectsRequest.h.

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 126 of file ListObjectsRequest.h.

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 131 of file ListObjectsRequest.h.

void Aws::S3::Model::ListObjectsRequest::SetMaxKeys ( long  value )

inline

Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.

Definition at line 158 of file ListObjectsRequest.h.

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 174 of file ListObjectsRequest.h.

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

inline

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

Definition at line 179 of file ListObjectsRequest.h.

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

inline

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

Definition at line 184 of file ListObjectsRequest.h.

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

inline

Definition at line 55 of file ListObjectsRequest.h.

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

inline

Definition at line 58 of file ListObjectsRequest.h.

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

inline

Definition at line 61 of file ListObjectsRequest.h.

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

inline

A delimiter is a character you use to group keys.

Definition at line 86 of file ListObjectsRequest.h.

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

inline

A delimiter is a character you use to group keys.

Definition at line 91 of file ListObjectsRequest.h.

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

inline

A delimiter is a character you use to group keys.

Definition at line 96 of file ListObjectsRequest.h.

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

inline

Definition at line 108 of file ListObjectsRequest.h.

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

inline

Definition at line 111 of file ListObjectsRequest.h.

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 136 of file ListObjectsRequest.h.

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 141 of file ListObjectsRequest.h.

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 146 of file ListObjectsRequest.h.

ListObjectsRequest& Aws::S3::Model::ListObjectsRequest::WithMaxKeys ( long  value )

inline

Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.

Definition at line 164 of file ListObjectsRequest.h.

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 189 of file ListObjectsRequest.h.

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

inline

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

Definition at line 194 of file ListObjectsRequest.h.

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

inline

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

Definition at line 199 of file ListObjectsRequest.h.

---

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

• aws-cpp-sdk-s3/include/aws/s3/model/ListObjectsRequest.h