package hadoop.hdfs

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc abandonBlock (AbandonBlockRequestProto, AbandonBlockResponseProto)

  ClientNamenodeProtocol.proto:514

  message AbandonBlockRequestProto

  ClientNamenodeProtocol.proto:118

  • required ExtendedBlockProto b = 1

  • required string src = 2

  • required string holder = 3

  message AbandonBlockResponseProto

  ClientNamenodeProtocol.proto:124

  void response

  (message has no fields)

• rpc addBlock (AddBlockRequestProto, AddBlockResponseProto)

  ClientNamenodeProtocol.proto:515

  message AddBlockRequestProto

  ClientNamenodeProtocol.proto:127

  • required string src = 1

  • required string clientName = 2

  • optional ExtendedBlockProto previous = 3

  • repeated DatanodeInfoProto excludeNodes = 4

  • optional uint64 fileId = 5

    default as a bogus id

  • repeated string favoredNodes = 6

    the set of datanodes to use for the block

  message AddBlockResponseProto

  ClientNamenodeProtocol.proto:136

  • required LocatedBlockProto block = 1

• rpc allowSnapshot (AllowSnapshotRequestProto, AllowSnapshotResponseProto)

  ClientNamenodeProtocol.proto:579

  message AllowSnapshotRequestProto

  ClientNamenodeProtocol.proto:480

  • required string snapshotRoot = 1

  message AllowSnapshotResponseProto

  ClientNamenodeProtocol.proto:484

  (message has no fields)

• rpc append (AppendRequestProto, AppendResponseProto)

  ClientNamenodeProtocol.proto:508

  message AppendRequestProto

  ClientNamenodeProtocol.proto:83

  • required string src = 1

  • required string clientName = 2

  message AppendResponseProto

  ClientNamenodeProtocol.proto:88

  • optional LocatedBlockProto block = 1

• rpc cancelDelegationToken (common.CancelDelegationTokenRequestProto, common.CancelDelegationTokenResponseProto)

  ClientNamenodeProtocol.proto:569

• rpc complete (CompleteRequestProto, CompleteResponseProto)

  ClientNamenodeProtocol.proto:518

  message CompleteRequestProto

  ClientNamenodeProtocol.proto:153

  • required string src = 1

  • required string clientName = 2

  • optional ExtendedBlockProto last = 3

  • optional uint64 fileId = 4

    default to GRANDFATHER_INODE_ID

  message CompleteResponseProto

  ClientNamenodeProtocol.proto:160

  • required bool result = 1

• rpc concat (ConcatRequestProto, ConcatResponseProto)

  ClientNamenodeProtocol.proto:521

  message ConcatRequestProto

  ClientNamenodeProtocol.proto:171

  • required string trg = 1

  • repeated string srcs = 2

  message ConcatResponseProto

  ClientNamenodeProtocol.proto:176

  void response

  (message has no fields)

• rpc create (CreateRequestProto, CreateResponseProto)

  ClientNamenodeProtocol.proto:507

  message CreateRequestProto

  ClientNamenodeProtocol.proto:69

  • required string src = 1

  • required FsPermissionProto masked = 2

  • required string clientName = 3

  • required uint32 createFlag = 4

    bits set using CreateFlag

  • required bool createParent = 5

  • required uint32 replication = 6

    Short: Only 16 bits used

  • required uint64 blockSize = 7

  message CreateResponseProto

  ClientNamenodeProtocol.proto:79

  • optional HdfsFileStatusProto fs = 1

• rpc createSnapshot (CreateSnapshotRequestProto, CreateSnapshotResponseProto)

  ClientNamenodeProtocol.proto:575

  message CreateSnapshotRequestProto

  ClientNamenodeProtocol.proto:462

  • required string snapshotRoot = 1

  • optional string snapshotName = 2

  message CreateSnapshotResponseProto

  ClientNamenodeProtocol.proto:467

  • required string snapshotPath = 1

• rpc createSymlink (CreateSymlinkRequestProto, CreateSymlinkResponseProto)

  ClientNamenodeProtocol.proto:557

  message CreateSymlinkRequestProto

  ClientNamenodeProtocol.proto:412

  • required string target = 1

  • required string link = 2

  • required FsPermissionProto dirPerm = 3

  • required bool createParent = 4

  message CreateSymlinkResponseProto

  ClientNamenodeProtocol.proto:419

  void response

  (message has no fields)

