package hadoop.hdfs

* Algorithms/types denoting how block-level checksums are computed using lower-level chunk checksums/CRCs. These options should be kept in sync with org.apache.hadoop.hdfs.protocol.BlockChecksumOptions.

Used in: OpBlockChecksumProto, OpBlockChecksumResponseProto, OpBlockGroupChecksumProto

optional BlockChecksumTypeProto blockChecksumType = 1
optional uint64 stripeLength = 2
Only used if blockChecksumType specifies a striped format, such as COMPOSITE_CRC. If so, then the blockChecksum in the response is expected to be the concatenation of N crcs, where N == ((requestedLength - 1) / stripedLength) + 1

Used in: BlockChecksumOptionsProto

MD5CRC = 1
BlockChecksum obtained by taking the MD5 digest of chunk CRCs
COMPOSITE_CRC = 2
Chunk-independent CRC, optionally striped

* Block erasure coding reconstruction info

required ExtendedBlockProto block = 1
required DatanodeInfosProto sourceDnInfos = 2
required DatanodeInfosProto targetDnInfos = 3
required StorageUuidsProto targetStorageUuids = 4
required StorageTypesProto targetStorageTypes = 5
required bytes liveBlockIndices = 6
required ErasureCodingPolicyProto ecPolicy = 7

required Status status = 1
optional string firstBadLink = 2
optional OpBlockChecksumResponseProto checksumResponse = 3
optional ReadOpChecksumInfoProto readOpChecksumInfo = 4
optional string message = 5
* explanatory text which may be useful to log on the client side
optional uint32 shortCircuitAccessVersion = 6
* If the server chooses to agree to the request of a client for short-circuit access, it will send a response message with the relevant file descriptors attached. In the body of the message, this version number will be set to the specific version number of the block data that the client is about to read.

* Block information Please be wary of adding additional fields here, since INodeFiles need to fit in PB's default max message size of 64MB. We restrict the max # of blocks per file (dfs.namenode.fs-limits.max-blocks-per-file), but it's better to avoid changing this.

required uint64 blockId = 1
required uint64 genStamp = 2
optional uint64 numBytes = 3

* Block replica storage policy.

Used in: GetStoragePoliciesResponseProto, GetStoragePolicyResponseProto

required uint32 policyId = 1
required string name = 2
required StorageTypesProto creationPolicy = 3
a list of storage types for storing the block replicas when creating a block.
optional StorageTypesProto creationFallbackPolicy = 4
A list of storage types for creation fallback storage.
optional StorageTypesProto replicationFallbackPolicy = 5

* Secret information for the BlockKeyProto. This is not sent on the wire as such but is used to pack a byte array and encrypted and put in BlockKeyProto.bytes When adding further fields, make sure they are optional as they would otherwise not be backwards compatible. Note: As part of the migration from WritableUtils based tokens (aka "legacy") to Protocol Buffers, we use the first byte to determine the type. If the first byte is <=0 then it is a legacy token. This means that when using protobuf tokens, the the first field sent must have a `field_number` less than 16 to make sure that the first byte is positive. Otherwise it could be parsed as a legacy token. See HDFS-11026 for more discussion.

optional uint64 expiryDate = 1
optional uint32 keyId = 2
optional string userId = 3
optional string blockPoolId = 4
optional uint64 blockId = 5
repeated AccessModeProto modes = 6
repeated StorageTypeProto storageTypes = 7
repeated string storageIds = 8

* Types of recognized blocks.

CONTIGUOUS = 0
STRIPED = 1

message CacheDirectiveEntryProto

ClientNamenodeProtocol.proto:579

Used in: ListCacheDirectivesResponseProto

required CacheDirectiveInfoProto info = 1
required CacheDirectiveStatsProto stats = 2

Used in: CacheDirectiveInfoProto

required int64 millis = 1
required bool isRelative = 2

Used in: AddCacheDirectiveRequestProto, CacheDirectiveEntryProto, ListCacheDirectivesRequestProto, ModifyCacheDirectiveRequestProto

optional int64 id = 1
optional string path = 2
optional uint32 replication = 3
optional string pool = 4
optional CacheDirectiveInfoExpirationProto expiration = 5

Used in: CacheDirectiveEntryProto

required int64 bytesNeeded = 1
required int64 bytesCached = 2
required int64 filesNeeded = 3
required int64 filesCached = 4
required bool hasExpired = 5

FORCE = 1
Ignore pool resource limits

message CachePoolEntryProto

ClientNamenodeProtocol.proto:637

Used in: ListCachePoolsResponseProto

