org.apache.hadoop.fs.s3a.s3guard

Class PathMetadata

java.lang.Object

org.apache.hadoop.fs.s3a.s3guard.ExpirableMetadata

org.apache.hadoop.fs.s3a.s3guard.PathMetadata

Direct Known Subclasses:

DDBPathMetadata

@InterfaceAudience.Private
 @InterfaceStability.Evolving
public class PathMetadata
extends ExpirableMetadata

PathMetadata models path metadata stored in the MetadataStore. The lastUpdated field is implicitly set to 0 in the constructors without that parameter to show that it will be initialized with 0 if not set otherwise.

Constructor Summary

Constructors

Constructor and Description
PathMetadata(S3AFileStatus fileStatus) Creates a new PathMetadata containing given FileStatus.
PathMetadata(S3AFileStatus fileStatus, long lastUpdated) Creates a new PathMetadata containing given FileStatus.
PathMetadata(S3AFileStatus fileStatus, Tristate isEmptyDir) Creates a new PathMetadata.
PathMetadata(S3AFileStatus fileStatus, Tristate isEmptyDir, boolean isDeleted) Creates a new PathMetadata.
PathMetadata(S3AFileStatus fileStatus, Tristate isEmptyDir, boolean isDeleted, long lastUpdated) Creates a new PathMetadata.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
S3AFileStatus	getFileStatus()
int	hashCode()
boolean	isDeleted()
Tristate	isEmptyDirectory() Query if a directory is empty.
String	prettyPrint()
void	prettyPrint(StringBuilder sb) Log contents to supplied StringBuilder in a pretty fashion.
static PathMetadata	tombstone(org.apache.hadoop.fs.Path path, long lastUpdated) Create a tombstone from the current time.
String	toString()

Methods inherited from class org.apache.hadoop.fs.s3a.s3guard.ExpirableMetadata

getLastUpdated, isExpired, setLastUpdated

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PathMetadata

public PathMetadata(S3AFileStatus fileStatus)

Creates a new PathMetadata containing given FileStatus. lastUpdated field will be updated to 0 implicitly in this constructor.

Parameters:

fileStatus - file status containing an absolute path.

PathMetadata

public PathMetadata(S3AFileStatus fileStatus,
                    long lastUpdated)

Creates a new PathMetadata containing given FileStatus.

Parameters:

fileStatus - file status containing an absolute path.

lastUpdated - last updated time on which expiration is based.

PathMetadata

public PathMetadata(S3AFileStatus fileStatus,
                    Tristate isEmptyDir)

Creates a new PathMetadata. lastUpdated field will be updated to 0 implicitly in this constructor.

Parameters:

fileStatus - file status containing an absolute path.

isEmptyDir - empty directory Tristate

PathMetadata

public PathMetadata(S3AFileStatus fileStatus,
                    Tristate isEmptyDir,
                    boolean isDeleted)

Creates a new PathMetadata. lastUpdated field will be updated to 0 implicitly in this constructor.

Parameters:

fileStatus - file status containing an absolute path.

isEmptyDir - empty directory Tristate

isDeleted - deleted / tombstoned flag

PathMetadata

public PathMetadata(S3AFileStatus fileStatus,
                    Tristate isEmptyDir,
                    boolean isDeleted,
                    long lastUpdated)

Creates a new PathMetadata.

Parameters:

fileStatus - file status containing an absolute path.

isEmptyDir - empty directory Tristate

isDeleted - deleted / tombstoned flag

lastUpdated - last updated time on which expiration is based.

Method Detail

tombstone

public static PathMetadata tombstone(org.apache.hadoop.fs.Path path,
                                     long lastUpdated)

Create a tombstone from the current time. It is mandatory to set the lastUpdated field to update when the tombstone state has changed to set when the entry got deleted.

Parameters:

path - path to tombstone

lastUpdated - last updated time on which expiration is based.

Returns:

the entry.

getFileStatus

public final S3AFileStatus getFileStatus()

Returns:

FileStatus contained in this PathMetadata.

isEmptyDirectory

public Tristate isEmptyDirectory()

Query if a directory is empty.

Returns:

Tristate.TRUE if this is known to be an empty directory, Tristate.FALSE if known to not be empty, and Tristate.UNKNOWN if the MetadataStore does have enough information to determine either way.

isDeleted

public boolean isDeleted()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

prettyPrint

public void prettyPrint(StringBuilder sb)

Log contents to supplied StringBuilder in a pretty fashion.

Parameters:

sb - target StringBuilder

prettyPrint

public String prettyPrint()