• rpc delete (DeleteRequestProto, DeleteResponseProto)

  ClientNamenodeProtocol.proto:524

  message DeleteRequestProto

  ClientNamenodeProtocol.proto:198

  • required string src = 1

  • required bool recursive = 2

  message DeleteResponseProto

  ClientNamenodeProtocol.proto:203

  • required bool result = 1

• rpc deleteSnapshot (DeleteSnapshotRequestProto, DeleteSnapshotResponseProto)

  ClientNamenodeProtocol.proto:585

  message DeleteSnapshotRequestProto

  ClientNamenodeProtocol.proto:494

  • required string snapshotRoot = 1

  • required string snapshotName = 2

  message DeleteSnapshotResponseProto

  ClientNamenodeProtocol.proto:499

  void response

  (message has no fields)

• rpc disallowSnapshot (DisallowSnapshotRequestProto, DisallowSnapshotResponseProto)

  ClientNamenodeProtocol.proto:581

  message DisallowSnapshotRequestProto

  ClientNamenodeProtocol.proto:487

  • required string snapshotRoot = 1

  message DisallowSnapshotResponseProto

  ClientNamenodeProtocol.proto:491

  (message has no fields)

• rpc finalizeUpgrade (FinalizeUpgradeRequestProto, FinalizeUpgradeResponseProto)

  ClientNamenodeProtocol.proto:544

  message FinalizeUpgradeRequestProto

  ClientNamenodeProtocol.proto:331

  no parameters

  (message has no fields)

  message FinalizeUpgradeResponseProto

  ClientNamenodeProtocol.proto:334

  void response

  (message has no fields)

• rpc fsync (FsyncRequestProto, FsyncResponseProto)

  ClientNamenodeProtocol.proto:555

  message FsyncRequestProto

  ClientNamenodeProtocol.proto:394

  • required string src = 1

  • required string client = 2

  • optional sint64 lastBlockLength = 3

  message FsyncResponseProto

  ClientNamenodeProtocol.proto:400

  void response

  (message has no fields)

• rpc getAdditionalDatanode (GetAdditionalDatanodeRequestProto, GetAdditionalDatanodeResponseProto)

  ClientNamenodeProtocol.proto:516

  message GetAdditionalDatanodeRequestProto

  ClientNamenodeProtocol.proto:140

  • required string src = 1

  • required ExtendedBlockProto blk = 2

  • repeated DatanodeInfoProto existings = 3

  • repeated DatanodeInfoProto excludes = 4

  • required uint32 numAdditionalNodes = 5

  • required string clientName = 6

  message GetAdditionalDatanodeResponseProto

  ClientNamenodeProtocol.proto:149

  • required LocatedBlockProto block = 1

• rpc getBlockLocations (GetBlockLocationsRequestProto, GetBlockLocationsResponseProto)

  ClientNamenodeProtocol.proto:503

  message GetBlockLocationsRequestProto

  ClientNamenodeProtocol.proto:46

  • required string src = 1

    file name

  • required uint64 offset = 2

    range start offset

  • required uint64 length = 3

    range length

  message GetBlockLocationsResponseProto

  ClientNamenodeProtocol.proto:52

  • optional LocatedBlocksProto locations = 1

• rpc getContentSummary (GetContentSummaryRequestProto, GetContentSummaryResponseProto)

  ClientNamenodeProtocol.proto:552

  message GetContentSummaryRequestProto

  ClientNamenodeProtocol.proto:377

  • required string path = 1

  message GetContentSummaryResponseProto

  ClientNamenodeProtocol.proto:381

  • required ContentSummaryProto summary = 1

• rpc getDataEncryptionKey (GetDataEncryptionKeyRequestProto, GetDataEncryptionKeyResponseProto)

  ClientNamenodeProtocol.proto:573

  message GetDataEncryptionKeyRequestProto

  ClientNamenodeProtocol.proto:455

  no parameters

  (message has no fields)

  message GetDataEncryptionKeyResponseProto

  ClientNamenodeProtocol.proto:458

  • optional DataEncryptionKeyProto dataEncryptionKey = 1

• rpc getDatanodeReport (GetDatanodeReportRequestProto, GetDatanodeReportResponseProto)

  ClientNamenodeProtocol.proto:531

  message GetDatanodeReportRequestProto

  ClientNamenodeProtocol.proto:273

  • required DatanodeReportTypeProto type = 1

  message GetDatanodeReportResponseProto

  ClientNamenodeProtocol.proto:277

  • repeated DatanodeInfoProto di = 1