required CachePoolInfoProto info = 1
required CachePoolStatsProto stats = 2

Used in: AddCachePoolRequestProto, CachePoolEntryProto, ModifyCachePoolRequestProto

optional string poolName = 1
optional string ownerName = 2
optional string groupName = 3
optional int32 mode = 4
optional int64 limit = 5
optional int64 maxRelativeExpiry = 6
optional uint32 defaultReplication = 7

Used in: CachePoolEntryProto

required int64 bytesNeeded = 1
required int64 bytesCached = 2
required int64 bytesOverlimit = 3
required int64 filesNeeded = 4
required int64 filesCached = 5

Used in: OpReadBlockProto, OpWriteBlockProto

optional bool dropBehind = 1
optional int64 readahead = 2

Used in: OpWriteBlockProto, ReadOpChecksumInfoProto

required ChecksumTypeProto type = 1
required uint32 bytesPerChecksum = 2

* Checksum algorithms/types used in HDFS Make sure this enum's integer values match enum values' id properties defined in org.apache.hadoop.util.DataChecksum.Type

Used in: ChecksumProto, FsServerDefaultsProto, OpBlockChecksumResponseProto

CHECKSUM_NULL = 0
CHECKSUM_CRC32 = 1
CHECKSUM_CRC32C = 2

* Cipher option

Used in: DataTransferEncryptorMessageProto

required CipherSuiteProto suite = 1
optional bytes inKey = 2
optional bytes inIv = 3
optional bytes outKey = 4
optional bytes outIv = 5

* Cipher suite.

Used in: CipherOptionProto, EncryptionZoneProto, FileEncryptionInfoProto, ZoneEncryptionInfoProto

UNKNOWN = 1
AES_CTR_NOPADDING = 2

Used in: OpReadBlockProto, OpTransferBlockProto, OpWriteBlockProto

required BaseHeaderProto baseHeader = 1
required string clientName = 2

* Message sent from the client to the DN after reading the entire read request.

required Status status = 1

required string path = 1
required int64 fileSize = 2
required int64 timestamp = 3

* Codec and it's corresponding coders

Used in: GetErasureCodingCodecsResponseProto

required string codec = 1
required string coders = 2

message ContentSummaryProto

hdfs.proto:166

* Summary of a file or directory

Used in: GetContentSummaryResponseProto

required uint64 length = 1
required uint64 fileCount = 2
required uint64 directoryCount = 3
required uint64 quota = 4
required uint64 spaceConsumed = 5
required uint64 spaceQuota = 6
optional StorageTypeQuotaInfosProto typeQuotaInfos = 7
optional uint64 snapshotLength = 8
optional uint64 snapshotFileCount = 9
optional uint64 snapshotDirectoryCount = 10
optional uint64 snapshotSpaceConsumed = 11
optional string erasureCodingPolicy = 12

* Contains a list of paths corresponding to corrupt files and a cookie used for iterative calls to NameNode.listCorruptFileBlocks.

Used in: ListCorruptFileBlocksResponseProto

repeated string files = 1
required string cookie = 2

required INodeType type = 1
required string path = 2
required int64 ctime = 3
required string ownerName = 4
required string groupName = 5
required FsPermissionProto perms = 6
optional int32 replication = 7
optional string symlinkTarget = 8
optional bool overwrite = 9
optional int64 defaultBlockSize = 10
optional bool erasureCoded = 11

CREATE = 1
Create a file
OVERWRITE = 2
Truncate/overwrite a file. Same as POSIX O_TRUNC
APPEND = 4
Append to a file
LAZY_PERSIST = 16
File with reduced durability guarantees.
NEW_BLOCK = 32
Write data to a new block when appending
SHOULD_REPLICATE = 128
Enforce to create a replicate file

* Crypto protocol version used to access encrypted files.

Used in: CreateRequestProto, EncryptionZoneProto, FileEncryptionInfoProto, ZoneEncryptionInfoProto

UNKNOWN_PROTOCOL_VERSION = 1
ENCRYPTION_ZONES = 2

required Status status = 1

Used in: GetDataEncryptionKeyResponseProto

required uint32 keyId = 1
required string blockPoolId = 2
required bytes nonce = 3
required bytes encryptionKey = 4
required uint64 expiryDate = 5
optional string encryptionAlgorithm = 6

message DataTransferEncryptorMessageProto

datatransfer.proto:36

required DataTransferEncryptorMessageProto.DataTransferEncryptorStatus status = 1
optional bytes payload = 2
optional string message = 3
repeated CipherOptionProto cipherOption = 4

enum DataTransferEncryptorMessageProto.DataTransferEncryptorStatus

