Package org.apache.hadoop.hdfs.protocol

Interface HdfsFileStatus

All Superinterfaces:
Comparable<Object>, ObjectInputValidation, Serializable, org.apache.hadoop.io.Writable
All Known Implementing Classes:
HdfsLocatedFileStatus, HdfsNamedFileStatus
@Private @Evolving public interface HdfsFileStatus extends org.apache.hadoop.io.Writable, Comparable<Object>, Serializable, ObjectInputValidation
HDFS metadata for an entity in the filesystem.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    HdfsFileStatus.Builder
    Builder class for HdfsFileStatus instances.
    static enum 
    HdfsFileStatus.Flags
    Set of features potentially active on an instance.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final byte[]
    EMPTY_NAME
     

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    compareTo(org.apache.hadoop.fs.FileStatus stat)
    See FileStatus.compareTo(FileStatus).
    static org.apache.hadoop.fs.permission.FsPermission
    convert(boolean isdir, boolean symlink, org.apache.hadoop.fs.permission.FsPermission p, Set<HdfsFileStatus.Flags> f)
    Set redundant flags for compatibility with existing applications.
    static Set<org.apache.hadoop.fs.FileStatus.AttrFlags>
    convert(Set<HdfsFileStatus.Flags> flags)
     
    long
    getAccessTime()
    See FileStatus.getAccessTime().
    long
    getBlockSize()
    See FileStatus.getBlockSize().
    int
    getChildrenNum()
     
    ErasureCodingPolicy
    getErasureCodingPolicy()
    Get the erasure coding policy if it's set.
    org.apache.hadoop.fs.FileEncryptionInfo
    getFileEncryptionInfo()
    Get metadata for encryption, if present.
    long
    getFileId()
    Inode ID for this entity, if a file.
    default String
    getFullName(String parent)
    Get the string representation of the full path name.
    default org.apache.hadoop.fs.Path
    getFullPath(org.apache.hadoop.fs.Path parent)
    Get the full path.
    String
    getGroup()
    See FileStatus.getGroup().
    long
    getLen()
    See FileStatus.getLen().
    default String
    getLocalName()
    Get the string representation of the local name.
    byte[]
    getLocalNameInBytes()
    Get the Java UTF8 representation of the local name.
    long
    getModificationTime()
    See FileStatus.getModificationTime().
    String
    getNamespace()
     
    String
    getOwner()
    See FileStatus.getOwner().
    org.apache.hadoop.fs.Path
    getPath()
    See FileStatus.getPath().
    org.apache.hadoop.fs.permission.FsPermission
    getPermission()
    See FileStatus.getPermission().
    short
    getReplication()
    See FileStatus.getReplication().
    byte
    getStoragePolicy()
     
    org.apache.hadoop.fs.Path
    getSymlink()
    See FileStatus.getSymlink().
    byte[]
    getSymlinkInBytes()
    Opaque referant for the symlink, to be resolved at the client.
    boolean
    hasAcl()
    See FileStatus.hasAcl().
    boolean
    isDir()
    See FileStatus.isDir().
    boolean
    isDirectory()
    See FileStatus.isDirectory().
    default boolean
    isEmptyLocalName()
    Check if the local name is empty.
    boolean
    isEncrypted()
    See FileStatus.isEncrypted().
    boolean
    isErasureCoded()
    See FileStatus.isErasureCoded().
    boolean
    isFile()
    See FileStatus.isFile().
    boolean
    isSnapshotEnabled()
    See FileStatus.isSnapshotEnabled().
    boolean
    isSymlink()
    See FileStatus.isSymlink().
    default org.apache.hadoop.fs.FileStatus
    makeQualified(URI defaultUri, org.apache.hadoop.fs.Path parent)
    Resolve the short name of the Path given the URI, parent provided.
    void
    setGroup(String group)
    See FileStatus.setGroup(String).
    void
    setNamespace(String namespace)
     
    void
    setOwner(String owner)
    See FileStatus.setOwner(String).
    void
    setPath(org.apache.hadoop.fs.Path p)
    See FileStatus.setPath(Path).
    void
    setPermission(org.apache.hadoop.fs.permission.FsPermission permission)
    See FileStatus.setPermission(FsPermission).
    void
    setSymlink(org.apache.hadoop.fs.Path sym)
    See FileStatus.setSymlink(Path sym).

    Methods inherited from interface java.lang.Comparable

    compareTo

    Methods inherited from interface java.io.ObjectInputValidation

    validateObject

    Methods inherited from interface org.apache.hadoop.io.Writable

    readFields, write

  • Field Details

    • EMPTY_NAME

      static final byte[] EMPTY_NAME

  • Method Details

    • getFileId

      long getFileId()
      Inode ID for this entity, if a file.
      Returns:
      inode ID.

    • getFileEncryptionInfo

      org.apache.hadoop.fs.FileEncryptionInfo getFileEncryptionInfo()
      Get metadata for encryption, if present.
      Returns:
      the FileEncryptionInfo for this stream, or null if not encrypted.

    • isEmptyLocalName

      default boolean isEmptyLocalName()
      Check if the local name is empty.
      Returns:
      true if the name is empty

    • getLocalName

      default String getLocalName()
      Get the string representation of the local name.
      Returns:
      the local name in string

    • getLocalNameInBytes

      byte[] getLocalNameInBytes()
      Get the Java UTF8 representation of the local name.
      Returns:
      the local name in java UTF8

    • getFullName

      default String getFullName(String parent)
      Get the string representation of the full path name.
      Parameters:
      parent - the parent path
      Returns:
      the full path in string

    • getFullPath

      default org.apache.hadoop.fs.Path getFullPath(org.apache.hadoop.fs.Path parent)
      Get the full path.
      Parameters:
      parent - the parent path
      Returns:
      the full path

    • getSymlinkInBytes

      byte[] getSymlinkInBytes()
      Opaque referant for the symlink, to be resolved at the client.

    • getChildrenNum

      int getChildrenNum()
      Returns:
      number of children for this inode.

    • getErasureCodingPolicy

      ErasureCodingPolicy getErasureCodingPolicy()
      Get the erasure coding policy if it's set.
      Returns:
      the erasure coding policy

    • getStoragePolicy

      byte getStoragePolicy()
      Returns:
      the storage policy id

    • makeQualified

      default org.apache.hadoop.fs.FileStatus makeQualified(URI defaultUri, org.apache.hadoop.fs.Path parent)
      Resolve the short name of the Path given the URI, parent provided. This FileStatus reference will not contain a valid Path until it is resolved by this method.
      Parameters:
      defaultUri - FileSystem to fully qualify HDFS path.
      parent - Parent path of this element.
      Returns:
      Reference to this instance.

    • getPath

      org.apache.hadoop.fs.Path getPath()
      See FileStatus.getPath().

    • setPath

      void setPath(org.apache.hadoop.fs.Path p)
      See FileStatus.setPath(Path).

    • getLen

      long getLen()
      See FileStatus.getLen().

    • isFile

      boolean isFile()
      See FileStatus.isFile().

    • isDirectory

      boolean isDirectory()
      See FileStatus.isDirectory().

    • isDir

      boolean isDir()
      See FileStatus.isDir().

    • isSymlink

      boolean isSymlink()
      See FileStatus.isSymlink().

    • getBlockSize

      long getBlockSize()
      See FileStatus.getBlockSize().

    • getReplication

      short getReplication()
      See FileStatus.getReplication().

    • getModificationTime

      long getModificationTime()
      See FileStatus.getModificationTime().

    • getAccessTime

      long getAccessTime()
      See FileStatus.getAccessTime().

    • getPermission

      org.apache.hadoop.fs.permission.FsPermission getPermission()
      See FileStatus.getPermission().

    • setPermission

      void setPermission(org.apache.hadoop.fs.permission.FsPermission permission)
      See FileStatus.setPermission(FsPermission).

    • getOwner

      String getOwner()
      See FileStatus.getOwner().

    • setOwner

      void setOwner(String owner)
      See FileStatus.setOwner(String).

    • getGroup

      String getGroup()
      See FileStatus.getGroup().

    • setGroup

      void setGroup(String group)
      See FileStatus.setGroup(String).

    • hasAcl

      boolean hasAcl()
      See FileStatus.hasAcl().

    • isEncrypted

      boolean isEncrypted()
      See FileStatus.isEncrypted().

    • isErasureCoded

      boolean isErasureCoded()
      See FileStatus.isErasureCoded().

    • isSnapshotEnabled

      boolean isSnapshotEnabled()
      See FileStatus.isSnapshotEnabled().

    • getSymlink

      org.apache.hadoop.fs.Path getSymlink() throws IOException
      See FileStatus.getSymlink().
      Throws:
      IOException

    • setSymlink

      void setSymlink(org.apache.hadoop.fs.Path sym)
      See FileStatus.setSymlink(Path sym).

    • compareTo

      int compareTo(org.apache.hadoop.fs.FileStatus stat)
      See FileStatus.compareTo(FileStatus).

    • setNamespace

      void setNamespace(String namespace)

    • getNamespace

      String getNamespace()

    • convert

      static org.apache.hadoop.fs.permission.FsPermission convert(boolean isdir, boolean symlink, org.apache.hadoop.fs.permission.FsPermission p, Set<HdfsFileStatus.Flags> f)
      Set redundant flags for compatibility with existing applications.

    • convert

      static Set<org.apache.hadoop.fs.FileStatus.AttrFlags> convert(Set<HdfsFileStatus.Flags> flags)