org.apache.hadoop.fs.s3a

Class S3ListResult

java.lang.Object

org.apache.hadoop.fs.s3a.S3ListResult

public class S3ListResult
extends Object

API version-independent container for S3 List responses.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	S3ListResult(com.amazonaws.services.s3.model.ObjectListing v1, com.amazonaws.services.s3.model.ListObjectsV2Result v2)

Method Summary

Modifier and Type	Method and Description
List<String>	getCommonPrefixes()
List<com.amazonaws.services.s3.model.S3ObjectSummary>	getObjectSummaries()
com.amazonaws.services.s3.model.ObjectListing	getV1()
com.amazonaws.services.s3.model.ListObjectsV2Result	getV2()
boolean	hasPrefixesOrObjects(ContextAccessors accessors, Set<org.apache.hadoop.fs.Path> tombstones) Does this listing have prefixes or objects after entries with tombstones have been stripped?
boolean	isEmptyOfKeys(ContextAccessors accessors, Collection<String> keys, Set<org.apache.hadoop.fs.Path> tombstones) Helper function to determine if a collection of keys is empty after accounting for tombstone markers (if provided).
boolean	isEmptyOfObjects(ContextAccessors accessors, Set<org.apache.hadoop.fs.Path> tombstones) Is the list of object summaries empty after accounting for tombstone markers (if provided)?
boolean	isTruncated()
boolean	isV1() Is this a v1 API result or v2?
void	logAtDebug(org.slf4j.Logger log) Dmp the result at debug level.
boolean	representsEmptyDirectory(ContextAccessors contextAccessors, String dirKey, Set<org.apache.hadoop.fs.Path> tombstones) Does this listing represent an empty directory?
static S3ListResult	v1(com.amazonaws.services.s3.model.ObjectListing result) Restricted constructors to ensure v1 or v2, not both.
static S3ListResult	v2(com.amazonaws.services.s3.model.ListObjectsV2Result result) Restricted constructors to ensure v1 or v2, not both.

Methods inherited from class java.lang.Object

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

Constructor Detail

S3ListResult

protected S3ListResult(com.amazonaws.services.s3.model.ObjectListing v1,
                       com.amazonaws.services.s3.model.ListObjectsV2Result v2)

Method Detail

v1

public static S3ListResult v1(com.amazonaws.services.s3.model.ObjectListing result)

Restricted constructors to ensure v1 or v2, not both.

Parameters:

result - v1 result

Returns:

new list result container

v2

public static S3ListResult v2(com.amazonaws.services.s3.model.ListObjectsV2Result result)

Restricted constructors to ensure v1 or v2, not both.

Parameters:

result - v2 result

Returns:

new list result container

isV1

public boolean isV1()

Is this a v1 API result or v2?

Returns:

true if v1, false if v2

getV1

public com.amazonaws.services.s3.model.ObjectListing getV1()

getV2

public com.amazonaws.services.s3.model.ListObjectsV2Result getV2()

getObjectSummaries

public List<com.amazonaws.services.s3.model.S3ObjectSummary> getObjectSummaries()

isTruncated

public boolean isTruncated()

getCommonPrefixes

public List<String> getCommonPrefixes()

isEmptyOfObjects

public boolean isEmptyOfObjects(ContextAccessors accessors,
                                Set<org.apache.hadoop.fs.Path> tombstones)

Is the list of object summaries empty after accounting for tombstone markers (if provided)?

Parameters:

accessors - callback for key to path mapping.

tombstones - Set of tombstone markers, or null if not applicable.

Returns:

false if summaries contains objects not accounted for by tombstones.

hasPrefixesOrObjects

public boolean hasPrefixesOrObjects(ContextAccessors accessors,
                                    Set<org.apache.hadoop.fs.Path> tombstones)

Does this listing have prefixes or objects after entries with tombstones have been stripped?

Parameters:

accessors - callback for key to path mapping.

tombstones - Set of tombstone markers, or null if not applicable.

Returns:

true if the reconciled list is non-empty

isEmptyOfKeys

public boolean isEmptyOfKeys(ContextAccessors accessors,
                             Collection<String> keys,
                             Set<org.apache.hadoop.fs.Path> tombstones)

Helper function to determine if a collection of keys is empty after accounting for tombstone markers (if provided).

Parameters:

accessors - callback for key to path mapping.

keys - Collection of path (prefixes / directories or keys).

tombstones - Set of tombstone markers, or null if not applicable.

Returns:

true if the list is considered empty.

representsEmptyDirectory

public boolean representsEmptyDirectory(ContextAccessors contextAccessors,
                                        String dirKey,
                                        Set<org.apache.hadoop.fs.Path> tombstones)

Does this listing represent an empty directory?

Parameters:

contextAccessors - callback for key to path mapping.

dirKey - directory key

tombstones - Set of tombstone markers, or null if not applicable.

Returns:

true if the list is considered empty.

logAtDebug

public void logAtDebug(org.slf4j.Logger log)

Dmp the result at debug level.

Parameters:

log - log to use