datatransfer.proto:37

Used in: DataTransferEncryptorMessageProto

SUCCESS = 0
ERROR_UNKNOWN_KEY = 1
ERROR = 2

Used in: BaseHeaderProto, ReleaseShortCircuitAccessRequestProto, ShortCircuitShmRequestProto

required uint64 traceId = 1
required uint64 parentId = 2

* Identifies a Datanode

Used in: DatanodeInfoProto, UpdatePipelineRequestProto

required string ipAddr = 1
IP address
required string hostName = 2
hostname
required string datanodeUuid = 3
UUID assigned to the Datanode. For
required uint32 xferPort = 4
upgraded clusters this is the same as the original StorageID of the Datanode.
data streaming port
required uint32 infoPort = 5
datanode http port
required uint32 ipcPort = 6
ipc server port
optional uint32 infoSecurePort = 7
datanode https port

* The status of a Datanode

Used in: AddBlockRequestProto, DatanodeInfosProto, DatanodeStorageReportProto, GetAdditionalDatanodeRequestProto, GetDatanodeReportResponseProto, LocatedBlockProto, OpReplaceBlockProto, OpTransferBlockProto, OpWriteBlockProto

required DatanodeIDProto id = 1
optional uint64 capacity = 2
optional uint64 dfsUsed = 3
optional uint64 remaining = 4
optional uint64 blockPoolUsed = 5
optional uint64 lastUpdate = 6
optional uint32 xceiverCount = 7
optional string location = 8
optional uint64 nonDfsUsed = 9
optional DatanodeInfoProto.AdminState adminState = 10
optional uint64 cacheCapacity = 11
optional uint64 cacheUsed = 12
optional uint64 lastUpdateMonotonic = 13
optional string upgradeDomain = 14
optional uint64 lastBlockReportTime = 15
optional uint64 lastBlockReportMonotonic = 16
optional uint32 numBlocks = 17

Used in: DatanodeInfoProto

NORMAL = 0
DECOMMISSION_INPROGRESS = 1
DECOMMISSIONED = 2
ENTERING_MAINTENANCE = 3
IN_MAINTENANCE = 4

* DatanodeInfo array

Used in: BlockECReconstructionInfoProto, OpBlockGroupChecksumProto

repeated DatanodeInfoProto datanodes = 1

* Datanode local information

required string softwareVersion = 1
required string configVersion = 2
required uint64 uptime = 3

type of the datanode report

Used in: GetDatanodeReportRequestProto, GetDatanodeStorageReportRequestProto

ALL = 1
LIVE = 2
DEAD = 3
DECOMMISSIONING = 4
ENTERING_MAINTENANCE = 5
IN_MAINTENANCE = 6

* Represents a storage available on the datanode

Used in: StorageReportProto

required string storageUuid = 1
optional DatanodeStorageProto.StorageState state = 2
optional StorageTypeProto storageType = 3

Used in: DatanodeStorageProto

NORMAL = 0
READ_ONLY_SHARED = 1

Used in: GetDatanodeStorageReportResponseProto

required DatanodeInfoProto datanodeInfo = 1
repeated StorageReportProto storageReports = 2

* Datanode volume information

required string path = 1
required StorageTypeProto storageType = 2
required uint64 usedSpace = 3
required uint64 freeSpace = 4
required uint64 reservedSpace = 5
required uint64 reservedSpaceForReplicas = 6
required uint64 numBlocks = 7

* Directory listing

Used in: GetListingResponseProto

repeated HdfsFileStatusProto partialListing = 1
required uint32 remainingEntries = 2

message ECSchemaOptionEntryProto

hdfs.proto:377

* ECSchema options entry

Used in: ECSchemaProto

required string key = 1
required string value = 2

* ECSchema for erasurecoding

Used in: ErasureCodingPolicyProto

required string codecName = 1
required uint32 dataUnits = 2
required uint32 parityUnits = 3
repeated ECSchemaOptionEntryProto options = 4

Used in: GetEZForPathResponseProto, ListEncryptionZonesResponseProto

required int64 id = 1
required string path = 2
required CipherSuiteProto suite = 3
required CryptoProtocolVersionProto cryptoProtocolVersion = 4
required string keyName = 5

Used in: AddErasureCodingPoliciesRequestProto, AddErasureCodingPolicyResponseProto, BlockECReconstructionInfoProto, GetErasureCodingPoliciesResponseProto, GetErasureCodingPolicyResponseProto, HdfsFileStatusProto, LocatedBlocksProto, OpBlockGroupChecksumProto

