alluxio.proxy.s3

Class ListBucketResult

java.lang.Object

alluxio.proxy.s3.ListBucketResult

public class ListBucketResult
extends Object

Get bucket result defined in https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html It will be encoded into an XML string to be returned as a response for the REST call.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListBucketResult.CommonPrefix Common Prefixes list placeholder object.
static class	ListBucketResult.Content Object metadata class.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static String	decodeToken(String token) Decode a continuation token which is used in get Bucket.
static String	encodeToken(String key) Generate a continuation token which is used in get Bucket.
List<ListBucketResult.CommonPrefix>	getCommonPrefixes()
List<ListBucketResult.Content>	getContents()
String	getContinuationToken()
String	getDelimiter()
String	getEncodingType()
int	getKeyCount()
String	getMarker()
int	getMaxKeys()
String	getName()
String	getNextContinuationToken()
String	getNextMarker()
String	getPrefix()
String	getStartAfter()
boolean	isTruncated()
boolean	isVersion2()

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> children,
                        ListBucketOptions options)
                 throws S3Exception

Creates an ListBucketResult.

Parameters:

bucketName - the bucket name

children - a list of URIStatus, representing the objects and common prefixes

options - the list bucket options

Throws:

S3Exception

Method Detail

isVersion2

public boolean isVersion2()

Returns:

if listObjectV2 version

getName

public String getName()

Returns:

the bucket name

getKeyCount

public int getKeyCount()

Returns:

the number of keys included in the response

getMaxKeys

public int getMaxKeys()

Returns:

the number of keys included in the response

isTruncated

public boolean isTruncated()

Returns:

false if all results are returned, otherwise true

getPrefix

public String getPrefix()

Returns:

the prefix

getDelimiter

public String getDelimiter()

Returns:

the delimiter

getEncodingType

public String getEncodingType()

Returns:

the encoding type of the result

getMarker

public String getMarker()

Returns:

the marker

getNextMarker

public String getNextMarker()

Returns:

the next marker

getContinuationToken

public String getContinuationToken()

Returns:

the continuationToken

getNextContinuationToken

public String getNextContinuationToken()

Returns:

the nextContinuationToken

getStartAfter

public String getStartAfter()

Returns:

the startAfter

getContents

public List<ListBucketResult.Content> getContents()

Returns:

the list of contents

getCommonPrefixes

public List<ListBucketResult.CommonPrefix> getCommonPrefixes()

Returns:

the common prefixes

encodeToken

public static String encodeToken(String key)

Generate a continuation token which is used in get Bucket.

Parameters:

key - used to encode to a token

Returns:

if key is not null return continuation token, else returns null

decodeToken

public static String decodeToken(String token)
                          throws S3Exception

Decode a continuation token which is used in get Bucket.

Parameters:

token - used to decode to a key

Returns:

if token is not null return decoded key, otherwise returns null

Throws:

S3Exception