FileInfo (Alluxio Parent 2.2.3-SNAPSHOT API)

java.lang.Object
- alluxio.wire.FileInfo

All Implemented Interfaces:: Serializable

@NotThreadSafe
public final class FileInfo
extends Object
implements Serializable

The file information.

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

FileInfo()
Creates a new instance of FileInfo.

Constructors
Constructor and Description
`FileInfo()` Creates a new instance of `FileInfo`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`convertAclToStringEntries()`
`List<String>`	`convertDefaultAclToStringEntries()`
`boolean`	`equals(Object o)`
`AccessControlList`	`getAcl()`
`List<Long>`	`getBlockIds()`
`long`	`getBlockSizeBytes()`
`long`	`getCreationTimeMs()`
`DefaultAccessControlList`	`getDefaultAcl()`
`FileBlockInfo`	`getFileBlockInfo(long blockId)`
`List<FileBlockInfo>`	`getFileBlockInfos()`
`long`	`getFileId()`
`String`	`getFileIdentifier()` Similar to `getFileId()`, but returns in a string form, allowing for the use of non-long based ids.
`String`	`getGroup()`
`int`	`getInAlluxioPercentage()`
`int`	`getInMemoryPercentage()`
`long`	`getLastAccessTimeMs()`
`long`	`getLastModificationTimeMs()`
`long`	`getLength()`
`Set<String>`	`getMediumTypes()`
`int`	`getMode()`
`long`	`getMountId()`
`String`	`getName()`
`String`	`getOwner()`
`String`	`getPath()`
`String`	`getPersistenceState()`
`int`	`getReplicationMax()`
`int`	`getReplicationMin()`
`long`	`getTtl()`
`TtlAction`	`getTtlAction()`
`String`	`getUfsFingerprint()`
`String`	`getUfsPath()`
`Map<String,byte[]>`	`getXAttr()`
`int`	`hashCode()`
`boolean`	`isCacheable()`
`boolean`	`isCompleted()`
`boolean`	`isFolder()`
`boolean`	`isMountPoint()`
`boolean`	`isPersisted()`
`boolean`	`isPinned()`
`FileInfo`	`setAcl(AccessControlList acl)`
`FileInfo`	`setBlockIds(List<Long> blockIds)`
`FileInfo`	`setBlockSizeBytes(long blockSizeBytes)`
`FileInfo`	`setCacheable(boolean cacheable)`
`FileInfo`	`setCompleted(boolean completed)`
`FileInfo`	`setCreationTimeMs(long creationTimeMs)`
`FileInfo`	`setDefaultAcl(DefaultAccessControlList defaultAcl)`
`FileInfo`	`setFileBlockInfos(List<FileBlockInfo> fileBlockInfos)`
`FileInfo`	`setFileId(long fileId)`
`FileInfo`	`setFileIdentifier(String fileIdentifier)`
`FileInfo`	`setFolder(boolean folder)`
`FileInfo`	`setGroup(String group)`
`FileInfo`	`setInAlluxioPercentage(int inAlluxioPercentage)`
`FileInfo`	`setInMemoryPercentage(int inMemoryPercentage)`
`FileInfo`	`setLastAccessTimeMs(long lastAccessTimeMs)`
`FileInfo`	`setLastModificationTimeMs(long lastModificationTimeMs)`
`FileInfo`	`setLength(long length)`
`FileInfo`	`setMediumTypes(Set<String> mediumTypes)`
`FileInfo`	`setMode(int mode)`
`FileInfo`	`setMountId(long mountId)`
`FileInfo`	`setMountPoint(boolean mountPoint)`
`FileInfo`	`setName(String name)`
`FileInfo`	`setOwner(String owner)`
`FileInfo`	`setPath(String path)`
`FileInfo`	`setPersisted(boolean persisted)`
`FileInfo`	`setPersistenceState(String persistenceState)`
`FileInfo`	`setPinned(boolean pinned)`
`FileInfo`	`setReplicationMax(int replicationMax)`
`FileInfo`	`setReplicationMin(int replicationMin)`
`FileInfo`	`setTtl(long ttl)`
`FileInfo`	`setTtlAction(TtlAction ttlAction)`
`FileInfo`	`setUfsFingerprint(String ufsFingerprint)`
`FileInfo`	`setUfsPath(String ufsPath)`
`FileInfo`	`setXAttr(Map<String,byte[]> xAttr)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - FileInfo
```
public FileInfo()
```
    Creates a new instance of FileInfo.
- Method Detail
  - getFileId
```
public long getFileId()
```
    Returns:
    
    the file id
  - getFileIdentifier
```
public String getFileIdentifier()
```
    Similar to getFileId(), but returns in a string form, allowing for the use of non-long based ids.
    
    Returns:
    
    the file identifier
  - getName
```
public String getName()
```
    Returns:
    
    the file name
  - getPath
```
public String getPath()
```
    Returns:
    
    the file path
  - getUfsPath
```
public String getUfsPath()
```
    Returns:
    
    the file UFS path
  - getLength
```
public long getLength()
```
    Returns:
    
    the file length
  - getBlockSizeBytes
```
public long getBlockSizeBytes()
```
    Returns:
    
    the file block size (in bytes)
  - getCreationTimeMs
```
public long getCreationTimeMs()
```
    Returns:
    
    the file creation time (in milliseconds)
  - isCompleted
```
public boolean isCompleted()
```
    Returns:
    
    whether the file is completed
  - isFolder
```
public boolean isFolder()
```
    Returns:
    
    whether the file is a folder
  - isPinned
```
public boolean isPinned()
```
    Returns:
    
    whether the file is pinned
  - isCacheable
```
public boolean isCacheable()
```
    Returns:
    
    whether the file is cacheable
  - isPersisted
```
public boolean isPersisted()
```
    Returns:
    
    whether the file is persisted
  - getBlockIds
```
public List<Long> getBlockIds()
```
    Returns:
    
    the file block ids
  - getInMemoryPercentage
```
public int getInMemoryPercentage()
```
    Returns:
    
    the file in memory percentage
  - getInAlluxioPercentage
```
public int getInAlluxioPercentage()
```
    Returns:
    
    the file in alluxio percentage
  - getLastModificationTimeMs
```
public long getLastModificationTimeMs()
```
    Returns:
    
    the file last modification time (in milliseconds)
  - getLastAccessTimeMs
```
public long getLastAccessTimeMs()
```
    Returns:
    
    the file last access time (in milliseconds)
  - getTtl
```
public long getTtl()
```
    Returns:
    
    the file time-to-live (in seconds)
  - getTtlAction
```
public TtlAction getTtlAction()
```
    Returns:
    
    the TtlAction
  - getOwner
```
public String getOwner()
```
    Returns:
    
    the file owner
  - getGroup
```
public String getGroup()
```
    Returns:
    
    the file owner group
  - getMode
```
public int getMode()
```
    Returns:
    
    the file mode bits
  - getPersistenceState
```
public String getPersistenceState()
```
    Returns:
    
    the file persistence state
  - isMountPoint
```
public boolean isMountPoint()
```
    Returns:
    
    whether the file is a mount point
  - getFileBlockInfos
```
public List<FileBlockInfo> getFileBlockInfos()
```
    Returns:
    
    the list of file block descriptors
  - getFileBlockInfo
```
public FileBlockInfo getFileBlockInfo(long blockId)
```
    Parameters:
    
    blockId - the block ID
    
    Returns:
    
    the corresponding block info or null
  - getReplicationMax
```
public int getReplicationMax()
```
    Returns:
    
    the maximum number of block replication
  - getReplicationMin
```
public int getReplicationMin()
```
    Returns:
    
    the minimum number of block replication
  - getMountId
```
public long getMountId()
```
    Returns:
    
    the id of the mount
  - getUfsFingerprint
```
public String getUfsFingerprint()
```
    Returns:
    
    the ufs fingerprint for this file
  - getAcl
```
public AccessControlList getAcl()
```
    Returns:
    
    the ACL object for this file
  - getDefaultAcl
```
public DefaultAccessControlList getDefaultAcl()
```
    Returns:
    
    the default ACL object for this file
  - convertAclToStringEntries
```
public List<String> convertAclToStringEntries()
```
    Returns:
    
    the ACL as string entries for this file
  - convertDefaultAclToStringEntries
```
public List<String> convertDefaultAclToStringEntries()
```
    Returns:
    
    the default ACL as string entries for this file
  - getMediumTypes
```
public Set<String> getMediumTypes()
```
    Returns:
    
    a set of pinned locations
  - getXAttr
```
@Nullable
public Map<String,byte[]> getXAttr()
```
    Returns:
    
    the extended attributes
  - setFileId
```
public FileInfo setFileId(long fileId)
```
    Parameters:
    
    fileId - the file id to use
    
    Returns:
    
    the file information
  - setFileIdentifier
```
public FileInfo setFileIdentifier(String fileIdentifier)
```
    Parameters:
    
    fileIdentifier - the file id to use
    
    Returns:
    
    the file information
  - setName
```
public FileInfo setName(String name)
```
    Parameters:
    
    name - the file name to use
    
    Returns:
    
    the file information
  - setPath
```
public FileInfo setPath(String path)
```
    Parameters:
    
    path - the file path to use
    
    Returns:
    
    the file information
  - setUfsPath
```
public FileInfo setUfsPath(String ufsPath)
```
    Parameters:
    
    ufsPath - the file UFS path to use
    
    Returns:
    
    the file information
  - setLength
```
public FileInfo setLength(long length)
```
    Parameters:
    
    length - the file length to use
    
    Returns:
    
    the file information
  - setBlockSizeBytes
```
public FileInfo setBlockSizeBytes(long blockSizeBytes)
```
    Parameters:
    
    blockSizeBytes - the file block size (in bytes) to use
    
    Returns:
    
    the file information
  - setCreationTimeMs
```
public FileInfo setCreationTimeMs(long creationTimeMs)
```
    Parameters:
    
    creationTimeMs - the file creation time (in milliseconds) to use
    
    Returns:
    
    the file information
  - setCompleted
```
public FileInfo setCompleted(boolean completed)
```
    Parameters:
    
    completed - the completed flag value to use
    
    Returns:
    
    the file information
  - setFolder
```
public FileInfo setFolder(boolean folder)
```
    Parameters:
    
    folder - the folder flag value to use
    
    Returns:
    
    the file information
  - setPinned
```
public FileInfo setPinned(boolean pinned)
```
    Parameters:
    
    pinned - the pinned flag value to use
    
    Returns:
    
    the file information
  - setCacheable
```
public FileInfo setCacheable(boolean cacheable)
```
    Parameters:
    
    cacheable - the cacheable flag value to use
    
    Returns:
    
    the file information
  - setPersisted
```
public FileInfo setPersisted(boolean persisted)
```
    Parameters:
    
    persisted - the persisted flag value to use
    
    Returns:
    
    the file information
  - setBlockIds
```
public FileInfo setBlockIds(List<Long> blockIds)
```
    Parameters:
    
    blockIds - the file block ids to use
    
    Returns:
    
    the file information
  - setInMemoryPercentage
```
public FileInfo setInMemoryPercentage(int inMemoryPercentage)
```
    Parameters:
    
    inMemoryPercentage - the file in memory percentage to use
    
    Returns:
    
    the file information
  - setInAlluxioPercentage
```
public FileInfo setInAlluxioPercentage(int inAlluxioPercentage)
```
    Parameters:
    
    inAlluxioPercentage - the file in alluxio percentage to use
    
    Returns:
    
    the file information
  - setLastModificationTimeMs
```
public FileInfo setLastModificationTimeMs(long lastModificationTimeMs)
```
    Parameters:
    
    lastModificationTimeMs - the last modification time (in milliseconds) to use
    
    Returns:
    
    the file information
  - setLastAccessTimeMs
```
public FileInfo setLastAccessTimeMs(long lastAccessTimeMs)
```
    Parameters:
    
    lastAccessTimeMs - the last access time (in milliseconds) to use
    
    Returns:
    
    the file information
  - setTtl
```
public FileInfo setTtl(long ttl)
```
    Parameters:
    
    ttl - the file time-to-live (in seconds) to use
    
    Returns:
    
    the file information
  - setTtlAction
```
public FileInfo setTtlAction(TtlAction ttlAction)
```
    Parameters:
    
    ttlAction - the TtlAction to use
    
    Returns:
    
    the updated options object
  - setOwner
```
public FileInfo setOwner(String owner)
```
    Parameters:
    
    owner - the file owner
    
    Returns:
    
    the file information
  - setGroup
```
public FileInfo setGroup(String group)
```
    Parameters:
    
    group - the file group
    
    Returns:
    
    the file information
  - setMode
```
public FileInfo setMode(int mode)
```
    Parameters:
    
    mode - the file mode bits
    
    Returns:
    
    the file information
  - setPersistenceState
```
public FileInfo setPersistenceState(String persistenceState)
```
    Parameters:
    
    persistenceState - the file persistence state to use
    
    Returns:
    
    the file information
  - setMountPoint
```
public FileInfo setMountPoint(boolean mountPoint)
```
    Parameters:
    
    mountPoint - the mount point flag value to use
    
    Returns:
    
    the file information
  - setFileBlockInfos
```
public FileInfo setFileBlockInfos(List<FileBlockInfo> fileBlockInfos)
```
    Parameters:
    
    fileBlockInfos - the file block descriptors to use
    
    Returns:
    
    the file information
  - setReplicationMax
```
public FileInfo setReplicationMax(int replicationMax)
```
    Parameters:
    
    replicationMax - the maximum number of block replication
    
    Returns:
    
    the file descriptor
  - setReplicationMin
```
public FileInfo setReplicationMin(int replicationMin)
```
    Parameters:
    
    replicationMin - the minimum number of block replication
    
    Returns:
    
    the file descriptor
  - setMountId
```
public FileInfo setMountId(long mountId)
```
    Parameters:
    
    mountId - the id of mount
    
    Returns:
    
    the file information
  - setUfsFingerprint
```
public FileInfo setUfsFingerprint(String ufsFingerprint)
```
    Parameters:
    
    ufsFingerprint - the ufs fingerprint to use
    
    Returns:
    
    the file information
  - setAcl
```
public FileInfo setAcl(AccessControlList acl)
```
    Parameters:
    
    acl - the ACL entries to use
    
    Returns:
    
    the file information
  - setDefaultAcl
```
public FileInfo setDefaultAcl(DefaultAccessControlList defaultAcl)
```
    Parameters:
    
    defaultAcl - the ACL entries to use
    
    Returns:
    
    the file information
  - setMediumTypes
```
public FileInfo setMediumTypes(Set<String> mediumTypes)
```
    Parameters:
    
    mediumTypes - the pinned locations
    
    Returns:
    
    the file information
  - setXAttr
```
public FileInfo setXAttr(Map<String,byte[]> xAttr)
```
    Parameters:
    
    xAttr - the extended attributes to use
    
    Returns:
    
    the updated FileInfo
  - 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

Class FileInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FileInfo

Method Detail

getFileId

getFileIdentifier

getName

getPath

getUfsPath

getLength

getBlockSizeBytes

getCreationTimeMs

isCompleted

isFolder

isPinned

isCacheable

isPersisted

getBlockIds

getInMemoryPercentage

getInAlluxioPercentage

getLastModificationTimeMs

getLastAccessTimeMs

getTtl

getTtlAction

getOwner

getGroup

getMode

getPersistenceState

isMountPoint

getFileBlockInfos

getFileBlockInfo

getReplicationMax

getReplicationMin

getMountId

getUfsFingerprint

getAcl

getDefaultAcl

convertAclToStringEntries

convertDefaultAclToStringEntries

getMediumTypes

getXAttr

setFileId

setFileIdentifier

setName

setPath

setUfsPath

setLength

setBlockSizeBytes

setCreationTimeMs

setCompleted

setFolder

setPinned

setCacheable

setPersisted

setBlockIds

setInMemoryPercentage

setInAlluxioPercentage

setLastModificationTimeMs

setLastAccessTimeMs

setTtl

setTtlAction

setOwner

setGroup

setMode

setPersistenceState

setMountPoint

setFileBlockInfos

setReplicationMax

setReplicationMin

setMountId

setUfsFingerprint

setAcl

setDefaultAcl

setMediumTypes

setXAttr

equals

hashCode