com.amazonaws.services.s3.model

Class ListBucketsPaginatedRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.s3.model.ListBucketsPaginatedRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, S3AccelerateUnsupported, Serializable, Cloneable

public class ListBucketsPaginatedRequest
extends AmazonWebServiceRequest
implements Serializable, S3AccelerateUnsupported

Request object for listing Amazon S3 buckets owned by a user.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListBucketsPaginatedRequest()

Method Summary

Modifier and Type	Method and Description
String	getBucketRegion() Limits the response to buckets that are located in the specified Amazon Web Services region.
String	getContinuationToken() Returns the ContinuationToken.
Integer	getMaxBuckets() Returns the maximum number of buckets configured.
String	getPrefix() Returns the prefix for filtering bucket names.
void	setBucketRegion(String bucketRegion) Sets the bucket region for filtering the list of buckets.
void	setContinuationToken(String continuationToken) Sets the ContinuationToken.
void	setMaxBuckets(Integer maxBuckets) Sets the maximum number of buckets to be returned in response.
void	setPrefix(String prefix) Sets the prefix for filtering bucket names.
ListBucketsPaginatedRequest	withBucketRegion(String bucketRegion) Sets the bucket region for filtering the list of buckets.
ListBucketsPaginatedRequest	withContinuationToken(String continuationToken) Sets the ContinuationToken.
ListBucketsPaginatedRequest	withMaxBuckets(Integer maxBuckets) Sets the maximum number of buckets to be returned in response.
ListBucketsPaginatedRequest	withPrefix(String prefix) Sets the prefix for filtering bucket names.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ListBucketsPaginatedRequest

public ListBucketsPaginatedRequest()

Method Detail

getMaxBuckets

public Integer getMaxBuckets()

Returns the maximum number of buckets configured. When the number is more than the count of buckets that are owned by an AWS account, return all the buckets in response.

withMaxBuckets

public ListBucketsPaginatedRequest withMaxBuckets(Integer maxBuckets)

Sets the maximum number of buckets to be returned in response. When the number is more than the count of buckets that are owned by an AWS account, return all the buckets in response.

Parameters:

maxBuckets - The new maxBuckets value.

Returns:

This object for method chaining.

setMaxBuckets

public void setMaxBuckets(Integer maxBuckets)

Sets the maximum number of buckets to be returned in response. When the number is more than the count of buckets that are owned by an AWS account, return all the buckets in response.

Parameters:

maxBuckets - The new maxBuckets value.

getContinuationToken

public String getContinuationToken()

Returns the ContinuationToken. ContinuationToken indicates to Amazon S3 that the list is being continued on this bucket with a token.

withContinuationToken

public ListBucketsPaginatedRequest withContinuationToken(String continuationToken)

Sets the ContinuationToken. ContinuationToken indicates to Amazon S3 that the list is being continued on this bucket with a token.

ContinuationToken is obfuscated and is not a real key. You can use this ContinuationToken for pagination of the list results.

Parameters:

continuationToken - The new ContinuationToken value.

Returns:

This object for method chaining.

setContinuationToken

public void setContinuationToken(String continuationToken)

Sets the ContinuationToken. ContinuationToken indicates to Amazon S3 that the list is being continued on this bucket with a token.

ContinuationToken is obfuscated and is not a real key. You can use this ContinuationToken for pagination of the list results.

Parameters:

continuationToken - The new ContinuationToken value.

getPrefix

public String getPrefix()

Returns the prefix for filtering bucket names. Prefix is used to filter the list of buckets to only include buckets whose names start with the specified string.

withPrefix

public ListBucketsPaginatedRequest withPrefix(String prefix)

Sets the prefix for filtering bucket names. Prefix is used to filter the list of buckets to only include buckets whose names start with the specified string.

Parameters:

prefix - The new prefix value.

Returns:

This object for method chaining.

setPrefix

public void setPrefix(String prefix)

Sets the prefix for filtering bucket names. Prefix is used to filter the list of buckets to only include buckets whose names start with the specified string.

Parameters:

prefix - The new prefix value.

getBucketRegion

public String getBucketRegion()

Limits the response to buckets that are located in the specified Amazon Web Services region.

Returns:

The region where the buckets are located.

withBucketRegion

public ListBucketsPaginatedRequest withBucketRegion(String bucketRegion)

Sets the bucket region for filtering the list of buckets. Only buckets that are located in the specified region will be returned in the response.

Parameters:

bucketRegion - The region to filter buckets by.

Returns:

This object for method chaining.

setBucketRegion

public void setBucketRegion(String bucketRegion)

Sets the bucket region for filtering the list of buckets. Only buckets that are located in the specified region will be returned in the response.

Parameters:

bucketRegion - The region to filter buckets by.