Twoorb Plugins  1.0
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Amazon.S3.Model.ListObjectsRequest Class Reference

Container for the parameters to the ListObjects operation. More...

Inheritance diagram for Amazon.S3.Model.ListObjectsRequest:

Properties

string BucketName [get, set]
 The name of the bucket containing the objects whose keys are to be listed. More...
 
string Delimiter [get, set]
 A delimiter is a character you use to group keys. More...
 
string Marker [get, set]
 Specifies the key to start with when listing objects in a bucket. More...
 
int MaxKeys [get, set]
 Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. More...
 
string Prefix [get, set]
 Limits the response to keys that begin with the specified prefix. More...
 
EncodingType Encoding [get, set]
 Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. More...
 

Detailed Description

Container for the parameters to the ListObjects operation.

Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket.

Property Documentation

string Amazon.S3.Model.ListObjectsRequest.BucketName
getset

The name of the bucket containing the objects whose keys are to be listed.

string Amazon.S3.Model.ListObjectsRequest.Delimiter
getset

A delimiter is a character you use to group keys.

EncodingType Amazon.S3.Model.ListObjectsRequest.Encoding
getset

Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.

string Amazon.S3.Model.ListObjectsRequest.Marker
getset

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

int Amazon.S3.Model.ListObjectsRequest.MaxKeys
getset

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

string Amazon.S3.Model.ListObjectsRequest.Prefix
getset

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


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