optional string name = 1
optional ECSchemaProto schema = 2
optional uint32 cellSize = 3
required uint32 id = 4
Actually a byte - only 8 bits used
optional ErasureCodingPolicyState state = 5

* EC policy state.

Used in: ErasureCodingPolicyProto

DISABLED = 1
ENABLED = 2
REMOVED = 3

Used in: EventsListProto

required int64 txid = 1
repeated EventProto events = 2

Used in: EventBatchProto, EventsListProto

required EventType type = 1
required bytes contents = 2

Used in: EventProto

EVENT_CREATE = 0
EVENT_CLOSE = 1
EVENT_APPEND = 2
EVENT_RENAME = 3
EVENT_METADATA = 4
EVENT_UNLINK = 5
EVENT_TRUNCATE = 6

Used in: GetEditsFromTxidResponseProto

repeated EventProto events = 1
deprecated
required int64 firstTxid = 2
required int64 lastTxid = 3
required int64 syncTxid = 4
repeated EventBatchProto batch = 5

* Extended block idenfies a block

Used in: AbandonBlockRequestProto, AddBlockRequestProto, BaseHeaderProto, BlockECReconstructionInfoProto, CompleteRequestProto, GetAdditionalDatanodeRequestProto, LocatedBlockProto, UpdateBlockForPipelineRequestProto, UpdatePipelineRequestProto

required string poolId = 1
Block pool id - gloablly unique across clusters
required uint64 blockId = 2
the local id within a pool
required uint64 generationStamp = 3
optional uint64 numBytes = 4
len does not belong in ebid

* Encryption information for a file.

Used in: HdfsFileStatusProto, LocatedBlocksProto

required CipherSuiteProto suite = 1
required CryptoProtocolVersionProto cryptoProtocolVersion = 2
required bytes key = 3
required bytes iv = 4
required string keyName = 5
required string ezKeyVersionName = 6

* File or Directory permision - same spec as posix

Used in: AclStatusProto, CreateEventProto, CreateRequestProto, CreateSymlinkRequestProto, HdfsFileStatusProto, MetadataUpdateEventProto, MkdirsRequestProto, SetPermissionRequestProto, SnapshotInfoProto

required uint32 perm = 1
Actually a short - only 16bits used

* HDFS Server Defaults

Used in: GetServerDefaultsResponseProto

required uint64 blockSize = 1
required uint32 bytesPerChecksum = 2
required uint32 writePacketSize = 3
required uint32 replication = 4
Actually a short - only 16 bits used
required uint32 fileBufferSize = 5
optional bool encryptDataTransfer = 6
optional uint64 trashInterval = 7
optional ChecksumTypeProto checksumType = 8
optional string keyProviderUri = 9
optional uint32 policyId = 10

* Status of a file, directory or symlink Optionally includes a file's block locations if requested by client on the rpc call.

Used in: AppendResponseProto, CreateResponseProto, DirectoryListingProto, GetFileInfoResponseProto, GetFileLinkInfoResponseProto, GetLocatedFileInfoResponseProto, SnapshottableDirectoryStatusProto

required HdfsFileStatusProto.FileType fileType = 1
required bytes path = 2
local name of inode encoded java UTF8
required uint64 length = 3
required FsPermissionProto permission = 4
required string owner = 5
required string group = 6
required uint64 modification_time = 7
required uint64 access_time = 8
optional bytes symlink = 9
Optional fields for symlink
if symlink, target encoded java UTF8
optional uint32 block_replication = 10
Optional fields for file
only 16bits used
optional uint64 blocksize = 11
optional LocatedBlocksProto locations = 12
suppled only if asked by client
optional uint64 fileId = 13
Optional field for fileId
default as an invalid id
optional int32 childrenNum = 14
optional FileEncryptionInfoProto fileEncryptionInfo = 15
Optional field for file encryption
optional uint32 storagePolicy = 16
block storage policy id
optional ErasureCodingPolicyProto ecPolicy = 17
Optional field for erasure coding
optional uint32 flags = 18
Set of flags

Used in: HdfsFileStatusProto

IS_DIR = 1
IS_FILE = 2
IS_SYMLINK = 3

HAS_ACL = 1
has ACLs
HAS_CRYPT = 2
encrypted
HAS_EC = 4
erasure coded
SNAPSHOT_ENABLED = 8
SNAPSHOT ENABLED

* Placeholder type for consistent HDFS operations.

optional uint64 inodeId = 1
optional uint64 mtime = 2
optional string path = 3

Used in: CreateEventProto

I_TYPE_FILE = 0
I_TYPE_DIRECTORY = 1
I_TYPE_SYMLINK = 2