• rpc getDelegationToken (common.GetDelegationTokenRequestProto, common.GetDelegationTokenResponseProto)

  ClientNamenodeProtocol.proto:565

• rpc getFileInfo (GetFileInfoRequestProto, GetFileInfoResponseProto)

  ClientNamenodeProtocol.proto:549

  message GetFileInfoRequestProto

  ClientNamenodeProtocol.proto:353

  • required string src = 1

  message GetFileInfoResponseProto

  ClientNamenodeProtocol.proto:357

  • optional HdfsFileStatusProto fs = 1

• rpc getFileLinkInfo (GetFileLinkInfoRequestProto, GetFileLinkInfoResponseProto)

  ClientNamenodeProtocol.proto:550

  message GetFileLinkInfoRequestProto

  ClientNamenodeProtocol.proto:369

  • required string src = 1

  message GetFileLinkInfoResponseProto

  ClientNamenodeProtocol.proto:373

  • optional HdfsFileStatusProto fs = 1

• rpc getFsStats (GetFsStatusRequestProto, GetFsStatsResponseProto)

  ClientNamenodeProtocol.proto:530

  message GetFsStatusRequestProto

  ClientNamenodeProtocol.proto:255

  no input paramters

  (message has no fields)

  message GetFsStatsResponseProto

  ClientNamenodeProtocol.proto:258

  • required uint64 capacity = 1

  • required uint64 used = 2

  • required uint64 remaining = 3

  • required uint64 under_replicated = 4

  • required uint64 corrupt_blocks = 5

  • required uint64 missing_blocks = 6

• rpc getLinkTarget (GetLinkTargetRequestProto, GetLinkTargetResponseProto)

  ClientNamenodeProtocol.proto:559

  message GetLinkTargetRequestProto

  ClientNamenodeProtocol.proto:422

  • required string path = 1

  message GetLinkTargetResponseProto

  ClientNamenodeProtocol.proto:425

  • optional string targetPath = 1

• rpc getListing (GetListingRequestProto, GetListingResponseProto)

  ClientNamenodeProtocol.proto:526

  message GetListingRequestProto

  ClientNamenodeProtocol.proto:216

  • required string src = 1

  • required bytes startAfter = 2

  • required bool needLocation = 3

  message GetListingResponseProto

  ClientNamenodeProtocol.proto:221

  • optional DirectoryListingProto dirList = 1

• rpc getPreferredBlockSize (GetPreferredBlockSizeRequestProto, GetPreferredBlockSizeResponseProto)

  ClientNamenodeProtocol.proto:533

  message GetPreferredBlockSizeRequestProto

  ClientNamenodeProtocol.proto:281

  • required string filename = 1

  message GetPreferredBlockSizeResponseProto

  ClientNamenodeProtocol.proto:285

  • required uint64 bsize = 1

• rpc getServerDefaults (GetServerDefaultsRequestProto, GetServerDefaultsResponseProto)

  ClientNamenodeProtocol.proto:505

  message GetServerDefaultsRequestProto

  ClientNamenodeProtocol.proto:56

  No parameters

  (message has no fields)

  message GetServerDefaultsResponseProto

  ClientNamenodeProtocol.proto:59

  • required FsServerDefaultsProto serverDefaults = 1

• rpc getSnapshotDiffReport (GetSnapshotDiffReportRequestProto, GetSnapshotDiffReportResponseProto)

  ClientNamenodeProtocol.proto:587

  message GetSnapshotDiffReportRequestProto

  ClientNamenodeProtocol.proto:231

  • required string snapshotRoot = 1

  • required string fromSnapshot = 2

  • required string toSnapshot = 3

  message GetSnapshotDiffReportResponseProto

  ClientNamenodeProtocol.proto:236

  • required SnapshotDiffReportProto diffReport = 1

• rpc getSnapshottableDirListing (GetSnapshottableDirListingRequestProto, GetSnapshottableDirListingResponseProto)

  ClientNamenodeProtocol.proto:583

  message GetSnapshottableDirListingRequestProto

  ClientNamenodeProtocol.proto:225

  no input parameters

  (message has no fields)

  message GetSnapshottableDirListingResponseProto

  ClientNamenodeProtocol.proto:227

  • optional SnapshottableDirectoryListingProto snapshottableDirList = 1

