org.apache.hadoop.hdfs.protocol (Apache Hadoop Main 3.5.0 API)
Description: declaration: package: org.apache.hadoop.hdfs.protocol

# Package org.apache.hadoop.hdfs.protocol

package org.apache.hadoop.hdfs.protocol
Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

- Related Packages
  Package
  Description
  org.apache.hadoop.hdfs
  A distributed implementation of `FileSystem`.
  org.apache.hadoop.hdfs.protocol.datatransfer
  This package contains classes related to hdfs data transfer protocol.
  org.apache.hadoop.hdfs.protocol.proto
- Class
  Description
  org.apache.hadoop.hdfs.protocol.AclException
  Indicates a failure manipulating an ACL.
  org.apache.hadoop.hdfs.protocol.AddErasureCodingPolicyResponse
  A response of add an ErasureCoding policy.
  org.apache.hadoop.hdfs.protocol.AlreadyBeingCreatedException
  The exception that happens when you ask to create a file that already is being created, but is not closed yet.
  org.apache.hadoop.hdfs.protocol.BatchedDirectoryListing
  A struct-like class for holding partial listings returned by the batched listing API.
  org.apache.hadoop.hdfs.protocol.Block
  A Block is a Hadoop FS primitive, identified by its block ID (a long).
  org.apache.hadoop.hdfs.protocol.BlockChecksumOptions
  Encapsulates various options related to how fine-grained data checksums are combined into block-level checksums.
  org.apache.hadoop.hdfs.protocol.BlockChecksumType
  Algorithms/types denoting how block-level checksums are computed using lower-level chunk checksums/CRCs.
  org.apache.hadoop.hdfs.protocol.BlockListAsLongs
  org.apache.hadoop.hdfs.protocol.BlockListAsLongs.BlockReportReplica
  org.apache.hadoop.hdfs.protocol.BlockListAsLongs.Builder
  org.apache.hadoop.hdfs.protocol.BlockLocalPathInfo
  A block and the full path information to the block data file and the metadata file stored on the local file system.
  org.apache.hadoop.hdfs.protocol.BlockStoragePolicy
  A block storage policy describes how to select the storage types for the replicas of a block.
  BlockType
  Type of a block.
  org.apache.hadoop.hdfs.protocol.CacheDirective
  Namenode class that tracks state related to a cached path.
  CacheDirectiveEntry
  Describes a path-based cache directive entry.
  CacheDirectiveInfo
  Describes a path-based cache directive.
  org.apache.hadoop.hdfs.protocol.CacheDirectiveInfo.Builder
  A builder for creating new CacheDirectiveInfo instances.
  org.apache.hadoop.hdfs.protocol.CacheDirectiveInfo.Expiration
  Denotes a relative or absolute expiration time for a CacheDirective.
  org.apache.hadoop.hdfs.protocol.CacheDirectiveIterator
  CacheDirectiveIterator is a remote iterator that iterates cache directives.
  CacheDirectiveStats
  Describes a path-based cache directive.
  org.apache.hadoop.hdfs.protocol.CacheDirectiveStats.Builder
  CachePoolEntry
  Describes a Cache Pool entry.
  CachePoolInfo
  CachePoolInfo describes a cache pool.
  org.apache.hadoop.hdfs.protocol.CachePoolIterator
  CachePoolIterator is a remote iterator that iterates cache pools.
  CachePoolStats
  CachePoolStats describes cache pool statistics.
  org.apache.hadoop.hdfs.protocol.CachePoolStats.Builder
  org.apache.hadoop.hdfs.protocol.ClientDatanodeProtocol
  An client-datanode protocol for block recovery
  org.apache.hadoop.hdfs.protocol.ClientProtocol
  ClientProtocol is used by user code via the DistributedFileSystem class to communicate with the NameNode.
  org.apache.hadoop.hdfs.protocol.CorruptFileBlocks
  Contains a list of paths corresponding to corrupt files and a cookie used for iterative calls to NameNode.listCorruptFileBlocks.
  org.apache.hadoop.hdfs.protocol.DatanodeAdminProperties
  The class describes the configured admin properties for a datanode.
  org.apache.hadoop.hdfs.protocol.DatanodeID
  This class represents the primary identifier for a Datanode.
  org.apache.hadoop.hdfs.protocol.DatanodeInfo
  This class extends the primary identifier of a Datanode with ephemeral state, eg usage information, current administrative state, and the network location that is communicated to clients.
  DatanodeInfo.AdminStates
  org.apache.hadoop.hdfs.protocol.DatanodeInfo.DatanodeInfoBuilder
  Building the DataNodeInfo.
  org.apache.hadoop.hdfs.protocol.DatanodeInfoWithStorage
  org.apache.hadoop.hdfs.protocol.DatanodeLocalInfo
  Locally available datanode information
  org.apache.hadoop.hdfs.protocol.DatanodeVolumeInfo
  Locally available datanode volume information.
  org.apache.hadoop.hdfs.protocol.DirectoryListing
  This class defines a partial listing of a directory to support iterative directory listing.
  DSQuotaExceededException
  ECBlockGroupStats
  Get statistics pertaining to blocks of type `BlockType.STRIPED` in the filesystem.
  org.apache.hadoop.hdfs.protocol.ECTopologyVerifierResult
  Result of the verification whether the current cluster setup can support all enabled EC policies.
  EncryptionZone
  A simple class for representing an encryption zone.
  org.apache.hadoop.hdfs.protocol.EncryptionZoneIterator
  EncryptionZoneIterator is a remote iterator that iterates over encryption zones.
  org.apache.hadoop.hdfs.protocol.ErasureCodingPolicy
  A policy about how to write/read/code an erasure coding file.
  org.apache.hadoop.hdfs.protocol.ErasureCodingPolicyInfo
  HDFS internal presentation of a `ErasureCodingPolicy`.
  org.apache.hadoop.hdfs.protocol.ErasureCodingPolicyState
  Value denotes the possible states of an ErasureCodingPolicy.
  org.apache.hadoop.hdfs.protocol.ExtendedBlock
  Identifies a Block uniquely across the block pools
  FSLimitException
  org.apache.hadoop.hdfs.protocol.FSLimitException.MaxDirectoryItemsExceededException
  Directory has too many items
  org.apache.hadoop.hdfs.protocol.FSLimitException.PathComponentTooLongException
  Path component length is too long
  org.apache.hadoop.hdfs.protocol.FsPermissionExtension
  Deprecated.
  ACLs, encryption, and erasure coding are managed on FileStatus.
  org.apache.hadoop.hdfs.protocol.HdfsConstants
  HdfsConstants.DatanodeReportType
  HdfsConstants.ReencryptAction
  Re-encrypt encryption zone actions.
  HdfsConstants.RollingUpgradeAction
  HdfsConstants.SafeModeAction
  HdfsConstants.StoragePolicy
  This enum wraps above Storage Policy ID and name.
  HdfsConstants.StoragePolicySatisfierMode
  Storage policy satisfier service modes.
  HdfsConstants.UpgradeAction
  Upgrade actions.
  org.apache.hadoop.hdfs.protocol.HdfsFileStatus
  HDFS metadata for an entity in the filesystem.
  org.apache.hadoop.hdfs.protocol.HdfsFileStatus.Builder
  Builder class for HdfsFileStatus instances.
  HdfsFileStatus.Flags
  Set of features potentially active on an instance.
  org.apache.hadoop.hdfs.protocol.HdfsLocatedFileStatus
  HDFS metadata for an entity in the filesystem with locations.
  org.apache.hadoop.hdfs.protocol.HdfsNamedFileStatus
  HDFS metadata for an entity in the filesystem without locations.
  org.apache.hadoop.hdfs.protocol.HdfsPartialListing
  A partial listing returned by the batched listing API.
  org.apache.hadoop.hdfs.protocol.HdfsPathHandle
  Opaque handle to an entity in HDFS.
  org.apache.hadoop.hdfs.protocol.LastBlockWithStatus
  Class to contain Lastblock and HdfsFileStatus for the Append operation
  org.apache.hadoop.hdfs.protocol.LayoutFlags
  LayoutFlags represent features which the FSImage and edit logs can either support or not, independently of layout version.
  org.apache.hadoop.hdfs.protocol.LayoutVersion
  This class tracks changes in the layout version of HDFS.
  LayoutVersion.Feature
  Enums for features that change the layout version before rolling upgrade is supported.
  org.apache.hadoop.hdfs.protocol.LayoutVersion.FeatureInfo
  Feature information.
  org.apache.hadoop.hdfs.protocol.LayoutVersion.LayoutFeature
  The interface to be implemented by NameNode and DataNode layout features
  org.apache.hadoop.hdfs.protocol.LocatedBlock
  Associates a block with the Datanodes that contain its replicas and other block metadata (E.g. the file offset associated with this block, whether it is corrupt, a location is cached in memory, security token, etc).
  org.apache.hadoop.hdfs.protocol.LocatedBlocks
  Collection of blocks with their locations and the file length.
  org.apache.hadoop.hdfs.protocol.LocatedStripedBlock
  `LocatedBlock` with striped block support.
  org.apache.hadoop.hdfs.protocol.NoECPolicySetException
  Thrown when no EC policy is set explicitly on the directory.
  NSQuotaExceededException
  org.apache.hadoop.hdfs.protocol.OpenFileEntry
  An open file entry for use by DFSAdmin commands.
  org.apache.hadoop.hdfs.protocol.OpenFilesIterator
  OpenFilesIterator is a remote iterator that iterates over the open files list managed by the NameNode.
  OpenFilesIterator.OpenFilesType
  Open file types to filter the results.
  org.apache.hadoop.hdfs.protocol.ProvidedStorageLocation
  ProvidedStorageLocation is a location in an external storage system containing the data for a block (~Replica).
  QuotaByStorageTypeExceededException
  QuotaExceededException
  This exception is thrown when modification to HDFS results in violation of a directory quota.
  org.apache.hadoop.hdfs.protocol.ReconfigurationProtocol
  ReconfigurationProtocol is used by HDFS admin to reload configuration for NN/DN without restarting them.
  org.apache.hadoop.hdfs.protocol.RecoveryInProgressException
  Exception indicating that a replica is already being recovery.
  org.apache.hadoop.hdfs.protocol.ReencryptionStatus
  A class representing information about re-encrypting encryption zones.
  org.apache.hadoop.hdfs.protocol.ReencryptionStatusIterator
  ReencryptionStatusIterator is a remote iterator that iterates over the reencryption status of encryption zones.
  ReplicatedBlockStats
  Get statistics pertaining to blocks of type `BlockType.CONTIGUOUS` in the filesystem.
  org.apache.hadoop.hdfs.protocol.RollingUpgradeException
  Exception related to rolling upgrade.
  org.apache.hadoop.hdfs.protocol.RollingUpgradeInfo
  Rolling upgrade information
  org.apache.hadoop.hdfs.protocol.RollingUpgradeInfo.Bean
  org.apache.hadoop.hdfs.protocol.RollingUpgradeStatus
  Rolling upgrade status
  org.apache.hadoop.hdfs.protocol.SnapshotAccessControlException
  Snapshot access related exception.
  org.apache.hadoop.hdfs.protocol.SnapshotDiffReport
  This class represents to end users the difference between two snapshots of the same directory, or the difference between a snapshot of the directory and its current state.
  org.apache.hadoop.hdfs.protocol.SnapshotDiffReport.DiffReportEntry
  Representing the full path and diff type of a file/directory where changes have happened.
  org.apache.hadoop.hdfs.protocol.SnapshotDiffReport.DiffStats
  Records the stats related to Snapshot diff operation.
  SnapshotDiffReport.DiffType
  Types of the difference, which include CREATE, MODIFY, DELETE, and RENAME.
  org.apache.hadoop.hdfs.protocol.SnapshotDiffReportListing
  This class represents to the difference between two snapshots of the same directory, or the difference between a snapshot of the directory and its current state.
  org.apache.hadoop.hdfs.protocol.SnapshotDiffReportListing.DiffReportListingEntry
  Representing the full path and diff type of a file/directory where changes have happened.
  org.apache.hadoop.hdfs.protocol.SnapshotException
  Snapshot related exception.
  org.apache.hadoop.hdfs.protocol.SnapshotInfo
  SnapshotInfo maintains information for a snapshot
  org.apache.hadoop.hdfs.protocol.SnapshotInfo.Bean
  org.apache.hadoop.hdfs.protocol.SnapshotStatus
  Metadata about a snapshottable directory.
  org.apache.hadoop.hdfs.protocol.SnapshottableDirectoryStatus
  Metadata about a snapshottable directory
  org.apache.hadoop.hdfs.protocol.SnapshottableDirectoryStatus.Bean
  org.apache.hadoop.hdfs.protocol.StripedBlockInfo
  Striped block info that can be sent elsewhere to do block group level things, like checksum, and etc.
  org.apache.hadoop.hdfs.protocol.SystemErasureCodingPolicies
  The set of built-in erasure coding policies.
  org.apache.hadoop.hdfs.protocol.UnregisteredNodeException
  This exception is thrown when a node that has not previously registered is trying to access the name node.
  org.apache.hadoop.hdfs.protocol.UnresolvedPathException
  Thrown when a symbolic link is encountered in a path.
  org.apache.hadoop.hdfs.protocol.XAttrNotFoundException
  The exception that happens when you ask to get a non existing XAttr.
  org.apache.hadoop.hdfs.protocol.ZoneReencryptionStatus
  A class representing information about re-encryption of an encryption zone.
  org.apache.hadoop.hdfs.protocol.ZoneReencryptionStatus.Builder
  Builder of `ZoneReencryptionStatus`.
  ZoneReencryptionStatus.State
  State of re-encryption.