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

#include <ListObjectVersionsRequest.h>

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

Public Member Functions

 ListObjectVersionsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
void AddQueryStringParameters (Aws::Http::URI &uri) 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)
 
ListObjectVersionsRequestWithBucket (const Aws::String &value)
 
ListObjectVersionsRequestWithBucket (Aws::String &&value)
 
ListObjectVersionsRequestWithBucket (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)
 
ListObjectVersionsRequestWithDelimiter (const Aws::String &value)
 
ListObjectVersionsRequestWithDelimiter (Aws::String &&value)
 
ListObjectVersionsRequestWithDelimiter (const char *value)
 
const EncodingTypeGetEncodingType () const
 
bool EncodingTypeHasBeenSet () const
 
void SetEncodingType (const EncodingType &value)
 
void SetEncodingType (EncodingType &&value)
 
ListObjectVersionsRequestWithEncodingType (const EncodingType &value)
 
ListObjectVersionsRequestWithEncodingType (EncodingType &&value)
 
const Aws::StringGetKeyMarker () const
 
bool KeyMarkerHasBeenSet () const
 
void SetKeyMarker (const Aws::String &value)
 
void SetKeyMarker (Aws::String &&value)
 
void SetKeyMarker (const char *value)
 
ListObjectVersionsRequestWithKeyMarker (const Aws::String &value)
 
ListObjectVersionsRequestWithKeyMarker (Aws::String &&value)
 
ListObjectVersionsRequestWithKeyMarker (const char *value)
 
int GetMaxKeys () const
 
bool MaxKeysHasBeenSet () const
 
void SetMaxKeys (int value)
 
ListObjectVersionsRequestWithMaxKeys (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)
 
ListObjectVersionsRequestWithPrefix (const Aws::String &value)
 
ListObjectVersionsRequestWithPrefix (Aws::String &&value)
 
ListObjectVersionsRequestWithPrefix (const char *value)
 
const Aws::StringGetVersionIdMarker () const
 
bool VersionIdMarkerHasBeenSet () const
 
void SetVersionIdMarker (const Aws::String &value)
 
void SetVersionIdMarker (Aws::String &&value)
 
void SetVersionIdMarker (const char *value)
 
ListObjectVersionsRequestWithVersionIdMarker (const Aws::String &value)
 
ListObjectVersionsRequestWithVersionIdMarker (Aws::String &&value)
 
ListObjectVersionsRequestWithVersionIdMarker (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)
 
ListObjectVersionsRequestWithCustomizedAccessLogTag (const Aws::Map< Aws::String, Aws::String > &value)
 
ListObjectVersionsRequestWithCustomizedAccessLogTag (Aws::Map< Aws::String, Aws::String > &&value)
 
ListObjectVersionsRequestAddCustomizedAccessLogTag (const Aws::String &key, const Aws::String &value)
 
ListObjectVersionsRequestAddCustomizedAccessLogTag (Aws::String &&key, const Aws::String &value)
 
ListObjectVersionsRequestAddCustomizedAccessLogTag (const Aws::String &key, Aws::String &&value)
 
ListObjectVersionsRequestAddCustomizedAccessLogTag (Aws::String &&key, Aws::String &&value)
 
ListObjectVersionsRequestAddCustomizedAccessLogTag (const char *key, Aws::String &&value)
 
ListObjectVersionsRequestAddCustomizedAccessLogTag (Aws::String &&key, const char *value)
 