• rpc isFileClosed (IsFileClosedRequestProto, IsFileClosedResponseProto)

  ClientNamenodeProtocol.proto:589

  message IsFileClosedRequestProto

  ClientNamenodeProtocol.proto:361

  • required string src = 1

  message IsFileClosedResponseProto

  ClientNamenodeProtocol.proto:365

  • required bool result = 1

• rpc listCorruptFileBlocks (ListCorruptFileBlocksRequestProto, ListCorruptFileBlocksResponseProto)

  ClientNamenodeProtocol.proto:546

  message ListCorruptFileBlocksRequestProto

  ClientNamenodeProtocol.proto:337

  • required string path = 1

  • optional string cookie = 2

  message ListCorruptFileBlocksResponseProto

  ClientNamenodeProtocol.proto:342

  • required CorruptFileBlocksProto corrupt = 1

• rpc metaSave (MetaSaveRequestProto, MetaSaveResponseProto)

  ClientNamenodeProtocol.proto:548

  message MetaSaveRequestProto

  ClientNamenodeProtocol.proto:346

  • required string filename = 1

  message MetaSaveResponseProto

  ClientNamenodeProtocol.proto:350

  void response

  (message has no fields)

• rpc mkdirs (MkdirsRequestProto, MkdirsResponseProto)

  ClientNamenodeProtocol.proto:525

  message MkdirsRequestProto

  ClientNamenodeProtocol.proto:207

  • required string src = 1

  • required FsPermissionProto masked = 2

  • required bool createParent = 3

  message MkdirsResponseProto

  ClientNamenodeProtocol.proto:212

  • required bool result = 1

• rpc recoverLease (RecoverLeaseRequestProto, RecoverLeaseResponseProto)

  ClientNamenodeProtocol.proto:528

  message RecoverLeaseRequestProto

  ClientNamenodeProtocol.proto:247

  • required string src = 1

  • required string clientName = 2

  message RecoverLeaseResponseProto

  ClientNamenodeProtocol.proto:251

  • required bool result = 1

• rpc refreshNodes (RefreshNodesRequestProto, RefreshNodesResponseProto)

  ClientNamenodeProtocol.proto:543

  message RefreshNodesRequestProto

  ClientNamenodeProtocol.proto:325

  no parameters

  (message has no fields)

  message RefreshNodesResponseProto

  ClientNamenodeProtocol.proto:328

  void response

  (message has no fields)

• rpc rename (RenameRequestProto, RenameResponseProto)

  ClientNamenodeProtocol.proto:522

  message RenameRequestProto

  ClientNamenodeProtocol.proto:179

  • required string src = 1

  • required string dst = 2

  message RenameResponseProto

  ClientNamenodeProtocol.proto:184

  • required bool result = 1

• rpc rename2 (Rename2RequestProto, Rename2ResponseProto)

  ClientNamenodeProtocol.proto:523

  message Rename2RequestProto

  ClientNamenodeProtocol.proto:189

  • required string src = 1

  • required string dst = 2

  • required bool overwriteDest = 3

  message Rename2ResponseProto

  ClientNamenodeProtocol.proto:195

  void response

  (message has no fields)

• rpc renameSnapshot (RenameSnapshotRequestProto, RenameSnapshotResponseProto)

  ClientNamenodeProtocol.proto:577

  message RenameSnapshotRequestProto

  ClientNamenodeProtocol.proto:471

  • required string snapshotRoot = 1

  • required string snapshotOldName = 2

  • required string snapshotNewName = 3

  message RenameSnapshotResponseProto

  ClientNamenodeProtocol.proto:477

  void response

  (message has no fields)

• rpc renewDelegationToken (common.RenewDelegationTokenRequestProto, common.RenewDelegationTokenResponseProto)

  ClientNamenodeProtocol.proto:567

• rpc renewLease (RenewLeaseRequestProto, RenewLeaseResponseProto)

  ClientNamenodeProtocol.proto:527

  message RenewLeaseRequestProto

  ClientNamenodeProtocol.proto:240

  • required string clientName = 1

  message RenewLeaseResponseProto

  ClientNamenodeProtocol.proto:244

  void response

  (message has no fields)

• rpc reportBadBlocks (ReportBadBlocksRequestProto, ReportBadBlocksResponseProto)

  ClientNamenodeProtocol.proto:519

  message ReportBadBlocksRequestProto

  ClientNamenodeProtocol.proto:164

  • repeated LocatedBlockProto blocks = 1

  message ReportBadBlocksResponseProto

  ClientNamenodeProtocol.proto:168

  void response

  (message has no fields)