* A LocatedBlock gives information about a block and its location.

Used in: AddBlockResponseProto, AppendResponseProto, GetAdditionalDatanodeResponseProto, LocatedBlocksProto, ReportBadBlocksRequestProto, UpdateBlockForPipelineResponseProto

required ExtendedBlockProto b = 1
required uint64 offset = 2
offset of first byte of block in the file
repeated DatanodeInfoProto locs = 3
Locations ordered by proximity to client ip
required bool corrupt = 4
true if all replicas of a block are corrupt, else false
required common.TokenProto blockToken = 5
repeated bool isCached = 6
if a location in locs is cached
repeated StorageTypeProto storageTypes = 7
repeated string storageIDs = 8
optional bytes blockIndices = 9
striped block related fields
used for striped block to indicate block index for each storage
repeated common.TokenProto blockTokens = 10
each internal block has a block token

* A set of file blocks and their locations.

Used in: GetBlockLocationsResponseProto, HdfsFileStatusProto

required uint64 fileLength = 1
repeated LocatedBlockProto blocks = 2
required bool underConstruction = 3
optional LocatedBlockProto lastBlock = 4
required bool isLastBlockComplete = 5
optional FileEncryptionInfoProto fileEncryptionInfo = 6
optional ErasureCodingPolicyProto ecPolicy = 7
Optional field for erasure coding

required string path = 1
required MetadataUpdateType type = 2
optional int64 mtime = 3
optional int64 atime = 4
optional int32 replication = 5
optional string ownerName = 6
optional string groupName = 7
optional FsPermissionProto perms = 8
repeated AclEntryProto acls = 9
repeated XAttrProto xAttrs = 10
optional bool xAttrsRemoved = 11

Used in: MetadataUpdateEventProto

META_TYPE_TIMES = 0
META_TYPE_REPLICATION = 1
META_TYPE_OWNER = 2
META_TYPE_PERMS = 3
META_TYPE_ACLS = 4
META_TYPE_XATTRS = 5

required BaseHeaderProto header = 1
optional BlockChecksumOptionsProto blockChecksumOptions = 2

Used in: BlockOpResponseProto

required uint32 bytesPerCrc = 1
required uint64 crcPerBlock = 2
required bytes blockChecksum = 3
optional ChecksumTypeProto crcType = 4
optional BlockChecksumOptionsProto blockChecksumOptions = 5

required BaseHeaderProto header = 1
required DatanodeInfosProto datanodes = 2
repeated common.TokenProto blockTokens = 3
each internal block has a block token
required ErasureCodingPolicyProto ecPolicy = 4
repeated uint32 blockIndices = 5
required uint64 requestedNumBytes = 6
optional BlockChecksumOptionsProto blockChecksumOptions = 7

required BaseHeaderProto header = 1

required string customId = 1

required ClientOperationHeaderProto header = 1
required uint64 offset = 2
required uint64 len = 3
optional bool sendChecksums = 4
optional CachingStrategyProto cachingStrategy = 5

required BaseHeaderProto header = 1
required string delHint = 2
required DatanodeInfoProto source = 3
optional StorageTypeProto storageType = 4
optional string storageId = 5

required BaseHeaderProto header = 1
required uint32 maxVersion = 2
* In order to get short-circuit access to block data, clients must set this to the highest version of the block data that they can understand. Currently 1 is the only version, but more versions may exist in the future if the on-disk format changes.
optional ShortCircuitShmSlotProto slotId = 3
* The shared memory slot to use, if we are using one.
optional bool supportsReceiptVerification = 4
* True if the client supports verifying that the file descriptor has been sent successfully.

required ClientOperationHeaderProto header = 1
repeated DatanodeInfoProto targets = 2
repeated StorageTypeProto targetStorageTypes = 3
repeated string targetStorageIds = 4

required ClientOperationHeaderProto header = 1
repeated DatanodeInfoProto targets = 2
optional DatanodeInfoProto source = 3
required OpWriteBlockProto.BlockConstructionStage stage = 4
required uint32 pipelineSize = 5
required uint64 minBytesRcvd = 6
required uint64 maxBytesRcvd = 7
required uint64 latestGenerationStamp = 8
required ChecksumProto requestedChecksum = 9
* The requested checksum mechanism for this block write.
optional CachingStrategyProto cachingStrategy = 10
optional StorageTypeProto storageType = 11
repeated StorageTypeProto targetStorageTypes = 12
optional bool allowLazyPersist = 13
* Hint to the DataNode that the block can be allocated on transient storage i.e. memory and written to disk lazily. The DataNode is free to ignore this hint.
optional bool pinning = 14
whether to pin the block, so Balancer won't move it.
repeated bool targetPinnings = 15
optional string storageId = 16
repeated string targetStorageIds = 17