ListObjectVersionsRequestAddCustomizedAccessLogTag (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::S3::S3Request
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 27 of file ListObjectVersionsRequest.h.

Constructor & Destructor Documentation

◆ ListObjectVersionsRequest()

Aws::S3::Model::ListObjectVersionsRequest::ListObjectVersionsRequest ( )

Member Function Documentation

◆ AddCustomizedAccessLogTag() [1/7]

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

Definition at line 463 of file ListObjectVersionsRequest.h.

◆ AddCustomizedAccessLogTag() [2/7]

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

Definition at line 466 of file ListObjectVersionsRequest.h.

◆ AddCustomizedAccessLogTag() [3/7]

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

Definition at line 469 of file ListObjectVersionsRequest.h.

◆ AddCustomizedAccessLogTag() [4/7]

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

Definition at line 472 of file ListObjectVersionsRequest.h.

◆ AddCustomizedAccessLogTag() [5/7]

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

Definition at line 475 of file ListObjectVersionsRequest.h.

◆ AddCustomizedAccessLogTag() [6/7]

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

Definition at line 478 of file ListObjectVersionsRequest.h.

◆ AddCustomizedAccessLogTag() [7/7]

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

Definition at line 481 of file ListObjectVersionsRequest.h.

◆ AddQueryStringParameters()

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

The bucket name that contains the objects.

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 69 of file ListObjectVersionsRequest.h.

◆ CustomizedAccessLogTagHasBeenSet()

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

Definition at line 448 of file ListObjectVersionsRequest.h.

◆ DelimiterHasBeenSet()

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

A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.

Definition at line 172 of file ListObjectVersionsRequest.h.

◆ EncodingTypeHasBeenSet()

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

Definition at line 233 of file ListObjectVersionsRequest.h.

◆ GetBucket()

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

The bucket name that contains the objects.

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 55 of file ListObjectVersionsRequest.h.

◆ GetCustomizedAccessLogTag()

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

Definition at line 445 of file ListObjectVersionsRequest.h.

◆ GetDelimiter()

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

A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.

Definition at line 163 of file ListObjectVersionsRequest.h.

◆ GetEncodingType()

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

Definition at line 230 of file ListObjectVersionsRequest.h.

◆ GetKeyMarker()

const Aws::String& Aws::S3::Model::ListObjectVersionsRequest::GetKeyMarker ( ) const
inline

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

Definition at line 251 of file ListObjectVersionsRequest.h.

◆ GetMaxKeys()

int Aws::S3::Model::ListObjectVersionsRequest::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. If additional keys satisfy the search criteria, but were not returned because max-keys was exceeded, the response contains <isTruncated>true</isTruncated>. To return the additional keys, see key-marker and version-id-marker.

Definition at line 297 of file ListObjectVersionsRequest.h.

◆ GetPrefix()

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

Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes.

Definition at line 337 of file ListObjectVersionsRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file ListObjectVersionsRequest.h.

◆ GetVersionIdMarker()

const Aws::String& Aws::S3::Model::ListObjectVersionsRequest::GetVersionIdMarker ( ) const
inline

Specifies the object version you want to start listing from.

Definition at line 406 of file ListObjectVersionsRequest.h.

◆ KeyMarkerHasBeenSet()

bool Aws::S3::Model::ListObjectVersionsRequest::KeyMarkerHasBeenSet ( ) const
inline

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

Definition at line 256 of file ListObjectVersionsRequest.h.

◆ MaxKeysHasBeenSet()

bool Aws::S3::Model::ListObjectVersionsRequest::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. If additional keys satisfy the search criteria, but were not returned because max-keys was exceeded, the response contains <isTruncated>true</isTruncated>. To return the additional keys, see key-marker and version-id-marker.

Definition at line 307 of file ListObjectVersionsRequest.h.

◆ PrefixHasBeenSet()

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

Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes.

Definition at line 346 of file ListObjectVersionsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetBucket() [1/3]

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

The bucket name that contains the objects.

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 83 of file ListObjectVersionsRequest.h.

◆ SetBucket() [2/3]

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

The bucket name that contains the objects.

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 97 of file ListObjectVersionsRequest.h.

◆ SetBucket() [3/3]

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

The bucket name that contains the objects.

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 111 of file ListObjectVersionsRequest.h.

◆ SetCustomizedAccessLogTag() [1/2]

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

Definition at line 451 of file ListObjectVersionsRequest.h.

◆ SetCustomizedAccessLogTag() [2/2]

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

Definition at line 454 of file ListObjectVersionsRequest.h.

◆ SetDelimiter() [1/3]

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

A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.

Definition at line 181 of file ListObjectVersionsRequest.h.

◆ SetDelimiter() [2/3]

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

A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.

Definition at line 190 of file ListObjectVersionsRequest.h.

◆ SetDelimiter() [3/3]

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

A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.

Definition at line 199 of file ListObjectVersionsRequest.h.

◆ SetEncodingType() [1/2]

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

Definition at line 236 of file ListObjectVersionsRequest.h.

◆ SetEncodingType() [2/2]

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

Definition at line 239 of file ListObjectVersionsRequest.h.

◆ SetKeyMarker() [1/3]

void Aws::S3::Model::ListObjectVersionsRequest::SetKeyMarker ( const Aws::String value)
inline

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

Definition at line 261 of file ListObjectVersionsRequest.h.

◆ SetKeyMarker() [2/3]

void Aws::S3::Model::ListObjectVersionsRequest::SetKeyMarker ( Aws::String &&  value)
inline

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

Definition at line 266 of file ListObjectVersionsRequest.h.

◆ SetKeyMarker() [3/3]

void Aws::S3::Model::ListObjectVersionsRequest::SetKeyMarker ( const char *  value)
inline

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

Definition at line 271 of file ListObjectVersionsRequest.h.

◆ SetMaxKeys()

void Aws::S3::Model::ListObjectVersionsRequest::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. If additional keys satisfy the search criteria, but were not returned because max-keys was exceeded, the response contains <isTruncated>true</isTruncated>. To return the additional keys, see key-marker and version-id-marker.

Definition at line 317 of file ListObjectVersionsRequest.h.

◆ SetPrefix() [1/3]

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

Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes.

Definition at line 355 of file ListObjectVersionsRequest.h.

◆ SetPrefix() [2/3]

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

Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes.

Definition at line 364 of file ListObjectVersionsRequest.h.

◆ SetPrefix() [3/3]

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

Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes.

Definition at line 373 of file ListObjectVersionsRequest.h.

◆ SetVersionIdMarker() [1/3]

void Aws::S3::Model::ListObjectVersionsRequest::SetVersionIdMarker ( const Aws::String value)
inline

Specifies the object version you want to start listing from.

Definition at line 416 of file ListObjectVersionsRequest.h.

◆ SetVersionIdMarker() [2/3]

void Aws::S3::Model::ListObjectVersionsRequest::SetVersionIdMarker ( Aws::String &&  value)
inline

Specifies the object version you want to start listing from.

Definition at line 421 of file ListObjectVersionsRequest.h.

◆ SetVersionIdMarker() [3/3]

void Aws::S3::Model::ListObjectVersionsRequest::SetVersionIdMarker ( const char *  value)
inline

Specifies the object version you want to start listing from.

Definition at line 426 of file ListObjectVersionsRequest.h.

◆ VersionIdMarkerHasBeenSet()

bool Aws::S3::Model::ListObjectVersionsRequest::VersionIdMarkerHasBeenSet ( ) const
inline

Specifies the object version you want to start listing from.

Definition at line 411 of file ListObjectVersionsRequest.h.

◆ WithBucket() [1/3]

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

The bucket name that contains the objects.

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 125 of file ListObjectVersionsRequest.h.

◆ WithBucket() [2/3]

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

The bucket name that contains the objects.

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 139 of file ListObjectVersionsRequest.h.

◆ WithBucket() [3/3]

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

The bucket name that contains the objects.

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 153 of file ListObjectVersionsRequest.h.

◆ WithCustomizedAccessLogTag() [1/2]

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

Definition at line 457 of file ListObjectVersionsRequest.h.

◆ WithCustomizedAccessLogTag() [2/2]

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

Definition at line 460 of file ListObjectVersionsRequest.h.

◆ WithDelimiter() [1/3]

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

A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.

Definition at line 208 of file ListObjectVersionsRequest.h.

◆ WithDelimiter() [2/3]

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

A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.

Definition at line 217 of file ListObjectVersionsRequest.h.

◆ WithDelimiter() [3/3]

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

A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.

Definition at line 226 of file ListObjectVersionsRequest.h.

◆ WithEncodingType() [1/2]

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

Definition at line 242 of file ListObjectVersionsRequest.h.

◆ WithEncodingType() [2/2]

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

Definition at line 245 of file ListObjectVersionsRequest.h.

◆ WithKeyMarker() [1/3]

ListObjectVersionsRequest& Aws::S3::Model::ListObjectVersionsRequest::WithKeyMarker ( const Aws::String value)
inline

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

Definition at line 276 of file ListObjectVersionsRequest.h.

◆ WithKeyMarker() [2/3]

ListObjectVersionsRequest& Aws::S3::Model::ListObjectVersionsRequest::WithKeyMarker ( Aws::String &&  value)
inline

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

Definition at line 281 of file ListObjectVersionsRequest.h.

◆ WithKeyMarker() [3/3]

ListObjectVersionsRequest& Aws::S3::Model::ListObjectVersionsRequest::WithKeyMarker ( const char *  value)
inline

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

Definition at line 286 of file ListObjectVersionsRequest.h.

◆ WithMaxKeys()

ListObjectVersionsRequest& Aws::S3::Model::ListObjectVersionsRequest::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. If additional keys satisfy the search criteria, but were not returned because max-keys was exceeded, the response contains <isTruncated>true</isTruncated>. To return the additional keys, see key-marker and version-id-marker.

Definition at line 327 of file ListObjectVersionsRequest.h.

◆ WithPrefix() [1/3]

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

Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes.

Definition at line 382 of file ListObjectVersionsRequest.h.

◆ WithPrefix() [2/3]

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

Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes.

Definition at line 391 of file ListObjectVersionsRequest.h.

◆ WithPrefix() [3/3]

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

Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes.

Definition at line 400 of file ListObjectVersionsRequest.h.

◆ WithVersionIdMarker() [1/3]

ListObjectVersionsRequest& Aws::S3::Model::ListObjectVersionsRequest::WithVersionIdMarker ( const Aws::String value)
inline

Specifies the object version you want to start listing from.

Definition at line 431 of file ListObjectVersionsRequest.h.

◆ WithVersionIdMarker() [2/3]

ListObjectVersionsRequest& Aws::S3::Model::ListObjectVersionsRequest::WithVersionIdMarker ( Aws::String &&  value)
inline

Specifies the object version you want to start listing from.

Definition at line 436 of file ListObjectVersionsRequest.h.

◆ WithVersionIdMarker() [3/3]

ListObjectVersionsRequest& Aws::S3::Model::ListObjectVersionsRequest::WithVersionIdMarker ( const char *  value)
inline

Specifies the object version you want to start listing from.

Definition at line 441 of file ListObjectVersionsRequest.h.


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