• rpc restoreFailedStorage (RestoreFailedStorageRequestProto, RestoreFailedStorageResponseProto)

  ClientNamenodeProtocol.proto:541

  message RestoreFailedStorageRequestProto

  ClientNamenodeProtocol.proto:317

  • required string arg = 1

  message RestoreFailedStorageResponseProto

  ClientNamenodeProtocol.proto:321

  • required bool result = 1

• rpc rollEdits (RollEditsRequestProto, RollEditsResponseProto)

  ClientNamenodeProtocol.proto:539

  message RollEditsRequestProto

  ClientNamenodeProtocol.proto:310

  no parameters

  (message has no fields)

  message RollEditsResponseProto

  ClientNamenodeProtocol.proto:313

  response

  • required uint64 newSegmentTxId = 1

• rpc saveNamespace (SaveNamespaceRequestProto, SaveNamespaceResponseProto)

  ClientNamenodeProtocol.proto:537

  message SaveNamespaceRequestProto

  ClientNamenodeProtocol.proto:304

  no parameters

  (message has no fields)

  message SaveNamespaceResponseProto

  ClientNamenodeProtocol.proto:307

  void response

  (message has no fields)

• rpc setBalancerBandwidth (SetBalancerBandwidthRequestProto, SetBalancerBandwidthResponseProto)

  ClientNamenodeProtocol.proto:571

  message SetBalancerBandwidthRequestProto

  ClientNamenodeProtocol.proto:448

  • required int64 bandwidth = 1

  message SetBalancerBandwidthResponseProto

  ClientNamenodeProtocol.proto:452

  void response

  (message has no fields)

• rpc setOwner (SetOwnerRequestProto, SetOwnerResponseProto)

  ClientNamenodeProtocol.proto:513

  message SetOwnerRequestProto

  ClientNamenodeProtocol.proto:109

  • required string src = 1

  • optional string username = 2

  • optional string groupname = 3

  message SetOwnerResponseProto

  ClientNamenodeProtocol.proto:115

  void response

  (message has no fields)

• rpc setPermission (SetPermissionRequestProto, SetPermissionResponseProto)

  ClientNamenodeProtocol.proto:511

  message SetPermissionRequestProto

  ClientNamenodeProtocol.proto:101

  • required string src = 1

  • required FsPermissionProto permission = 2

  message SetPermissionResponseProto

  ClientNamenodeProtocol.proto:106

  void response

  (message has no fields)

• rpc setQuota (SetQuotaRequestProto, SetQuotaResponseProto)

  ClientNamenodeProtocol.proto:554

  message SetQuotaRequestProto

  ClientNamenodeProtocol.proto:385

  • required string path = 1

  • required uint64 namespaceQuota = 2

  • required uint64 diskspaceQuota = 3

  message SetQuotaResponseProto

  ClientNamenodeProtocol.proto:391

  void response

  (message has no fields)

• rpc setReplication (SetReplicationRequestProto, SetReplicationResponseProto)

  ClientNamenodeProtocol.proto:509

  message SetReplicationRequestProto

  ClientNamenodeProtocol.proto:92

  • required string src = 1

  • required uint32 replication = 2

    Short: Only 16 bits used

  message SetReplicationResponseProto

  ClientNamenodeProtocol.proto:97

  • required bool result = 1

• rpc setSafeMode (SetSafeModeRequestProto, SetSafeModeResponseProto)

  ClientNamenodeProtocol.proto:535

  message SetSafeModeRequestProto

  ClientNamenodeProtocol.proto:295

  • required SafeModeActionProto action = 1

  • optional bool checked = 2

  message SetSafeModeResponseProto

  ClientNamenodeProtocol.proto:300

  • required bool result = 1

• rpc setTimes (SetTimesRequestProto, SetTimesResponseProto)

  ClientNamenodeProtocol.proto:556

  message SetTimesRequestProto

  ClientNamenodeProtocol.proto:403

  • required string src = 1

  • required uint64 mtime = 2

  • required uint64 atime = 3

  message SetTimesResponseProto

  ClientNamenodeProtocol.proto:409

  void response

  (message has no fields)