Used in: OpWriteBlockProto

PIPELINE_SETUP_APPEND = 0
PIPELINE_SETUP_APPEND_RECOVERY = 1
pipeline set up for failed PIPELINE_SETUP_APPEND recovery
DATA_STREAMING = 2
data streaming
PIPELINE_SETUP_STREAMING_RECOVERY = 3
pipeline setup for failed data streaming recovery
PIPELINE_CLOSE = 4
close the block and pipeline
PIPELINE_CLOSE_RECOVERY = 5
Recover a failed PIPELINE_CLOSE
PIPELINE_SETUP_CREATE = 6
pipeline set up for block creation
TRANSFER_RBW = 7
transfer RBW for adding datanodes
TRANSFER_FINALIZED = 8
transfer Finalized for adding datanodes

Used in: ListOpenFilesResponseProto

required int64 id = 1
required string path = 2
required string clientName = 3
required string clientMachine = 4

Used in: ListOpenFilesRequestProto, ListOpenFilesResponseProto

ALL_OPEN_FILES = 1
BLOCKING_DECOMMISSION = 2

required sfixed64 offsetInBlock = 1
All fields must be fixed-length!
required sfixed64 seqno = 2
required bool lastPacketInBlock = 3
required sfixed32 dataLen = 4
optional bool syncBlock = 5

* Encryption information for an individual file within an encryption zone

required bytes key = 1
required bytes iv = 2
required string ezKeyVersionName = 3

required sint64 seqno = 1
repeated Status reply = 2
optional uint64 downstreamAckTimeNanos = 3
repeated uint32 flag = 4

required string path = 1
required int64 offset = 2
required int64 length = 3
required bytes nonce = 4

* Summary of quota usage of a directory

Used in: GetQuotaUsageResponseProto

required uint64 fileAndDirectoryCount = 1
required uint64 quota = 2
required uint64 spaceConsumed = 3
required uint64 spaceQuota = 4
optional StorageTypeQuotaInfosProto typeQuotaInfos = 5

* Sent as part of the BlockOpResponseProto for READ_BLOCK and COPY_BLOCK operations.

Used in: BlockOpResponseProto

required ChecksumProto checksum = 1
required uint64 chunkOffset = 2
* The offset into the block at which the first packet will start. This is necessary since reads will align backwards to a checksum chunk boundary.

Used in: ReencryptEncryptionZoneRequestProto

CANCEL_REENCRYPT = 1
START_REENCRYPT = 2

* Re-encryption information for an encryption zone

Used in: ZoneEncryptionInfoProto

required string ezKeyVersionName = 1
required uint64 submissionTime = 2
required bool canceled = 3
required int64 numReencrypted = 4
required int64 numFailures = 5
optional uint64 completionTime = 6
optional string lastFile = 7

Used in: ZoneReencryptionStatusProto

SUBMITTED = 1
PROCESSING = 2
COMPLETED = 3

required ShortCircuitShmSlotProto slotId = 1
optional DataTransferTraceInfoProto traceInfo = 2

required Status status = 1
optional string error = 2

required string srcPath = 1
required string destPath = 2
required int64 timestamp = 3

Used in: RollingUpgradeRequestProto

QUERY = 1
START = 2
FINALIZE = 3

Used in: RollingUpgradeResponseProto

required RollingUpgradeStatusProto status = 1
required uint64 startTime = 2
required uint64 finalizeTime = 3
required bool createdRollbackImages = 4

* Rolling upgrade status

Used in: RollingUpgradeInfoProto

required string blockPoolId = 1
optional bool finalized = 2

Used in: SetSafeModeRequestProto

SAFEMODE_LEAVE = 1
SAFEMODE_ENTER = 2
SAFEMODE_GET = 3
SAFEMODE_FORCE_EXIT = 4

DO_NOT_USE_RECEIPT_VERIFICATION = 0
USE_RECEIPT_VERIFICATION = 1

* An ID uniquely identifying a shared memory segment.

Used in: ShortCircuitShmResponseProto, ShortCircuitShmSlotProto

required int64 hi = 1
required int64 lo = 2

required string clientName = 1
The name of the client requesting the shared memory segment. This is purely for logging / debugging purposes.
optional DataTransferTraceInfoProto traceInfo = 2

required Status status = 1
optional string error = 2
optional ShortCircuitShmIdProto id = 3

* An ID uniquely identifying a slot within a shared memory segment.

