Package org.apache.hadoop.fs

Class CommonPathCapabilities

java.lang.Object
org.apache.hadoop.fs.CommonPathCapabilities
public final class CommonPathCapabilities extends Object
Common path capabilities.

  • Field Details

    • FS_ACLS

      public static final String FS_ACLS
      Does the store support FileSystem.setAcl(Path, List), FileSystem.getAclStatus(Path) and related methods? Value: "fs.capability.paths.acls".
      See Also:

    • FS_APPEND

      public static final String FS_APPEND
      Does the store support FileSystem.append(Path)? Value: "fs.capability.paths.append".
      See Also:

    • FS_CHECKSUMS

      public static final String FS_CHECKSUMS
      Does the store support FileSystem.getFileChecksum(Path)? Value: "fs.capability.paths.checksums".
      See Also:

    • FS_CONCAT

      public static final String FS_CONCAT
      Does the store support FileSystem.concat(Path, Path[])? Value: "fs.capability.paths.concat".
      See Also:

    • FS_LIST_CORRUPT_FILE_BLOCKS

      public static final String FS_LIST_CORRUPT_FILE_BLOCKS
      Does the store support FileSystem.listCorruptFileBlocks(Path) ()}? Value: "fs.capability.paths.list-corrupt-file-blocks".
      See Also:

    • FS_PATHHANDLES

      public static final String FS_PATHHANDLES
      Does the store support FileSystem.createPathHandle(FileStatus, Options.HandleOpt...) and related methods? Value: "fs.capability.paths.pathhandles".
      See Also:

    • FS_PERMISSIONS

      public static final String FS_PERMISSIONS
      Does the store support FileSystem.setPermission(Path, FsPermission) and related methods? Value: "fs.capability.paths.permissions".
      See Also:

    • FS_READ_ONLY_CONNECTOR

      public static final String FS_READ_ONLY_CONNECTOR
      Does this filesystem connector only support filesystem read operations? For example, the HttpFileSystem is always read-only. This is different from "is the specific instance and path read only?", which must be determined by checking permissions (where supported), or attempting write operations under a path. Value: "fs.capability.paths.read-only-connector".
      See Also:

    • FS_SNAPSHOTS

      public static final String FS_SNAPSHOTS
      Does the store support snapshots through FileSystem.createSnapshot(Path) and related methods?? Value: "fs.capability.paths.snapshots".
      See Also:

    • FS_STORAGEPOLICY

      public static final String FS_STORAGEPOLICY
      Does the store support FileSystem.setStoragePolicy(Path, String) and related methods? Value: "fs.capability.paths.storagepolicy".
      See Also:

    • FS_TRUNCATE

      public static final String FS_TRUNCATE
      Does the store support FileSystem#truncate(Path, long) ? Value: "fs.capability.paths.truncate".
      See Also:

    • FS_XATTRS

      public static final String FS_XATTRS
      Does the store support XAttributes through FileSystem#.setXAttr() and related methods? Value: "fs.capability.paths.xattrs".
      See Also:

    • FS_EXPERIMENTAL_BATCH_LISTING

      @Unstable public static final String FS_EXPERIMENTAL_BATCH_LISTING
      Probe for support for BatchListingOperations.
      See Also:

    • FS_MULTIPART_UPLOADER

      public static final String FS_MULTIPART_UPLOADER
      Does the store support multipart uploading? Value: "fs.capability.multipart.uploader".
      See Also:

    • ABORTABLE_STREAM

      public static final String ABORTABLE_STREAM
      Stream abort() capability implemented by Abortable.abort(). Value: "fs.capability.outputstream.abortable".
      See Also:

    • ETAGS_AVAILABLE

      public static final String ETAGS_AVAILABLE
      Does this FS support etags? That is: will FileStatus entries from listing/getFileStatus probes support EtagSource and return real values.
      See Also:

    • ETAGS_PRESERVED_IN_RENAME

      public static final String ETAGS_PRESERVED_IN_RENAME
      Are etags guaranteed to be preserved across rename() operations.. FileSystems MUST NOT declare support for this feature unless this holds.
      See Also:

    • LEASE_RECOVERABLE

      public static final String LEASE_RECOVERABLE
      Does this Filesystem support lease recovery operations such as LeaseRecoverable.recoverLease(Path) and LeaseRecoverable.isFileClosed(Path)}? Value: "fs.capability.lease.recoverable".
      See Also:

    • DIRECTORY_LISTING_INCONSISTENT

      public static final String DIRECTORY_LISTING_INCONSISTENT
      Is this a store where parent directory listings are potentially inconsistent with direct list/getFileStatus calls? This can happen with Amazon S3 Express One Zone Storage when there are pending uploads under a path. Application code can use this flag to decide whether or not to treat FileNotFoundExceptions on treewalk as errors or something to downgrade. Value: "fs.capability.directory.listing.inconsistent".
      See Also:

    • BULK_DELETE

      public static final String BULK_DELETE
      Capability string to probe for bulk delete: "fs.capability.bulk.delete".
      See Also:

    • VIRTUAL_BLOCK_LOCATIONS

      public static final String VIRTUAL_BLOCK_LOCATIONS
      Capability string to probe for block locations returned in LocatedFileStatus instances from calls such as getBlockLocations() and listStatus()l to be 'virtual' rather than actual values resolved against a Distributed Filesystem including HDFS: "fs.capability.virtual.block.locations".

      Key implications from this path capability being true:

      1. Work can be scheduled anywhere
      2. Creation of the location list is a low cost-client side operation
      Implication #2 means there is no performance penalty from use of FileSystem operations which return lists or iterators of LocatedFileStatus.
      See Also: