Uses of Annotation Interface org.apache.hadoop.hdfs.server.namenode.ha.ReadOnly (Apache Hadoop HDFS Client 3.5.0 API)
Description: use: package: org.apache.hadoop.hdfs.server.namenode.ha, annotation type: ReadOnly

# Uses of Annotation Interface
org.apache.hadoop.hdfs.server.namenode.ha.ReadOnly

Packages that use ReadOnly
Package
Description
org.apache.hadoop.hdfs.protocol
Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.

- ## Uses of ReadOnly in org.apache.hadoop.hdfs.protocol

  Methods in org.apache.hadoop.hdfs.protocol with annotations of type ReadOnly
  Modifier and Type
  Method
  Description
  `void`
  ClientProtocol.`checkAccess(String path, org.apache.hadoop.fs.permission.FsAction mode)`
  Checks if the user can access a path.
  `org.apache.hadoop.fs.permission.AclStatus`
  ClientProtocol.`getAclStatus(String src)`
  Gets the ACLs of files and directories.
  `BatchedDirectoryListing`
  ClientProtocol.`getBatchedListing(String[] srcs, byte[] startAfter, boolean needLocation)`
  Get a partial listing of the input directories
  `LocatedBlocks`
  ClientProtocol.`getBlockLocations(String src, long offset, long length)`
  Get locations of the blocks of the specified file within the specified range.
  `org.apache.hadoop.fs.ContentSummary`
  ClientProtocol.`getContentSummary(String path)`
  Get `ContentSummary` rooted at the specified directory.
  `long`
  ClientProtocol.`getCurrentEditLogTxid()`
  Get the highest txid the NameNode knows has been written to the edit log, or -1 if the NameNode's edit log is not yet open for write.
  `DataEncryptionKey`
  ClientProtocol.`getDataEncryptionKey()`
  `DatanodeInfo[]`
  ClientProtocol.`getDatanodeReport(HdfsConstants.DatanodeReportType type)`
  Get a report on the system's current datanodes.
  `DatanodeStorageReport[]`
  ClientProtocol.`getDatanodeStorageReport(HdfsConstants.DatanodeReportType type)`
  Get a report on the current datanode storages.
  `ECBlockGroupStats`
  ClientProtocol.`getECBlockGroupStats()`
  Get statistics pertaining to blocks of type `BlockType.STRIPED` in the filesystem.
  `ECTopologyVerifierResult`
  ClientProtocol.`getECTopologyResultForPolicies(String... policyNames)`
  Verifies if the given policies are supported in the given cluster setup.
  `EventBatchList`
  ClientProtocol.`getEditsFromTxid(long txid)`
  Get an ordered list of batches of events corresponding to the edit log transactions for txids equal to or greater than txid.
  `org.apache.hadoop.fs.Path`
  ClientProtocol.`getEnclosingRoot(String src)`
  Get the enclosing root for a path.
  `Map<String,String>`
  ClientProtocol.`getErasureCodingCodecs()`
  Get the erasure coding codecs loaded in Namenode.
  `ErasureCodingPolicyInfo[]`
  ClientProtocol.`getErasureCodingPolicies()`
  Get the erasure coding policies loaded in Namenode, excluding REPLICATION policy.
  `ErasureCodingPolicy`
  ClientProtocol.`getErasureCodingPolicy(String src)`
  Get the information about the EC policy for the path.
  `EncryptionZone`
  ClientProtocol.`getEZForPath(String src)`
  Get the encryption zone for a path.
  `HdfsFileStatus`
  ClientProtocol.`getFileInfo(String src)`
  Get the file info for a specific file or directory.
  `HdfsFileStatus`
  ClientProtocol.`getFileLinkInfo(String src)`
  Get the file info for a specific file or directory.
  `org.apache.hadoop.ha.HAServiceProtocol.HAServiceState`
  ClientProtocol.`getHAServiceState()`
  Get HA service state of the server.
  `String`
  ClientProtocol.`getLinkTarget(String path)`
  Return the target of the given symlink.
  `DirectoryListing`
  ClientProtocol.`getListing(String src, byte[] startAfter, boolean needLocation)`
  Get a partial listing of the indicated directory.
  `HdfsLocatedFileStatus`
  ClientProtocol.`getLocatedFileInfo(String src, boolean needBlockToken)`
  Get the file info for a specific file or directory with `LocatedBlocks`.
  `long`
  ClientProtocol.`getPreferredBlockSize(String filename)`
  Get the block size for the given file.
  `org.apache.hadoop.fs.QuotaUsage`
  ClientProtocol.`getQuotaUsage(String path)`
  Get `QuotaUsage` rooted at the specified directory.
  `ReplicatedBlockStats`
  ClientProtocol.`getReplicatedBlockStats()`
  Get statistics pertaining to blocks of type `BlockType.CONTIGUOUS` in the filesystem.
  `org.apache.hadoop.fs.FsServerDefaults`
  ClientProtocol.`getServerDefaults()`
  Get server default values for a number of configuration params.
  `DatanodeInfo[]`
  ClientProtocol.`getSlowDatanodeReport()`
  Get report on all of the slow Datanodes.
  `SnapshotDiffReport`
  ClientProtocol.`getSnapshotDiffReport(String snapshotRoot, String fromSnapshot, String toSnapshot)`
  Get the difference between two snapshots, or between a snapshot and the current tree of a directory.
  `SnapshotDiffReportListing`
  ClientProtocol.`getSnapshotDiffReportListing(String snapshotRoot, String fromSnapshot, String toSnapshot, byte[] startPath, int index)`
  Get the difference between two snapshots of a directory iteratively.
  `SnapshotStatus[]`
  ClientProtocol.`getSnapshotListing(String snapshotRoot)`
  Get listing of all the snapshots for a snapshottable directory.
  `SnapshottableDirectoryStatus[]`
  ClientProtocol.`getSnapshottableDirListing()`
  Get the list of snapshottable directories that are owned by the current user.
  `long[]`
  ClientProtocol.`getStats()`
  Get an array of aggregated statistics combining blocks of both type `BlockType.CONTIGUOUS` and `BlockType.STRIPED` in the filesystem.
  `BlockStoragePolicy[]`
  ClientProtocol.`getStoragePolicies()`
  Get all the available block storage policies.
  `BlockStoragePolicy`
  ClientProtocol.`getStoragePolicy(String path)`
  Get the storage policy for a file/directory.
  `List<XAttr>`
  ClientProtocol.`getXAttrs(String src, List<XAttr> xAttrs)`
  Get xattrs of a file or directory.
  `boolean`
  ClientProtocol.`isFileClosed(String src)`
  Get the close status of a file.
  `org.apache.hadoop.fs.BatchedRemoteIterator.BatchedEntries<CacheDirectiveEntry>`
  ClientProtocol.`listCacheDirectives(long prevId, CacheDirectiveInfo filter)`
  List the set of cached paths of a cache pool.
  `org.apache.hadoop.fs.BatchedRemoteIterator.BatchedEntries<CachePoolEntry>`
  ClientProtocol.`listCachePools(String prevPool)`
  List the set of cache pools.
  `CorruptFileBlocks`
  ClientProtocol.`listCorruptFileBlocks(String path, String cookie)`
  `org.apache.hadoop.fs.BatchedRemoteIterator.BatchedEntries<EncryptionZone>`
  ClientProtocol.`listEncryptionZones(long prevId)`
  Used to implement cursor-based batched listing of `EncryptionZone`s.
  `org.apache.hadoop.fs.BatchedRemoteIterator.BatchedEntries<OpenFileEntry>`
  ClientProtocol.`listOpenFiles(long prevId)`
  Deprecated.
  `org.apache.hadoop.fs.BatchedRemoteIterator.BatchedEntries<OpenFileEntry>`
  ClientProtocol.`listOpenFiles(long prevId, EnumSet<OpenFilesIterator.OpenFilesType> openFilesTypes, String path)`
  List open files in the system in batches.
  `org.apache.hadoop.fs.BatchedRemoteIterator.BatchedEntries<ZoneReencryptionStatus>`
  ClientProtocol.`listReencryptionStatus(long prevId)`
  Used to implement cursor-based batched listing of `ZoneReencryptionStatus`s.
  `List<XAttr>`
  ClientProtocol.`listXAttrs(String src)`
  List the xattrs names for a file or directory.
  `void`
  ClientProtocol.`msync()`
  Called by client to wait until the server has reached the state id of the client.