Used in: OpRequestShortCircuitAccessProto, ReleaseShortCircuitAccessRequestProto

required ShortCircuitShmIdProto shmId = 1
required int32 slotIdx = 2

Used in: GetSnapshotDiffReportListingRequestProto, SnapshotDiffReportListingProto

required bytes startPath = 1
required int32 index = 2

message SnapshotDiffReportEntryProto

hdfs.proto:553

* Snapshot diff report entry

Used in: SnapshotDiffReportProto

required bytes fullpath = 1
required string modificationLabel = 2
optional bytes targetPath = 3

message SnapshotDiffReportListingEntryProto

hdfs.proto:573

* Snapshot diff report listing entry

Used in: SnapshotDiffReportListingProto

required bytes fullpath = 1
required uint64 dirId = 2
required bool isReference = 3
optional bytes targetPath = 4
optional uint64 fileId = 5

* Snapshot diff report listing

Used in: GetSnapshotDiffReportListingResponseProto

repeated SnapshotDiffReportListingEntryProto modifiedEntries = 1
full path of the directory where snapshots were taken
repeated SnapshotDiffReportListingEntryProto createdEntries = 2
repeated SnapshotDiffReportListingEntryProto deletedEntries = 3
required bool isFromEarlier = 4
optional SnapshotDiffReportCursorProto cursor = 5

* Snapshot diff report

Used in: GetSnapshotDiffReportResponseProto

required string snapshotRoot = 1
full path of the directory where snapshots were taken
required string fromSnapshot = 2
required string toSnapshot = 3
repeated SnapshotDiffReportEntryProto diffReportEntries = 4

* Information related to a snapshot TODO: add more information

required string snapshotName = 1
required string snapshotRoot = 2
required FsPermissionProto permission = 3
required string owner = 4
required string group = 5
required string createTime = 6
TODO: do we need access time?

* Snapshottable directory listing

Used in: GetSnapshottableDirListingResponseProto

repeated SnapshottableDirectoryStatusProto snapshottableDirListing = 1

* Status of a snapshottable directory: besides the normal information for a directory status, also include snapshot quota, number of snapshots, and the full path of the parent directory.

Used in: SnapshottableDirectoryListingProto

required HdfsFileStatusProto dirStatus = 1
required uint32 snapshot_quota = 2
Fields specific for snapshottable directory
required uint32 snapshot_number = 3
required bytes parent_fullpath = 4

Status is a 4-bit enum

Used in: BlockOpResponseProto, ClientReadStatusProto, DNTransferAckProto, PipelineAckProto, ReleaseShortCircuitAccessResponseProto, ShortCircuitShmResponseProto

SUCCESS = 0
ERROR = 1
ERROR_CHECKSUM = 2
ERROR_INVALID = 3
ERROR_EXISTS = 4
ERROR_ACCESS_TOKEN = 5
CHECKSUM_OK = 6
ERROR_UNSUPPORTED = 7
OOB_RESTART = 8
Quick restart
OOB_RESERVED1 = 9
Reserved
OOB_RESERVED2 = 10
Reserved
OOB_RESERVED3 = 11
Reserved
IN_PROGRESS = 12
ERROR_BLOCK_PINNED = 13

Used in: DatanodeStorageReportProto

required string storageUuid = 1
optional bool failed = 2
optional uint64 capacity = 3
optional uint64 dfsUsed = 4
optional uint64 remaining = 5
optional uint64 blockPoolUsed = 6
optional DatanodeStorageProto storage = 7
supersedes StorageUuid
optional uint64 nonDfsUsed = 8

* Types of recognized storage media.

Used in: BlockTokenSecretProto, DatanodeStorageProto, DatanodeVolumeInfoProto, LocatedBlockProto, OpReplaceBlockProto, OpTransferBlockProto, OpWriteBlockProto, SetQuotaRequestProto, StorageTypeQuotaInfoProto, StorageTypesProto

DISK = 1
SSD = 2
ARCHIVE = 3
RAM_DISK = 4
PROVIDED = 5

Used in: StorageTypeQuotaInfosProto

required StorageTypeProto type = 1
required uint64 quota = 2
required uint64 consumed = 3

* Storage type quota and usage information of a file or directory

Used in: ContentSummaryProto, QuotaUsageProto

repeated StorageTypeQuotaInfoProto typeQuotaInfo = 1

* A list of storage types.

Used in: BlockECReconstructionInfoProto, BlockStoragePolicyProto

repeated StorageTypeProto storageTypes = 1

* A list of storage IDs.

Used in: BlockECReconstructionInfoProto

repeated string storageUuids = 1

required string path = 1
required int64 fileSize = 2
required int64 timestamp = 3

