ClientNamenodeProtocol.proto 30 KB

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