Package alluxio.proxy.s3

Class ListBucketResult

java.lang.Object

alluxio.proxy.s3.ListBucketResult

public class ListBucketResult
extends java.lang.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	Description
class	ListBucketResult.CommonPrefixes	Common Prefixes list placeholder object.
class	ListBucketResult.Content	Object metadata class.

Constructor Summary

Constructors

Constructor	Description
ListBucketResult()	Creates an ListBucketResult.
ListBucketResult(java.lang.String bucketName, java.util.List<alluxio.client.file.URIStatus> children, ListBucketOptions options)	Creates an ListBucketResult.

Method Summary

Modifier and Type	Method	Description
ListBucketResult.CommonPrefixes	getCommonPrefixes()
java.util.List<ListBucketResult.Content>	getContents()
java.lang.String	getDelimiter()
java.lang.String	getEncodingType()
int	getKeyCount()
java.lang.String	getMarker()
int	getMaxKeys()
java.lang.String	getName()
java.lang.String	getNextMarker()
java.lang.String	getPrefix()
boolean	isTruncated()

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(java.lang.String bucketName,
                        java.util.List<alluxio.client.file.URIStatus> children,
                        ListBucketOptions options)

Creates an ListBucketResult.

Parameters:

bucketName - the bucket name

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

options - the list bucket options

Method Detail

getName

public java.lang.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 java.lang.String getPrefix()

Returns:

the prefix

getDelimiter

public java.lang.String getDelimiter()

Returns:

the delimiter

getEncodingType

public java.lang.String getEncodingType()

Returns:

the encoding type of the result

getMarker

public java.lang.String getMarker()

Returns:

the marker

getNextMarker

public java.lang.String getNextMarker()

Returns:

the next marker

getContents

public java.util.List<ListBucketResult.Content> getContents()

Returns:

the list of contents

getCommonPrefixes

public ListBucketResult.CommonPrefixes getCommonPrefixes()

Returns:

the common prefixes