• rpc updateBlockForPipeline (UpdateBlockForPipelineRequestProto, UpdateBlockForPipelineResponseProto)

  ClientNamenodeProtocol.proto:561

  message UpdateBlockForPipelineRequestProto

  ClientNamenodeProtocol.proto:429

  • required ExtendedBlockProto block = 1

  • required string clientName = 2

  message UpdateBlockForPipelineResponseProto

  ClientNamenodeProtocol.proto:434

  • required LocatedBlockProto block = 1

• rpc updatePipeline (UpdatePipelineRequestProto, UpdatePipelineResponseProto)

  ClientNamenodeProtocol.proto:563

  message UpdatePipelineRequestProto

  ClientNamenodeProtocol.proto:438

  • required string clientName = 1

  • required ExtendedBlockProto oldBlock = 2

  • required ExtendedBlockProto newBlock = 3

  • repeated DatanodeIDProto newNodes = 4

  message UpdatePipelineResponseProto

  ClientNamenodeProtocol.proto:445

  void response

  (message has no fields)

Used in: ClientOperationHeaderProto, OpBlockChecksumProto, OpCopyBlockProto, OpReplaceBlockProto, OpRequestShortCircuitAccessProto

• required ExtendedBlockProto block = 1

• optional common.TokenProto token = 2

* Block access token information

Used in: ExportedBlockKeysProto

• required uint32 keyId = 1

  Key identifier

• required uint64 expiryDate = 2

  Expiry time in milliseconds

• optional bytes keyBytes = 3

  Key secret

• 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

Used in: BlockWithLocationsProto

• required uint64 blockId = 1

• required uint64 genStamp = 2

• optional uint64 numBytes = 3

* Block and datanodes where is it located

Used in: BlocksWithLocationsProto

• required BlockProto block = 1

  Block

• repeated string storageIDs = 2

  Datanodes with replicas of the block

* List of block with locations

• repeated BlockWithLocationsProto blocks = 1

Used in: OpReadBlockProto, OpWriteBlockProto

• optional bool dropBehind = 1

• optional int64 readahead = 2

* Command returned from primary to checkpointing namenode. This command has checkpoint signature that identifies checkpoint transaction and is needed for further communication related to checkpointing.

Used in: NamenodeCommandProto

• required CheckpointSignatureProto signature = 1

  Unique signature to identify checkpoint transation

• required bool needToReturnImage = 2

  If true, return transfer image to primary upon the completion of checkpoint

* Unique signature to identify checkpoint transactions.

Used in: CheckpointCommandProto

• required string blockPoolId = 1

• required uint64 mostRecentCheckpointTxId = 2

• required uint64 curSegmentTxId = 3

• required StorageInfoProto storageInfo = 4

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

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

* 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

* 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

• CREATE = 1

  Create a file

• OVERWRITE = 2

  Truncate/overwrite a file. Same as POSIX O_TRUNC

• APPEND = 4

  Append to a file

• 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

• required DataTransferEncryptorMessageProto.DataTransferEncryptorStatus status = 1

• optional bytes payload = 2

• optional string message = 3

Used in: DataTransferEncryptorMessageProto

• SUCCESS = 0

• ERROR_UNKNOWN_KEY = 1

• ERROR = 2

* Identifies a Datanode

Used in: DatanodeInfoProto, UpdatePipelineRequestProto

• required string ipAddr = 1

  IP address

• required string hostName = 2

  hostname

• required string storageID = 3

  unique storage id

• required uint32 xferPort = 4

  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, 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 DatanodeInfoProto.AdminState adminState = 10

Used in: DatanodeInfoProto

• NORMAL = 0

• DECOMMISSION_INPROGRESS = 1

• DECOMMISSIONED = 2

* DatanodeInfo array

• repeated DatanodeInfoProto datanodes = 1

type of the datanode report

Used in: GetDatanodeReportRequestProto

• ALL = 1

• LIVE = 2

• DEAD = 3

* Directory listing

Used in: GetListingResponseProto

• repeated HdfsFileStatusProto partialListing = 1

• required uint32 remainingEntries = 2

* Current key and set of block keys at the namenode.

• required bool isBlockTokenEnabled = 1

• required uint64 keyUpdateInterval = 2

• required uint64 tokenLifeTime = 3

• required BlockKeyProto currentKey = 4

• repeated BlockKeyProto allKeys = 5

* Extended block idenfies a block

Used in: AbandonBlockRequestProto, AddBlockRequestProto, BaseHeaderProto, 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

