public class ListObjectsV2Request extends AmazonWebServiceRequest implements java.io.Serializable
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
bucketName
The name of the Amazon S3 bucket to list.
|
private java.lang.String |
continuationToken
Optional parameter which allows list to be continued from a specific point.
|
private java.lang.String |
delimiter
Optional parameter that causes keys that contain the same string between
the prefix and the first occurrence of the delimiter to be rolled up into
a single result element in the
ListObjectsV2Result.getCommonPrefixes() list. |
private java.lang.String |
encodingType
Optional parameter indicating the encoding method to be applied on the
response.
|
private boolean |
fetchOwner
The owner field is not present in ListObjectsV2 results by default.
|
private java.lang.Integer |
maxKeys
Optional parameter indicating the maximum number of keys to include in
the response.
|
private java.lang.String |
prefix
Optional parameter restricting the response to keys which begin with the
specified prefix.
|
private java.lang.String |
startAfter
Optional parameter indicating where you want Amazon S3 to start the object listing
from.
|
NOOP
Constructor and Description |
---|
ListObjectsV2Request() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getBucketName()
Gets the name of the Amazon S3 bucket whose
objects are to be listed.
|
java.lang.String |
getContinuationToken()
Gets the optional continuation token.
|
java.lang.String |
getDelimiter()
Gets the optional delimiter parameter that causes keys that contain
the same string between the prefix and the first occurrence of the
delimiter to be combined into a single result element in the
ListObjectsV2Result.getCommonPrefixes() list. |
java.lang.String |
getEncodingType()
Gets the optional
encodingType parameter indicating the
encoding method to be applied on the response. |
java.lang.Integer |
getMaxKeys()
Gets the optional
maxKeys parameter indicating the maximum number of keys to
include in the response. |
java.lang.String |
getPrefix()
Gets the optional prefix parameter and restricts the response to keys
that begin with the specified prefix.
|
java.lang.String |
getStartAfter()
Returns optional parameter indicating where you want Amazon S3 to start the object
listing from.
|
boolean |
isFetchOwner()
Returns if fetch owner is set.
|
void |
setBucketName(java.lang.String bucketName)
Sets the name of the Amazon S3 bucket whose objects are to be listed.
|
void |
setContinuationToken(java.lang.String continuationToken)
Sets the optional continuation token.
|
void |
setDelimiter(java.lang.String delimiter)
Sets the optional delimiter parameter that causes keys that contain the
same string between the prefix and the first occurrence of the delimiter
to be combined into a single result element in the
ListObjectsV2Result.getCommonPrefixes() list. |
void |
setEncodingType(java.lang.String encodingType)
Sets the optional
encodingType parameter indicating the
encoding method to be applied on the response. |
void |
setFetchOwner(boolean fetchOwner)
Sets the optional fetch owner flag.
|
void |
setMaxKeys(java.lang.Integer maxKeys)
Sets the optional
maxKeys parameter indicating the maximum number of keys to
include in the response. |
void |
setPrefix(java.lang.String prefix)
Sets the optional prefix parameter, restricting the response to keys that
begin with the specified prefix.
|
void |
setStartAfter(java.lang.String startAfter)
Sets the optional parameter indicating where you want Amazon S3 to start the object
listing from.
|
ListObjectsV2Request |
withBucketName(java.lang.String bucketName)
Sets the name of the Amazon S3 bucket whose objects are to be listed.
|
ListObjectsV2Request |
withContinuationToken(java.lang.String continuationToken)
Sets the optional continuation token.
|
ListObjectsV2Request |
withDelimiter(java.lang.String delimiter)
Sets the optional delimiter parameter that causes keys that contain the
same string between the prefix and the first occurrence of the delimiter
to be rolled up into a single result element in the
ListObjectsV2Result.getCommonPrefixes() list. |
ListObjectsV2Request |
withEncodingType(java.lang.String encodingType)
Sets the optional
encodingType parameter indicating the
encoding method to be applied on the response. |
ListObjectsV2Request |
withFetchOwner(boolean fetchOwner)
Sets the optional fetch owner flag.
|
ListObjectsV2Request |
withMaxKeys(java.lang.Integer maxKeys)
Sets the optional
maxKeys parameter indicating the maximum number of keys to
include in the response. |
ListObjectsV2Request |
withPrefix(java.lang.String prefix)
Sets the optional prefix parameter restricting the response to keys that
begin with the specified prefix.
|
ListObjectsV2Request |
withStartAfter(java.lang.String startAfter)
Sets the optional parameter indicating where you want Amazon S3 to start the object
listing from.
|
clone, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
private java.lang.String bucketName
private java.lang.String delimiter
ListObjectsV2Result.getCommonPrefixes()
list. These rolled-up keys
are not returned elsewhere in the response. The most commonly used
delimiter is "/", which simulates a hierarchical organization similar to
a file system directory structure.private java.lang.String encodingType
private java.lang.Integer maxKeys
private java.lang.String prefix
private java.lang.String continuationToken
private boolean fetchOwner
private java.lang.String startAfter
public java.lang.String getBucketName()
public void setBucketName(java.lang.String bucketName)
bucketName
- The name of the Amazon S3 bucket whose objects are to be
listed.public ListObjectsV2Request withBucketName(java.lang.String bucketName)
ListObjectsV2Request
, enabling additional method
calls to be chained together.bucketName
- The name of the Amazon S3 bucket whose objects are to be
listed.ListObjectsV2Request
, enabling additional method
calls to be chained together.public java.lang.String getDelimiter()
ListObjectsV2Result.getCommonPrefixes()
list. These combined keys
are not returned elsewhere in the response. The most commonly used
delimiter is "/", which simulates a hierarchical organization similar to
a file system directory structure.ListObjectsV2Result.getCommonPrefixes()
list.public void setDelimiter(java.lang.String delimiter)
ListObjectsV2Result.getCommonPrefixes()
list.delimiter
- The optional delimiter parameter that causes keys that contain
the same string between the prefix and the first occurrence of
the delimiter to be combined into a single result element in
the ListObjectsV2Result.getCommonPrefixes()
list.public ListObjectsV2Request withDelimiter(java.lang.String delimiter)
ListObjectsV2Result.getCommonPrefixes()
list.
Returns this ListObjectsRequest
, enabling additional method
calls to be chained together.delimiter
- The optional delimiter parameter that causes keys that contain
the same string between the prefix and the first occurrence of
the delimiter to be rolled up into a single result element in
the ListObjectsV2Result.getCommonPrefixes()
list.ListObjectsRequest
, enabling additional method
calls to be chained together.public java.lang.String getEncodingType()
encodingType
parameter indicating the
encoding method to be applied on the response.public void setEncodingType(java.lang.String encodingType)
encodingType
parameter indicating the
encoding method to be applied on the response. An object key can 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.encodingType
- The encoding method to be applied on the response. Valid
values: null (not encoded) or "url".public ListObjectsV2Request withEncodingType(java.lang.String encodingType)
encodingType
parameter indicating the
encoding method to be applied on the response. An object key can 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.
Returns this ListObjectsV2Request
, enabling additional method calls
to be chained together.encodingType
- The encoding method to be applied on the response. Valid
values: null (not encoded) or "url".public java.lang.Integer getMaxKeys()
maxKeys
parameter indicating the maximum number of keys to
include in the response. Amazon S3 might return fewer keys than specified, but will
never return more. Even if the optional parameter is not specified,
Amazon S3 will limit the number of results in the response.public void setMaxKeys(java.lang.Integer maxKeys)
maxKeys
parameter indicating the maximum number of keys to
include in the response.maxKeys
- The optional parameter indicating the maximum number of keys
to include in the response.public ListObjectsV2Request withMaxKeys(java.lang.Integer maxKeys)
maxKeys
parameter indicating the maximum number of keys to
include in the response.
Returns this ListObjectsV2Request
, enabling additional method
calls to be chained together.maxKeys
- The optional parameter indicating the maximum number of keys
to include in the response.ListObjectsV2Request
, enabling additional method
calls to be chained together.getMaxKeys()
,
setMaxKeys(Integer)
public java.lang.String getPrefix()
setPrefix(String)
public void setPrefix(java.lang.String prefix)
prefix
- The optional prefix parameter, restricting the response to keys
that begin with the specified prefix.getPrefix()
public ListObjectsV2Request withPrefix(java.lang.String prefix)
ListObjectsV2Request
, enabling additional method
calls to be chained together.prefix
- The optional prefix parameter restricting the response to keys
that begin with the specified prefix.ListObjectsV2Request
, enabling additional method
calls to be chained together.getPrefix()
,
setPrefix(String)
public java.lang.String getContinuationToken()
public void setContinuationToken(java.lang.String continuationToken)
continuationToken
- The optional continuation token to associate with this request.public ListObjectsV2Request withContinuationToken(java.lang.String continuationToken)
continuationToken
- The optional continuation token to associate with this request.ListObjectsV2Request
, enabling additional method
calls to be chained together.public boolean isFetchOwner()
public void setFetchOwner(boolean fetchOwner)
fetchOwner
- Set to true if the owner field should be included in resultspublic ListObjectsV2Request withFetchOwner(boolean fetchOwner)
fetchOwner
- Set to true if the owner field should be included in resultsListObjectsV2Request
, enabling additional method
calls to be chained together.public java.lang.String getStartAfter()
public void setStartAfter(java.lang.String startAfter)
startAfter
- The optional startAfter parameter. This can be any key in the bucket.public ListObjectsV2Request withStartAfter(java.lang.String startAfter)
startAfter
- The optional startAfter parameter. This can be any key in the bucket.ListObjectsV2Request
, enabling additional method
calls to be chained together.