alluxio.proxy.s3

Class ListBucketResult

java.lang.Object

alluxio.proxy.s3.ListBucketResult

public class ListBucketResult
extends Object

Get bucket result defined in http://docs.aws.amazon.com/AmazonS3/latest/API/v2-RESTBucketGET.html It will be encoded into an XML string to be returned as a response for the REST call. TODO(chaomin): consider add more required fields in S3 BucketGet API.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ListBucketResult.Content Object metadata class.

Constructor Summary

Constructors

Constructor and Description
ListBucketResult() Creates an ListBucketResult.
ListBucketResult(String bucketName, List<URIStatus> objectsList, ListBucketOptions options) Creates an ListBucketResult.

Method Summary

Modifier and Type	Method and Description
List<ListBucketResult.Content>	getContents()
String	getContinuationToken()
int	getKeyCount()
int	getMaxKeys()
String	getName()
String	getNextContinuationToken()
String	getPrefix()
boolean	isTruncated()
void	setContent(List<ListBucketResult.Content> contents)
void	setContinuationToken(String continuationToken)
void	setIsTruncated(boolean isTruncated)
void	setKeyCount(int keyCount)
void	setMaxKeys(int maxKeys)
void	setName(String name)
void	setNextContinuationToken(String nextContinuationToken)
void	setPrefix(String prefix)

Methods inherited from class java.lang.Object

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

Constructor Detail

ListBucketResult

public ListBucketResult()

Creates an ListBucketResult.

ListBucketResult

public ListBucketResult(String bucketName,
                        List<URIStatus> objectsList,
                        ListBucketOptions options)

Creates an ListBucketResult.

Parameters:

bucketName - the bucket name

objectsList - a list of URIStatus, representing the objects

options - the list bucket options

Method Detail

getName

public String getName()

Returns:

the bucket name

getPrefix

public String getPrefix()

Returns:

the prefix

getContinuationToken

public String getContinuationToken()

Returns:

the continuation token

getNextContinuationToken

public String getNextContinuationToken()

Returns:

the next continuation token

getKeyCount

public int getKeyCount()

Returns:

the number of keys included in the response

getMaxKeys

public int getMaxKeys()

Returns:

the maximum number of keys returned in the response body

isTruncated

public boolean isTruncated()

Returns:

false if all results are returned, otherwise true

getContents

public List<ListBucketResult.Content> getContents()

Returns:

the list of contents

setName

public void setName(String name)

Parameters:

name - the bucket name to set

setPrefix

public void setPrefix(String prefix)

Parameters:

prefix - the prefix to set

setContinuationToken

public void setContinuationToken(String continuationToken)

Parameters:

continuationToken - the continuation token to set

setNextContinuationToken

public void setNextContinuationToken(String nextContinuationToken)

Parameters:

nextContinuationToken - the next continuation token to set

setKeyCount

public void setKeyCount(int keyCount)

Parameters:

keyCount - the number of keys to set

setMaxKeys

public void setMaxKeys(int maxKeys)

Parameters:

maxKeys - the maximum number of keys returned value to set

setIsTruncated

public void setIsTruncated(boolean isTruncated)

Parameters:

isTruncated - the isTruncated value to set

setContent

public void setContent(List<ListBucketResult.Content> contents)

Parameters:

contents - the contents list to set