ClientNamenodeProtocol.proto 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029
  1. /**
  2. * Licensed to the Apache Software Foundation (ASF) under one
  3. * or more contributor license agreements. See the NOTICE file
  4. * distributed with this work for additional information
  5. * regarding copyright ownership. The ASF licenses this file
  6. * to you under the Apache License, Version 2.0 (the
  7. * "License"); you may not use this file except in compliance
  8. * with the License. You may obtain a copy of the License at
  9. *
  10. * http://www.apache.org/licenses/LICENSE-2.0
  11. *
  12. * Unless required by applicable law or agreed to in writing, software
  13. * distributed under the License is distributed on an "AS IS" BASIS,
  14. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15. * See the License for the specific language governing permissions and
  16. * limitations under the License.
  17. */
  18. /**
  19. * These .proto interfaces are private and stable.
  20. * Please see http://wiki.apache.org/hadoop/Compatibility
  21. * for what changes are allowed for a *stable* .proto interface.
  22. */
  23. option java_package = "org.apache.hadoop.hdfs.protocol.proto";
  24. option java_outer_classname = "ClientNamenodeProtocolProtos";
  25. option java_generic_services = true;
  26. option java_generate_equals_and_hash = true;
  27. package hadoop.hdfs;
  28. import "Security.proto";
  29. import "hdfs.proto";
  30. import "acl.proto";
  31. import "xattr.proto";
  32. import "encryption.proto";
  33. import "inotify.proto";
  34. import "erasurecoding.proto";
  35. /**
  36. * The ClientNamenodeProtocol Service defines the interface between a client
  37. * (as runnign inside a MR Task) and the Namenode.
  38. * See org.apache.hadoop.hdfs.protocol.ClientProtocol for the javadoc
  39. * for each of the methods.
  40. * The exceptions declared in the above class also apply to this protocol.
  41. * Exceptions are unwrapped and thrown by the PB libraries.
  42. */
  43. message GetBlockLocationsRequestProto {
  44. required string src = 1; // file name
  45. required uint64 offset = 2; // range start offset
  46. required uint64 length = 3; // range length
  47. }
  48. message GetBlockLocationsResponseProto {
  49. optional LocatedBlocksProto locations = 1;
  50. }
  51. message GetServerDefaultsRequestProto { // No parameters
  52. }
  53. message GetServerDefaultsResponseProto {
  54. required FsServerDefaultsProto serverDefaults = 1;
  55. }
  56. enum CreateFlagProto {
  57. CREATE = 0x01; // Create a file
  58. OVERWRITE = 0x02; // Truncate/overwrite a file. Same as POSIX O_TRUNC
  59. APPEND = 0x04; // Append to a file
  60. LAZY_PERSIST = 0x10; // File with reduced durability guarantees.
  61. NEW_BLOCK = 0x20; // Write data to a new block when appending
  62. SHOULD_REPLICATE = 0x80; // Enforce to create a replicate file
  63. }
  64. message CreateRequestProto {
  65. required string src = 1;
  66. required FsPermissionProto masked = 2;
  67. required string clientName = 3;
  68. required uint32 createFlag = 4; // bits set using CreateFlag
  69. required bool createParent = 5;
  70. required uint32 replication = 6; // Short: Only 16 bits used
  71. required uint64 blockSize = 7;
  72. repeated CryptoProtocolVersionProto cryptoProtocolVersion = 8;
  73. optional FsPermissionProto unmasked = 9;
  74. optional string ecPolicyName = 10;
  75. }
  76. message CreateResponseProto {
  77. optional HdfsFileStatusProto fs = 1;
  78. }
  79. message AppendRequestProto {
  80. required string src = 1;
  81. required string clientName = 2;
  82. optional uint32 flag = 3; // bits set using CreateFlag
  83. }
  84. message AppendResponseProto {
  85. optional LocatedBlockProto block = 1;
  86. optional HdfsFileStatusProto stat = 2;
  87. }
  88. message SetReplicationRequestProto {
  89. required string src = 1;
  90. required uint32 replication = 2; // Short: Only 16 bits used
  91. }
  92. message SetReplicationResponseProto {
  93. required bool result = 1;
  94. }
  95. message SetStoragePolicyRequestProto {
  96. required string src = 1;
  97. required string policyName = 2;
  98. }
  99. message SetStoragePolicyResponseProto { // void response
  100. }
  101. message UnsetStoragePolicyRequestProto {
  102. required string src = 1;
  103. }
  104. message UnsetStoragePolicyResponseProto {
  105. }
  106. message GetStoragePolicyRequestProto {
  107. required string path = 1;
  108. }
  109. message GetStoragePolicyResponseProto {
  110. required BlockStoragePolicyProto storagePolicy = 1;
  111. }
  112. message GetStoragePoliciesRequestProto { // void request
  113. }
  114. message GetStoragePoliciesResponseProto {
  115. repeated BlockStoragePolicyProto policies = 1;
  116. }
  117. message SetPermissionRequestProto {
  118. required string src = 1;
  119. required FsPermissionProto permission = 2;
  120. }
  121. message SetPermissionResponseProto { // void response
  122. }
  123. message SetOwnerRequestProto {
  124. required string src = 1;
  125. optional string username = 2;
  126. optional string groupname = 3;
  127. }
  128. message SetOwnerResponseProto { // void response
  129. }
  130. message AbandonBlockRequestProto {
  131. required ExtendedBlockProto b = 1;
  132. required string src = 2;
  133. required string holder = 3;
  134. optional uint64 fileId = 4 [default = 0]; // default to GRANDFATHER_INODE_ID
  135. }
  136. message AbandonBlockResponseProto { // void response
  137. }
  138. enum AddBlockFlagProto {
  139. NO_LOCAL_WRITE = 1; // avoid writing to local node.
  140. IGNORE_CLIENT_LOCALITY = 2; // write to a random node
  141. }
  142. message AddBlockRequestProto {
  143. required string src = 1;
  144. required string clientName = 2;
  145. optional ExtendedBlockProto previous = 3;
  146. repeated DatanodeInfoProto excludeNodes = 4;
  147. optional uint64 fileId = 5 [default = 0]; // default as a bogus id
  148. repeated string favoredNodes = 6; //the set of datanodes to use for the block
  149. repeated AddBlockFlagProto flags = 7; // default to empty.
  150. }
  151. message AddBlockResponseProto {
  152. required LocatedBlockProto block = 1;
  153. }
  154. message GetAdditionalDatanodeRequestProto {
  155. required string src = 1;
  156. required ExtendedBlockProto blk = 2;
  157. repeated DatanodeInfoProto existings = 3;
  158. repeated DatanodeInfoProto excludes = 4;
  159. required uint32 numAdditionalNodes = 5;
  160. required string clientName = 6;
  161. repeated string existingStorageUuids = 7;
  162. optional uint64 fileId = 8 [default = 0]; // default to GRANDFATHER_INODE_ID
  163. }
  164. message GetAdditionalDatanodeResponseProto {
  165. required LocatedBlockProto block = 1;
  166. }
  167. message CompleteRequestProto {
  168. required string src = 1;
  169. required string clientName = 2;
  170. optional ExtendedBlockProto last = 3;
  171. optional uint64 fileId = 4 [default = 0]; // default to GRANDFATHER_INODE_ID
  172. }
  173. message CompleteResponseProto {
  174. required bool result = 1;
  175. }
  176. message ReportBadBlocksRequestProto {
  177. repeated LocatedBlockProto blocks = 1;
  178. }
  179. message ReportBadBlocksResponseProto { // void response
  180. }
  181. message ConcatRequestProto {
  182. required string trg = 1;
  183. repeated string srcs = 2;
  184. }
  185. message ConcatResponseProto { // void response
  186. }
  187. message TruncateRequestProto {
  188. required string src = 1;
  189. required uint64 newLength = 2;
  190. required string clientName = 3;
  191. }
  192. message TruncateResponseProto {
  193. required bool result = 1;
  194. }
  195. message RenameRequestProto {
  196. required string src = 1;
  197. required string dst = 2;
  198. }
  199. message RenameResponseProto {
  200. required bool result = 1;
  201. }
  202. message Rename2RequestProto {
  203. required string src = 1;
  204. required string dst = 2;
  205. required bool overwriteDest = 3;
  206. optional bool moveToTrash = 4;
  207. }
  208. message Rename2ResponseProto { // void response
  209. }
  210. message DeleteRequestProto {
  211. required string src = 1;
  212. required bool recursive = 2;
  213. }
  214. message DeleteResponseProto {
  215. required bool result = 1;
  216. }
  217. message MkdirsRequestProto {
  218. required string src = 1;
  219. required FsPermissionProto masked = 2;
  220. required bool createParent = 3;
  221. optional FsPermissionProto unmasked = 4;
  222. }
  223. message MkdirsResponseProto {
  224. required bool result = 1;
  225. }
  226. message GetListingRequestProto {
  227. required string src = 1;
  228. required bytes startAfter = 2;
  229. required bool needLocation = 3;
  230. }
  231. message GetListingResponseProto {
  232. optional DirectoryListingProto dirList = 1;
  233. }
  234. message GetSnapshottableDirListingRequestProto { // no input parameters
  235. }
  236. message GetSnapshottableDirListingResponseProto {
  237. optional SnapshottableDirectoryListingProto snapshottableDirList = 1;
  238. }
  239. message GetSnapshotDiffReportRequestProto {
  240. required string snapshotRoot = 1;
  241. required string fromSnapshot = 2;
  242. required string toSnapshot = 3;
  243. }
  244. message GetSnapshotDiffReportResponseProto {
  245. required SnapshotDiffReportProto diffReport = 1;
  246. }
  247. message GetSnapshotDiffReportListingRequestProto {
  248. required string snapshotRoot = 1;
  249. required string fromSnapshot = 2;
  250. required string toSnapshot = 3;
  251. optional SnapshotDiffReportCursorProto cursor = 4;
  252. }
  253. message GetSnapshotDiffReportListingResponseProto {
  254. required SnapshotDiffReportListingProto diffReport = 1;
  255. }
  256. message RenewLeaseRequestProto {
  257. required string clientName = 1;
  258. }
  259. message RenewLeaseResponseProto { //void response
  260. }
  261. message RecoverLeaseRequestProto {
  262. required string src = 1;
  263. required string clientName = 2;
  264. }
  265. message RecoverLeaseResponseProto {
  266. required bool result = 1;
  267. }
  268. message GetFsStatusRequestProto { // no input paramters
  269. }
  270. message GetFsStatsResponseProto {
  271. required uint64 capacity = 1;
  272. required uint64 used = 2;
  273. required uint64 remaining = 3;
  274. required uint64 under_replicated = 4;
  275. required uint64 corrupt_blocks = 5;
  276. required uint64 missing_blocks = 6;
  277. optional uint64 missing_repl_one_blocks = 7;
  278. optional uint64 blocks_in_future = 8;
  279. optional uint64 pending_deletion_blocks = 9;
  280. }
  281. message GetFsReplicatedBlockStatsRequestProto { // no input paramters
  282. }
  283. message GetFsReplicatedBlockStatsResponseProto {
  284. required uint64 low_redundancy = 1;
  285. required uint64 corrupt_blocks = 2;
  286. required uint64 missing_blocks = 3;
  287. required uint64 missing_repl_one_blocks = 4;
  288. required uint64 blocks_in_future = 5;
  289. required uint64 pending_deletion_blocks = 6;
  290. optional uint64 highest_prio_low_redundancy_blocks = 7;
  291. }
  292. message GetFsECBlockGroupStatsRequestProto { // no input paramters
  293. }
  294. message GetFsECBlockGroupStatsResponseProto {
  295. required uint64 low_redundancy = 1;
  296. required uint64 corrupt_blocks = 2;
  297. required uint64 missing_blocks = 3;
  298. required uint64 blocks_in_future = 4;
  299. required uint64 pending_deletion_blocks = 5;
  300. optional uint64 highest_prio_low_redundancy_blocks = 6;
  301. }
  302. enum DatanodeReportTypeProto { // type of the datanode report
  303. ALL = 1;
  304. LIVE = 2;
  305. DEAD = 3;
  306. DECOMMISSIONING = 4;
  307. ENTERING_MAINTENANCE = 5;
  308. IN_MAINTENANCE = 6;
  309. }
  310. message GetDatanodeReportRequestProto {
  311. required DatanodeReportTypeProto type = 1;
  312. }
  313. message GetDatanodeReportResponseProto {
  314. repeated DatanodeInfoProto di = 1;
  315. }
  316. message GetDatanodeStorageReportRequestProto {
  317. required DatanodeReportTypeProto type = 1;
  318. }
  319. message DatanodeStorageReportProto {
  320. required DatanodeInfoProto datanodeInfo = 1;
  321. repeated StorageReportProto storageReports = 2;
  322. }
  323. message GetDatanodeStorageReportResponseProto {
  324. repeated DatanodeStorageReportProto datanodeStorageReports = 1;
  325. }
  326. message GetPreferredBlockSizeRequestProto {
  327. required string filename = 1;
  328. }
  329. message GetPreferredBlockSizeResponseProto {
  330. required uint64 bsize = 1;
  331. }
  332. enum SafeModeActionProto {
  333. SAFEMODE_LEAVE = 1;
  334. SAFEMODE_ENTER = 2;
  335. SAFEMODE_GET = 3;
  336. SAFEMODE_FORCE_EXIT = 4;
  337. }
  338. message SetSafeModeRequestProto {
  339. required SafeModeActionProto action = 1;
  340. optional bool checked = 2 [default = false];
  341. }
  342. message SetSafeModeResponseProto {
  343. required bool result = 1;
  344. }
  345. message SaveNamespaceRequestProto {
  346. optional uint64 timeWindow = 1 [default = 0];
  347. optional uint64 txGap = 2 [default = 0];
  348. }
  349. message SaveNamespaceResponseProto { // void response
  350. optional bool saved = 1 [default = true];
  351. }
  352. message RollEditsRequestProto { // no parameters
  353. }
  354. message RollEditsResponseProto { // response
  355. required uint64 newSegmentTxId = 1;
  356. }
  357. message RestoreFailedStorageRequestProto {
  358. required string arg = 1;
  359. }
  360. message RestoreFailedStorageResponseProto {
  361. required bool result = 1;
  362. }
  363. message RefreshNodesRequestProto { // no parameters
  364. }
  365. message RefreshNodesResponseProto { // void response
  366. }
  367. message FinalizeUpgradeRequestProto { // no parameters
  368. }
  369. message FinalizeUpgradeResponseProto { // void response
  370. }
  371. message UpgradeStatusRequestProto { // no parameters
  372. }
  373. message UpgradeStatusResponseProto {
  374. required bool upgradeFinalized = 1;
  375. }
  376. enum RollingUpgradeActionProto {
  377. QUERY = 1;
  378. START = 2;
  379. FINALIZE = 3;
  380. }
  381. message RollingUpgradeRequestProto {
  382. required RollingUpgradeActionProto action = 1;
  383. }
  384. message RollingUpgradeInfoProto {
  385. required RollingUpgradeStatusProto status = 1;
  386. required uint64 startTime = 2;
  387. required uint64 finalizeTime = 3;
  388. required bool createdRollbackImages = 4;
  389. }
  390. message RollingUpgradeResponseProto {
  391. optional RollingUpgradeInfoProto rollingUpgradeInfo= 1;
  392. }
  393. message ListCorruptFileBlocksRequestProto {
  394. required string path = 1;
  395. optional string cookie = 2;
  396. }
  397. message ListCorruptFileBlocksResponseProto {
  398. required CorruptFileBlocksProto corrupt = 1;
  399. }
  400. message MetaSaveRequestProto {
  401. required string filename = 1;
  402. }
  403. message MetaSaveResponseProto { // void response
  404. }
  405. message GetFileInfoRequestProto {
  406. required string src = 1;
  407. }
  408. message GetFileInfoResponseProto {
  409. optional HdfsFileStatusProto fs = 1;
  410. }
  411. message GetLocatedFileInfoRequestProto {
  412. optional string src = 1;
  413. optional bool needBlockToken = 2 [default = false];
  414. }
  415. message GetLocatedFileInfoResponseProto {
  416. optional HdfsFileStatusProto fs = 1;
  417. }
  418. message IsFileClosedRequestProto {
  419. required string src = 1;
  420. }
  421. message IsFileClosedResponseProto {
  422. required bool result = 1;
  423. }
  424. message CacheDirectiveInfoProto {
  425. optional int64 id = 1;
  426. optional string path = 2;
  427. optional uint32 replication = 3;
  428. optional string pool = 4;
  429. optional CacheDirectiveInfoExpirationProto expiration = 5;
  430. }
  431. message CacheDirectiveInfoExpirationProto {
  432. required int64 millis = 1;
  433. required bool isRelative = 2;
  434. }
  435. message CacheDirectiveStatsProto {
  436. required int64 bytesNeeded = 1;
  437. required int64 bytesCached = 2;
  438. required int64 filesNeeded = 3;
  439. required int64 filesCached = 4;
  440. required bool hasExpired = 5;
  441. }
  442. enum CacheFlagProto {
  443. FORCE = 0x01; // Ignore pool resource limits
  444. }
  445. message AddCacheDirectiveRequestProto {
  446. required CacheDirectiveInfoProto info = 1;
  447. optional uint32 cacheFlags = 2; // bits set using CacheFlag
  448. }
  449. message AddCacheDirectiveResponseProto {
  450. required int64 id = 1;
  451. }
  452. message ModifyCacheDirectiveRequestProto {
  453. required CacheDirectiveInfoProto info = 1;
  454. optional uint32 cacheFlags = 2; // bits set using CacheFlag
  455. }
  456. message ModifyCacheDirectiveResponseProto {
  457. }
  458. message RemoveCacheDirectiveRequestProto {
  459. required int64 id = 1;
  460. }
  461. message RemoveCacheDirectiveResponseProto {
  462. }
  463. message ListCacheDirectivesRequestProto {
  464. required int64 prevId = 1;
  465. required CacheDirectiveInfoProto filter = 2;
  466. }
  467. message CacheDirectiveEntryProto {
  468. required CacheDirectiveInfoProto info = 1;
  469. required CacheDirectiveStatsProto stats = 2;
  470. }
  471. message ListCacheDirectivesResponseProto {
  472. repeated CacheDirectiveEntryProto elements = 1;
  473. required bool hasMore = 2;
  474. }
  475. message CachePoolInfoProto {
  476. optional string poolName = 1;
  477. optional string ownerName = 2;
  478. optional string groupName = 3;
  479. optional int32 mode = 4;
  480. optional int64 limit = 5;
  481. optional int64 maxRelativeExpiry = 6;
  482. optional uint32 defaultReplication = 7 [default=1];
  483. }
  484. message CachePoolStatsProto {
  485. required int64 bytesNeeded = 1;
  486. required int64 bytesCached = 2;
  487. required int64 bytesOverlimit = 3;
  488. required int64 filesNeeded = 4;
  489. required int64 filesCached = 5;
  490. }
  491. message AddCachePoolRequestProto {
  492. required CachePoolInfoProto info = 1;
  493. }
  494. message AddCachePoolResponseProto { // void response
  495. }
  496. message ModifyCachePoolRequestProto {
  497. required CachePoolInfoProto info = 1;
  498. }
  499. message ModifyCachePoolResponseProto { // void response
  500. }
  501. message RemoveCachePoolRequestProto {
  502. required string poolName = 1;
  503. }
  504. message RemoveCachePoolResponseProto { // void response
  505. }
  506. message ListCachePoolsRequestProto {
  507. required string prevPoolName = 1;
  508. }
  509. message ListCachePoolsResponseProto {
  510. repeated CachePoolEntryProto entries = 1;
  511. required bool hasMore = 2;
  512. }
  513. message CachePoolEntryProto {
  514. required CachePoolInfoProto info = 1;
  515. required CachePoolStatsProto stats = 2;
  516. }
  517. message GetFileLinkInfoRequestProto {
  518. required string src = 1;
  519. }
  520. message GetFileLinkInfoResponseProto {
  521. optional HdfsFileStatusProto fs = 1;
  522. }
  523. message GetContentSummaryRequestProto {
  524. required string path = 1;
  525. }
  526. message GetContentSummaryResponseProto {
  527. required ContentSummaryProto summary = 1;
  528. }
  529. message GetQuotaUsageRequestProto {
  530. required string path = 1;
  531. }
  532. message GetQuotaUsageResponseProto {
  533. required QuotaUsageProto usage = 1;
  534. }
  535. message SetQuotaRequestProto {
  536. required string path = 1;
  537. required uint64 namespaceQuota = 2;
  538. required uint64 storagespaceQuota = 3;
  539. optional StorageTypeProto storageType = 4;
  540. }
  541. message SetQuotaResponseProto { // void response
  542. }
  543. message FsyncRequestProto {
  544. required string src = 1;
  545. required string client = 2;
  546. optional sint64 lastBlockLength = 3 [default = -1];
  547. optional uint64 fileId = 4 [default = 0]; // default to GRANDFATHER_INODE_ID
  548. }
  549. message FsyncResponseProto { // void response
  550. }
  551. message SetTimesRequestProto {
  552. required string src = 1;
  553. required uint64 mtime = 2;
  554. required uint64 atime = 3;
  555. }
  556. message SetTimesResponseProto { // void response
  557. }
  558. message CreateSymlinkRequestProto {
  559. required string target = 1;
  560. required string link = 2;
  561. required FsPermissionProto dirPerm = 3;
  562. required bool createParent = 4;
  563. }
  564. message CreateSymlinkResponseProto { // void response
  565. }
  566. message GetLinkTargetRequestProto {
  567. required string path = 1;
  568. }
  569. message GetLinkTargetResponseProto {
  570. optional string targetPath = 1;
  571. }
  572. message UpdateBlockForPipelineRequestProto {
  573. required ExtendedBlockProto block = 1;
  574. required string clientName = 2;
  575. }
  576. message UpdateBlockForPipelineResponseProto {
  577. required LocatedBlockProto block = 1;
  578. }
  579. message UpdatePipelineRequestProto {
  580. required string clientName = 1;
  581. required ExtendedBlockProto oldBlock = 2;
  582. required ExtendedBlockProto newBlock = 3;
  583. repeated DatanodeIDProto newNodes = 4;
  584. repeated string storageIDs = 5;
  585. }
  586. message UpdatePipelineResponseProto { // void response
  587. }
  588. message SetBalancerBandwidthRequestProto {
  589. required int64 bandwidth = 1;
  590. }
  591. message SetBalancerBandwidthResponseProto { // void response
  592. }
  593. message GetDataEncryptionKeyRequestProto { // no parameters
  594. }
  595. message GetDataEncryptionKeyResponseProto {
  596. optional DataEncryptionKeyProto dataEncryptionKey = 1;
  597. }
  598. message CreateSnapshotRequestProto {
  599. required string snapshotRoot = 1;
  600. optional string snapshotName = 2;
  601. }
  602. message CreateSnapshotResponseProto {
  603. required string snapshotPath = 1;
  604. }
  605. message RenameSnapshotRequestProto {
  606. required string snapshotRoot = 1;
  607. required string snapshotOldName = 2;
  608. required string snapshotNewName = 3;
  609. }
  610. message RenameSnapshotResponseProto { // void response
  611. }
  612. message AllowSnapshotRequestProto {
  613. required string snapshotRoot = 1;
  614. }
  615. message AllowSnapshotResponseProto {
  616. }
  617. message DisallowSnapshotRequestProto {
  618. required string snapshotRoot = 1;
  619. }
  620. message DisallowSnapshotResponseProto {
  621. }
  622. message DeleteSnapshotRequestProto {
  623. required string snapshotRoot = 1;
  624. required string snapshotName = 2;
  625. }
  626. message DeleteSnapshotResponseProto { // void response
  627. }
  628. message CheckAccessRequestProto {
  629. required string path = 1;
  630. required AclEntryProto.FsActionProto mode = 2;
  631. }
  632. message CheckAccessResponseProto { // void response
  633. }
  634. message GetCurrentEditLogTxidRequestProto {
  635. }
  636. message GetCurrentEditLogTxidResponseProto {
  637. required int64 txid = 1;
  638. }
  639. message GetEditsFromTxidRequestProto {
  640. required int64 txid = 1;
  641. }
  642. message GetEditsFromTxidResponseProto {
  643. required EventsListProto eventsList = 1;
  644. }
  645. enum OpenFilesTypeProto {
  646. ALL_OPEN_FILES = 1;
  647. BLOCKING_DECOMMISSION = 2;
  648. }
  649. message ListOpenFilesRequestProto {
  650. required int64 id = 1;
  651. repeated OpenFilesTypeProto types = 2;
  652. optional string path = 3;
  653. }
  654. message OpenFilesBatchResponseProto {
  655. required int64 id = 1;
  656. required string path = 2;
  657. required string clientName = 3;
  658. required string clientMachine = 4;
  659. }
  660. message ListOpenFilesResponseProto {
  661. repeated OpenFilesBatchResponseProto entries = 1;
  662. required bool hasMore = 2;
  663. repeated OpenFilesTypeProto types = 3;
  664. }
  665. message SatisfyStoragePolicyRequestProto {
  666. required string src = 1;
  667. }
  668. message SatisfyStoragePolicyResponseProto {
  669. }
  670. service ClientNamenodeProtocol {
  671. rpc getBlockLocations(GetBlockLocationsRequestProto)
  672. returns(GetBlockLocationsResponseProto);
  673. rpc getServerDefaults(GetServerDefaultsRequestProto)
  674. returns(GetServerDefaultsResponseProto);
  675. rpc create(CreateRequestProto)returns(CreateResponseProto);
  676. rpc append(AppendRequestProto) returns(AppendResponseProto);
  677. rpc setReplication(SetReplicationRequestProto)
  678. returns(SetReplicationResponseProto);
  679. rpc setStoragePolicy(SetStoragePolicyRequestProto)
  680. returns(SetStoragePolicyResponseProto);
  681. rpc unsetStoragePolicy(UnsetStoragePolicyRequestProto)
  682. returns(UnsetStoragePolicyResponseProto);
  683. rpc getStoragePolicy(GetStoragePolicyRequestProto)
  684. returns(GetStoragePolicyResponseProto);
  685. rpc getStoragePolicies(GetStoragePoliciesRequestProto)
  686. returns(GetStoragePoliciesResponseProto);
  687. rpc setPermission(SetPermissionRequestProto)
  688. returns(SetPermissionResponseProto);
  689. rpc setOwner(SetOwnerRequestProto) returns(SetOwnerResponseProto);
  690. rpc abandonBlock(AbandonBlockRequestProto) returns(AbandonBlockResponseProto);
  691. rpc addBlock(AddBlockRequestProto) returns(AddBlockResponseProto);
  692. rpc getAdditionalDatanode(GetAdditionalDatanodeRequestProto)
  693. returns(GetAdditionalDatanodeResponseProto);
  694. rpc complete(CompleteRequestProto) returns(CompleteResponseProto);
  695. rpc reportBadBlocks(ReportBadBlocksRequestProto)
  696. returns(ReportBadBlocksResponseProto);
  697. rpc concat(ConcatRequestProto) returns(ConcatResponseProto);
  698. rpc truncate(TruncateRequestProto) returns(TruncateResponseProto);
  699. rpc rename(RenameRequestProto) returns(RenameResponseProto);
  700. rpc rename2(Rename2RequestProto) returns(Rename2ResponseProto);
  701. rpc delete(DeleteRequestProto) returns(DeleteResponseProto);
  702. rpc mkdirs(MkdirsRequestProto) returns(MkdirsResponseProto);
  703. rpc getListing(GetListingRequestProto) returns(GetListingResponseProto);
  704. rpc renewLease(RenewLeaseRequestProto) returns(RenewLeaseResponseProto);
  705. rpc recoverLease(RecoverLeaseRequestProto)
  706. returns(RecoverLeaseResponseProto);
  707. rpc getFsStats(GetFsStatusRequestProto) returns(GetFsStatsResponseProto);
  708. rpc getFsReplicatedBlockStats(GetFsReplicatedBlockStatsRequestProto)
  709. returns (GetFsReplicatedBlockStatsResponseProto);
  710. rpc getFsECBlockGroupStats(GetFsECBlockGroupStatsRequestProto)
  711. returns (GetFsECBlockGroupStatsResponseProto);
  712. rpc getDatanodeReport(GetDatanodeReportRequestProto)
  713. returns(GetDatanodeReportResponseProto);
  714. rpc getDatanodeStorageReport(GetDatanodeStorageReportRequestProto)
  715. returns(GetDatanodeStorageReportResponseProto);
  716. rpc getPreferredBlockSize(GetPreferredBlockSizeRequestProto)
  717. returns(GetPreferredBlockSizeResponseProto);
  718. rpc setSafeMode(SetSafeModeRequestProto)
  719. returns(SetSafeModeResponseProto);
  720. rpc saveNamespace(SaveNamespaceRequestProto)
  721. returns(SaveNamespaceResponseProto);
  722. rpc rollEdits(RollEditsRequestProto)
  723. returns(RollEditsResponseProto);
  724. rpc restoreFailedStorage(RestoreFailedStorageRequestProto)
  725. returns(RestoreFailedStorageResponseProto);
  726. rpc refreshNodes(RefreshNodesRequestProto) returns(RefreshNodesResponseProto);
  727. rpc finalizeUpgrade(FinalizeUpgradeRequestProto)
  728. returns(FinalizeUpgradeResponseProto);
  729. rpc upgradeStatus(UpgradeStatusRequestProto)
  730. returns(UpgradeStatusResponseProto);
  731. rpc rollingUpgrade(RollingUpgradeRequestProto)
  732. returns(RollingUpgradeResponseProto);
  733. rpc listCorruptFileBlocks(ListCorruptFileBlocksRequestProto)
  734. returns(ListCorruptFileBlocksResponseProto);
  735. rpc metaSave(MetaSaveRequestProto) returns(MetaSaveResponseProto);
  736. rpc getFileInfo(GetFileInfoRequestProto) returns(GetFileInfoResponseProto);
  737. rpc getLocatedFileInfo(GetLocatedFileInfoRequestProto)
  738. returns(GetLocatedFileInfoResponseProto);
  739. rpc addCacheDirective(AddCacheDirectiveRequestProto)
  740. returns (AddCacheDirectiveResponseProto);
  741. rpc modifyCacheDirective(ModifyCacheDirectiveRequestProto)
  742. returns (ModifyCacheDirectiveResponseProto);
  743. rpc removeCacheDirective(RemoveCacheDirectiveRequestProto)
  744. returns (RemoveCacheDirectiveResponseProto);
  745. rpc listCacheDirectives(ListCacheDirectivesRequestProto)
  746. returns (ListCacheDirectivesResponseProto);
  747. rpc addCachePool(AddCachePoolRequestProto)
  748. returns(AddCachePoolResponseProto);
  749. rpc modifyCachePool(ModifyCachePoolRequestProto)
  750. returns(ModifyCachePoolResponseProto);
  751. rpc removeCachePool(RemoveCachePoolRequestProto)
  752. returns(RemoveCachePoolResponseProto);
  753. rpc listCachePools(ListCachePoolsRequestProto)
  754. returns(ListCachePoolsResponseProto);
  755. rpc getFileLinkInfo(GetFileLinkInfoRequestProto)
  756. returns(GetFileLinkInfoResponseProto);
  757. rpc getContentSummary(GetContentSummaryRequestProto)
  758. returns(GetContentSummaryResponseProto);
  759. rpc setQuota(SetQuotaRequestProto) returns(SetQuotaResponseProto);
  760. rpc fsync(FsyncRequestProto) returns(FsyncResponseProto);
  761. rpc setTimes(SetTimesRequestProto) returns(SetTimesResponseProto);
  762. rpc createSymlink(CreateSymlinkRequestProto)
  763. returns(CreateSymlinkResponseProto);
  764. rpc getLinkTarget(GetLinkTargetRequestProto)
  765. returns(GetLinkTargetResponseProto);
  766. rpc updateBlockForPipeline(UpdateBlockForPipelineRequestProto)
  767. returns(UpdateBlockForPipelineResponseProto);
  768. rpc updatePipeline(UpdatePipelineRequestProto)
  769. returns(UpdatePipelineResponseProto);
  770. rpc getDelegationToken(hadoop.common.GetDelegationTokenRequestProto)
  771. returns(hadoop.common.GetDelegationTokenResponseProto);
  772. rpc renewDelegationToken(hadoop.common.RenewDelegationTokenRequestProto)
  773. returns(hadoop.common.RenewDelegationTokenResponseProto);
  774. rpc cancelDelegationToken(hadoop.common.CancelDelegationTokenRequestProto)
  775. returns(hadoop.common.CancelDelegationTokenResponseProto);
  776. rpc setBalancerBandwidth(SetBalancerBandwidthRequestProto)
  777. returns(SetBalancerBandwidthResponseProto);
  778. rpc getDataEncryptionKey(GetDataEncryptionKeyRequestProto)
  779. returns(GetDataEncryptionKeyResponseProto);
  780. rpc createSnapshot(CreateSnapshotRequestProto)
  781. returns(CreateSnapshotResponseProto);
  782. rpc renameSnapshot(RenameSnapshotRequestProto)
  783. returns(RenameSnapshotResponseProto);
  784. rpc allowSnapshot(AllowSnapshotRequestProto)
  785. returns(AllowSnapshotResponseProto);
  786. rpc disallowSnapshot(DisallowSnapshotRequestProto)
  787. returns(DisallowSnapshotResponseProto);
  788. rpc getSnapshottableDirListing(GetSnapshottableDirListingRequestProto)
  789. returns(GetSnapshottableDirListingResponseProto);
  790. rpc deleteSnapshot(DeleteSnapshotRequestProto)
  791. returns(DeleteSnapshotResponseProto);
  792. rpc getSnapshotDiffReport(GetSnapshotDiffReportRequestProto)
  793. returns(GetSnapshotDiffReportResponseProto);
  794. rpc getSnapshotDiffReportListing(GetSnapshotDiffReportListingRequestProto)
  795. returns(GetSnapshotDiffReportListingResponseProto);
  796. rpc isFileClosed(IsFileClosedRequestProto)
  797. returns(IsFileClosedResponseProto);
  798. rpc modifyAclEntries(ModifyAclEntriesRequestProto)
  799. returns(ModifyAclEntriesResponseProto);
  800. rpc removeAclEntries(RemoveAclEntriesRequestProto)
  801. returns(RemoveAclEntriesResponseProto);
  802. rpc removeDefaultAcl(RemoveDefaultAclRequestProto)
  803. returns(RemoveDefaultAclResponseProto);
  804. rpc removeAcl(RemoveAclRequestProto)
  805. returns(RemoveAclResponseProto);
  806. rpc setAcl(SetAclRequestProto)
  807. returns(SetAclResponseProto);
  808. rpc getAclStatus(GetAclStatusRequestProto)
  809. returns(GetAclStatusResponseProto);
  810. rpc setXAttr(SetXAttrRequestProto)
  811. returns(SetXAttrResponseProto);
  812. rpc getXAttrs(GetXAttrsRequestProto)
  813. returns(GetXAttrsResponseProto);
  814. rpc listXAttrs(ListXAttrsRequestProto)
  815. returns(ListXAttrsResponseProto);
  816. rpc removeXAttr(RemoveXAttrRequestProto)
  817. returns(RemoveXAttrResponseProto);
  818. rpc checkAccess(CheckAccessRequestProto)
  819. returns(CheckAccessResponseProto);
  820. rpc createEncryptionZone(CreateEncryptionZoneRequestProto)
  821. returns(CreateEncryptionZoneResponseProto);
  822. rpc listEncryptionZones(ListEncryptionZonesRequestProto)
  823. returns(ListEncryptionZonesResponseProto);
  824. rpc reencryptEncryptionZone(ReencryptEncryptionZoneRequestProto)
  825. returns(ReencryptEncryptionZoneResponseProto);
  826. rpc listReencryptionStatus(ListReencryptionStatusRequestProto)
  827. returns(ListReencryptionStatusResponseProto);
  828. rpc getEZForPath(GetEZForPathRequestProto)
  829. returns(GetEZForPathResponseProto);
  830. rpc setErasureCodingPolicy(SetErasureCodingPolicyRequestProto)
  831. returns(SetErasureCodingPolicyResponseProto);
  832. rpc unsetErasureCodingPolicy(UnsetErasureCodingPolicyRequestProto)
  833. returns(UnsetErasureCodingPolicyResponseProto);
  834. rpc getCurrentEditLogTxid(GetCurrentEditLogTxidRequestProto)
  835. returns(GetCurrentEditLogTxidResponseProto);
  836. rpc getEditsFromTxid(GetEditsFromTxidRequestProto)
  837. returns(GetEditsFromTxidResponseProto);
  838. rpc getErasureCodingPolicies(GetErasureCodingPoliciesRequestProto)
  839. returns(GetErasureCodingPoliciesResponseProto);
  840. rpc addErasureCodingPolicies(AddErasureCodingPoliciesRequestProto)
  841. returns(AddErasureCodingPoliciesResponseProto);
  842. rpc removeErasureCodingPolicy(RemoveErasureCodingPolicyRequestProto)
  843. returns(RemoveErasureCodingPolicyResponseProto);
  844. rpc enableErasureCodingPolicy(EnableErasureCodingPolicyRequestProto)
  845. returns(EnableErasureCodingPolicyResponseProto);
  846. rpc disableErasureCodingPolicy(DisableErasureCodingPolicyRequestProto)
  847. returns(DisableErasureCodingPolicyResponseProto);
  848. rpc getErasureCodingPolicy(GetErasureCodingPolicyRequestProto)
  849. returns(GetErasureCodingPolicyResponseProto);
  850. rpc getErasureCodingCodecs(GetErasureCodingCodecsRequestProto)
  851. returns(GetErasureCodingCodecsResponseProto);
  852. rpc getQuotaUsage(GetQuotaUsageRequestProto)
  853. returns(GetQuotaUsageResponseProto);
  854. rpc listOpenFiles(ListOpenFilesRequestProto)
  855. returns(ListOpenFilesResponseProto);
  856. rpc satisfyStoragePolicy(SatisfyStoragePolicyRequestProto)
  857. returns(SatisfyStoragePolicyResponseProto);
  858. }