required string path = 1
required int64 timestamp = 2

Used in: GetXAttrsRequestProto, GetXAttrsResponseProto, ListXAttrsResponseProto, MetadataUpdateEventProto, RemoveXAttrRequestProto, SetXAttrRequestProto

required XAttrProto.XAttrNamespaceProto namespace = 1
required string name = 2
optional bytes value = 3

Used in: XAttrProto

USER = 0
TRUSTED = 1
SECURITY = 2
SYSTEM = 3
RAW = 4

XATTR_CREATE = 1
XATTR_REPLACE = 2

* Encryption information for an encryption zone

required CipherSuiteProto suite = 1
required CryptoProtocolVersionProto cryptoProtocolVersion = 2
required string keyName = 3
optional ReencryptionInfoProto reencryptionProto = 4

Used in: ListReencryptionStatusResponseProto

required int64 id = 1
required string path = 2
required ReencryptionStateProto state = 3
required string ezKeyVersionName = 4
required int64 submissionTime = 5
required bool canceled = 6
required int64 numReencrypted = 7
required int64 numFailures = 8
optional int64 completionTime = 9
optional string lastFile = 10

package hadoop.hdfs

service ClientNamenodeProtocol

rpc abandonBlock (AbandonBlockRequestProto, AbandonBlockResponseProto)

message AbandonBlockRequestProto

required ExtendedBlockProto b = 1

required string src = 2

required string holder = 3

optional uint64 fileId = 4

message AbandonBlockResponseProto

rpc addBlock (AddBlockRequestProto, AddBlockResponseProto)

message AddBlockRequestProto

required string src = 1

required string clientName = 2

optional ExtendedBlockProto previous = 3

repeated DatanodeInfoProto excludeNodes = 4

optional uint64 fileId = 5

repeated string favoredNodes = 6

repeated AddBlockFlagProto flags = 7

message AddBlockResponseProto

required LocatedBlockProto block = 1

rpc addCacheDirective (AddCacheDirectiveRequestProto, AddCacheDirectiveResponseProto)

message AddCacheDirectiveRequestProto

required CacheDirectiveInfoProto info = 1

optional uint32 cacheFlags = 2

message AddCacheDirectiveResponseProto

required int64 id = 1

rpc addCachePool (AddCachePoolRequestProto, AddCachePoolResponseProto)

message AddCachePoolRequestProto

required CachePoolInfoProto info = 1

message AddCachePoolResponseProto

rpc addErasureCodingPolicies (AddErasureCodingPoliciesRequestProto, AddErasureCodingPoliciesResponseProto)

message AddErasureCodingPoliciesRequestProto

repeated ErasureCodingPolicyProto ecPolicies = 1

message AddErasureCodingPoliciesResponseProto

repeated AddErasureCodingPolicyResponseProto responses = 1

rpc allowSnapshot (AllowSnapshotRequestProto, AllowSnapshotResponseProto)

message AllowSnapshotRequestProto

required string snapshotRoot = 1

message AllowSnapshotResponseProto

rpc append (AppendRequestProto, AppendResponseProto)

message AppendRequestProto

required string src = 1

required string clientName = 2

optional uint32 flag = 3

message AppendResponseProto

optional LocatedBlockProto block = 1

optional HdfsFileStatusProto stat = 2

rpc cancelDelegationToken (common.CancelDelegationTokenRequestProto, common.CancelDelegationTokenResponseProto)

rpc checkAccess (CheckAccessRequestProto, CheckAccessResponseProto)

message CheckAccessRequestProto

required string path = 1

required AclEntryProto.FsActionProto mode = 2

message CheckAccessResponseProto

rpc complete (CompleteRequestProto, CompleteResponseProto)

message CompleteRequestProto

required string src = 1

required string clientName = 2

optional ExtendedBlockProto last = 3

optional uint64 fileId = 4

message CompleteResponseProto

required bool result = 1

rpc concat (ConcatRequestProto, ConcatResponseProto)

message ConcatRequestProto

required string trg = 1

repeated string srcs = 2

message ConcatResponseProto

rpc create (CreateRequestProto, CreateResponseProto)

message CreateRequestProto

required string src = 1

required FsPermissionProto masked = 2

required string clientName = 3

required uint32 createFlag = 4

required bool createParent = 5

required uint32 replication = 6

required uint64 blockSize = 7

repeated CryptoProtocolVersionProto cryptoProtocolVersion = 8

optional FsPermissionProto unmasked = 9

optional string ecPolicyName = 10

message CreateResponseProto

optional HdfsFileStatusProto fs = 1