* File or Directory permision - same spec as posix

Used in: CreateRequestProto, CreateSymlinkRequestProto, HdfsFileStatusProto, 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

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

Used in: CreateResponseProto, DirectoryListingProto, GetFileInfoResponseProto, GetFileLinkInfoResponseProto, 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

Used in: HdfsFileStatusProto

• IS_DIR = 1

• IS_FILE = 2

• IS_SYMLINK = 3

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

Used in: AddBlockResponseProto, AppendResponseProto, GetAdditionalDatanodeResponseProto, LocatedBlocksProto, RecoveringBlockProto, 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

* 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

* Command sent from one namenode to another namenode.

• required uint32 action = 1

• required NamenodeCommandProto.Type type = 2

• optional CheckpointCommandProto checkpointCmd = 3

Used in: NamenodeCommandProto

• NamenodeCommand = 0

  Base command

• CheckPointCommand = 1

  Check point command

* Information sent by a namenode to identify itself to the primary namenode.

• required string rpcAddress = 1

  host:port of the namenode RPC address

• required string httpAddress = 2

  host:port of the namenode http server

• required StorageInfoProto storageInfo = 3

  Node information

• optional NamenodeRegistrationProto.NamenodeRoleProto role = 4

  Namenode role

Used in: NamenodeRegistrationProto

• NAMENODE = 1

• BACKUP = 2

• CHECKPOINT = 3

* Namespace information that describes namespace on a namenode

Used in: VersionResponseProto

• required string buildVersion = 1

  Software revision version (e.g. an svn or git revision)

• required uint32 unused = 2

  Retained for backward compatibility

• required string blockPoolID = 3

  block pool used by the namespace

• required StorageInfoProto storageInfo = 4

  Node information

• required string softwareVersion = 5

  Software version number (e.g. 2.0.0)

• required BaseHeaderProto header = 1

Used in: BlockOpResponseProto

• required uint32 bytesPerCrc = 1

• required uint64 crcPerBlock = 2

• required bytes md5 = 3

• optional ChecksumTypeProto crcType = 4

• required BaseHeaderProto header = 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

• 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.

• required ClientOperationHeaderProto header = 1

• repeated DatanodeInfoProto targets = 2

• 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

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

• 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

• required sint64 seqno = 1

• repeated Status status = 2

• optional uint64 downstreamAckTimeNanos = 3

* 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.

* Block that needs to be recovered with at a given location

• required uint64 newGenStamp = 1

  New genstamp post recovery

• required LocatedBlockProto block = 2

  Block to be recovered

* Enumeration of editlogs available on a remote namenode

• repeated RemoteEditLogProto logs = 1

* Editlog information with available transactions

Used in: RemoteEditLogManifestProto

• required uint64 startTxId = 1

  Starting available edit log transaction

• required uint64 endTxId = 2

  Ending available edit log transaction

• optional bool isInProgress = 3

* State of a block replica at a datanode

• FINALIZED = 0

  State of a replica when it is not modified

• RBW = 1

  State of replica that is being written to

• RWR = 2

  State of replica that is waiting to be recovered

• RUR = 3

  State of replica that is under recovery

• TEMPORARY = 4

  State of replica that is created for replication

Used in: SetSafeModeRequestProto

• SAFEMODE_LEAVE = 1

• SAFEMODE_ENTER = 2

• SAFEMODE_GET = 3

* Snapshot diff report entry

Used in: SnapshotDiffReportProto

• required bytes fullpath = 1

• required string modificationLabel = 2

* 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

Used in: BlockOpResponseProto, ClientReadStatusProto, DNTransferAckProto, PipelineAckProto

• SUCCESS = 0

• ERROR = 1

• ERROR_CHECKSUM = 2

• ERROR_INVALID = 3

• ERROR_EXISTS = 4

• ERROR_ACCESS_TOKEN = 5

• CHECKSUM_OK = 6

• ERROR_UNSUPPORTED = 7

* Common node information shared by all the nodes in the cluster

Used in: CheckpointSignatureProto, NamenodeRegistrationProto, NamespaceInfoProto

• required uint32 layoutVersion = 1

  Layout version of the file system

• required uint32 namespceID = 2

  File system namespace ID

• required string clusterID = 3

  ID of the cluster

• required uint64 cTime = 4

  File system creation time

* void request

(message has no fields)

* Version response from namenode.

• required NamespaceInfoProto info = 1