ClientNamenodeProtocol.proto 29 KB

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