ClientNamenodeProtocol.proto 29 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016
  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. message UpgradeStatusRequestProto { // no parameters
  369. }
  370. message UpgradeStatusResponseProto {
  371. required bool upgradeFinalized = 1;
  372. }
  373. enum RollingUpgradeActionProto {
  374. QUERY = 1;
  375. START = 2;
  376. FINALIZE = 3;
  377. }
  378. message RollingUpgradeRequestProto {
  379. required RollingUpgradeActionProto action = 1;
  380. }
  381. message RollingUpgradeInfoProto {
  382. required RollingUpgradeStatusProto status = 1;
  383. required uint64 startTime = 2;
  384. required uint64 finalizeTime = 3;
  385. required bool createdRollbackImages = 4;
  386. }
  387. message RollingUpgradeResponseProto {
  388. optional RollingUpgradeInfoProto rollingUpgradeInfo= 1;
  389. }
  390. message ListCorruptFileBlocksRequestProto {
  391. required string path = 1;
  392. optional string cookie = 2;
  393. }
  394. message ListCorruptFileBlocksResponseProto {
  395. required CorruptFileBlocksProto corrupt = 1;
  396. }
  397. message MetaSaveRequestProto {
  398. required string filename = 1;
  399. }
  400. message MetaSaveResponseProto { // void response
  401. }
  402. message GetFileInfoRequestProto {
  403. required string src = 1;
  404. }
  405. message GetFileInfoResponseProto {
  406. optional HdfsFileStatusProto fs = 1;
  407. }
  408. message GetLocatedFileInfoRequestProto {
  409. optional string src = 1;
  410. optional bool needBlockToken = 2 [default = false];
  411. }
  412. message GetLocatedFileInfoResponseProto {
  413. optional HdfsFileStatusProto fs = 1;
  414. }
  415. message IsFileClosedRequestProto {
  416. required string src = 1;
  417. }
  418. message IsFileClosedResponseProto {
  419. required bool result = 1;
  420. }
  421. message CacheDirectiveInfoProto {
  422. optional int64 id = 1;
  423. optional string path = 2;
  424. optional uint32 replication = 3;
  425. optional string pool = 4;
  426. optional CacheDirectiveInfoExpirationProto expiration = 5;
  427. }
  428. message CacheDirectiveInfoExpirationProto {
  429. required int64 millis = 1;
  430. required bool isRelative = 2;
  431. }
  432. message CacheDirectiveStatsProto {
  433. required int64 bytesNeeded = 1;
  434. required int64 bytesCached = 2;
  435. required int64 filesNeeded = 3;
  436. required int64 filesCached = 4;
  437. required bool hasExpired = 5;
  438. }
  439. enum CacheFlagProto {
  440. FORCE = 0x01; // Ignore pool resource limits
  441. }
  442. message AddCacheDirectiveRequestProto {
  443. required CacheDirectiveInfoProto info = 1;
  444. optional uint32 cacheFlags = 2; // bits set using CacheFlag
  445. }
  446. message AddCacheDirectiveResponseProto {
  447. required int64 id = 1;
  448. }
  449. message ModifyCacheDirectiveRequestProto {
  450. required CacheDirectiveInfoProto info = 1;
  451. optional uint32 cacheFlags = 2; // bits set using CacheFlag
  452. }
  453. message ModifyCacheDirectiveResponseProto {
  454. }
  455. message RemoveCacheDirectiveRequestProto {
  456. required int64 id = 1;
  457. }
  458. message RemoveCacheDirectiveResponseProto {
  459. }
  460. message ListCacheDirectivesRequestProto {
  461. required int64 prevId = 1;
  462. required CacheDirectiveInfoProto filter = 2;
  463. }
  464. message CacheDirectiveEntryProto {
  465. required CacheDirectiveInfoProto info = 1;
  466. required CacheDirectiveStatsProto stats = 2;
  467. }
  468. message ListCacheDirectivesResponseProto {
  469. repeated CacheDirectiveEntryProto elements = 1;
  470. required bool hasMore = 2;
  471. }
  472. message CachePoolInfoProto {
  473. optional string poolName = 1;
  474. optional string ownerName = 2;
  475. optional string groupName = 3;
  476. optional int32 mode = 4;
  477. optional int64 limit = 5;
  478. optional int64 maxRelativeExpiry = 6;
  479. optional uint32 defaultReplication = 7 [default=1];
  480. }
  481. message CachePoolStatsProto {
  482. required int64 bytesNeeded = 1;
  483. required int64 bytesCached = 2;
  484. required int64 bytesOverlimit = 3;
  485. required int64 filesNeeded = 4;
  486. required int64 filesCached = 5;
  487. }
  488. message AddCachePoolRequestProto {
  489. required CachePoolInfoProto info = 1;
  490. }
  491. message AddCachePoolResponseProto { // void response
  492. }
  493. message ModifyCachePoolRequestProto {
  494. required CachePoolInfoProto info = 1;
  495. }
  496. message ModifyCachePoolResponseProto { // void response
  497. }
  498. message RemoveCachePoolRequestProto {
  499. required string poolName = 1;
  500. }
  501. message RemoveCachePoolResponseProto { // void response
  502. }
  503. message ListCachePoolsRequestProto {
  504. required string prevPoolName = 1;
  505. }
  506. message ListCachePoolsResponseProto {
  507. repeated CachePoolEntryProto entries = 1;
  508. required bool hasMore = 2;
  509. }
  510. message CachePoolEntryProto {
  511. required CachePoolInfoProto info = 1;
  512. required CachePoolStatsProto stats = 2;
  513. }
  514. message GetFileLinkInfoRequestProto {
  515. required string src = 1;
  516. }
  517. message GetFileLinkInfoResponseProto {
  518. optional HdfsFileStatusProto fs = 1;
  519. }
  520. message GetContentSummaryRequestProto {
  521. required string path = 1;
  522. }
  523. message GetContentSummaryResponseProto {
  524. required ContentSummaryProto summary = 1;
  525. }
  526. message GetQuotaUsageRequestProto {
  527. required string path = 1;
  528. }
  529. message GetQuotaUsageResponseProto {
  530. required QuotaUsageProto usage = 1;
  531. }
  532. message SetQuotaRequestProto {
  533. required string path = 1;
  534. required uint64 namespaceQuota = 2;
  535. required uint64 storagespaceQuota = 3;
  536. optional StorageTypeProto storageType = 4;
  537. }
  538. message SetQuotaResponseProto { // void response
  539. }
  540. message FsyncRequestProto {
  541. required string src = 1;
  542. required string client = 2;
  543. optional sint64 lastBlockLength = 3 [default = -1];
  544. optional uint64 fileId = 4 [default = 0]; // default to GRANDFATHER_INODE_ID
  545. }
  546. message FsyncResponseProto { // void response
  547. }
  548. message SetTimesRequestProto {
  549. required string src = 1;
  550. required uint64 mtime = 2;
  551. required uint64 atime = 3;
  552. }
  553. message SetTimesResponseProto { // void response
  554. }
  555. message CreateSymlinkRequestProto {
  556. required string target = 1;
  557. required string link = 2;
  558. required FsPermissionProto dirPerm = 3;
  559. required bool createParent = 4;
  560. }
  561. message CreateSymlinkResponseProto { // void response
  562. }
  563. message GetLinkTargetRequestProto {
  564. required string path = 1;
  565. }
  566. message GetLinkTargetResponseProto {
  567. optional string targetPath = 1;
  568. }
  569. message UpdateBlockForPipelineRequestProto {
  570. required ExtendedBlockProto block = 1;
  571. required string clientName = 2;
  572. }
  573. message UpdateBlockForPipelineResponseProto {
  574. required LocatedBlockProto block = 1;
  575. }
  576. message UpdatePipelineRequestProto {
  577. required string clientName = 1;
  578. required ExtendedBlockProto oldBlock = 2;
  579. required ExtendedBlockProto newBlock = 3;
  580. repeated DatanodeIDProto newNodes = 4;
  581. repeated string storageIDs = 5;
  582. }
  583. message UpdatePipelineResponseProto { // void response
  584. }
  585. message SetBalancerBandwidthRequestProto {
  586. required int64 bandwidth = 1;
  587. }
  588. message SetBalancerBandwidthResponseProto { // void response
  589. }
  590. message GetDataEncryptionKeyRequestProto { // no parameters
  591. }
  592. message GetDataEncryptionKeyResponseProto {
  593. optional DataEncryptionKeyProto dataEncryptionKey = 1;
  594. }
  595. message CreateSnapshotRequestProto {
  596. required string snapshotRoot = 1;
  597. optional string snapshotName = 2;
  598. }
  599. message CreateSnapshotResponseProto {
  600. required string snapshotPath = 1;
  601. }
  602. message RenameSnapshotRequestProto {
  603. required string snapshotRoot = 1;
  604. required string snapshotOldName = 2;
  605. required string snapshotNewName = 3;
  606. }
  607. message RenameSnapshotResponseProto { // void response
  608. }
  609. message AllowSnapshotRequestProto {
  610. required string snapshotRoot = 1;
  611. }
  612. message AllowSnapshotResponseProto {
  613. }
  614. message DisallowSnapshotRequestProto {
  615. required string snapshotRoot = 1;
  616. }
  617. message DisallowSnapshotResponseProto {
  618. }
  619. message DeleteSnapshotRequestProto {
  620. required string snapshotRoot = 1;
  621. required string snapshotName = 2;
  622. }
  623. message DeleteSnapshotResponseProto { // void response
  624. }
  625. message CheckAccessRequestProto {
  626. required string path = 1;
  627. required AclEntryProto.FsActionProto mode = 2;
  628. }
  629. message CheckAccessResponseProto { // void response
  630. }
  631. message GetCurrentEditLogTxidRequestProto {
  632. }
  633. message GetCurrentEditLogTxidResponseProto {
  634. required int64 txid = 1;
  635. }
  636. message GetEditsFromTxidRequestProto {
  637. required int64 txid = 1;
  638. }
  639. message GetEditsFromTxidResponseProto {
  640. required EventsListProto eventsList = 1;
  641. }
  642. enum OpenFilesTypeProto {
  643. ALL_OPEN_FILES = 1;
  644. BLOCKING_DECOMMISSION = 2;
  645. }
  646. message ListOpenFilesRequestProto {
  647. required int64 id = 1;
  648. repeated OpenFilesTypeProto types = 2;
  649. optional string path = 3;
  650. }
  651. message OpenFilesBatchResponseProto {
  652. required int64 id = 1;
  653. required string path = 2;
  654. required string clientName = 3;
  655. required string clientMachine = 4;
  656. }
  657. message ListOpenFilesResponseProto {
  658. repeated OpenFilesBatchResponseProto entries = 1;
  659. required bool hasMore = 2;
  660. repeated OpenFilesTypeProto types = 3;
  661. }
  662. service ClientNamenodeProtocol {
  663. rpc getBlockLocations(GetBlockLocationsRequestProto)
  664. returns(GetBlockLocationsResponseProto);
  665. rpc getServerDefaults(GetServerDefaultsRequestProto)
  666. returns(GetServerDefaultsResponseProto);
  667. rpc create(CreateRequestProto)returns(CreateResponseProto);
  668. rpc append(AppendRequestProto) returns(AppendResponseProto);
  669. rpc setReplication(SetReplicationRequestProto)
  670. returns(SetReplicationResponseProto);
  671. rpc setStoragePolicy(SetStoragePolicyRequestProto)
  672. returns(SetStoragePolicyResponseProto);
  673. rpc unsetStoragePolicy(UnsetStoragePolicyRequestProto)
  674. returns(UnsetStoragePolicyResponseProto);
  675. rpc getStoragePolicy(GetStoragePolicyRequestProto)
  676. returns(GetStoragePolicyResponseProto);
  677. rpc getStoragePolicies(GetStoragePoliciesRequestProto)
  678. returns(GetStoragePoliciesResponseProto);
  679. rpc setPermission(SetPermissionRequestProto)
  680. returns(SetPermissionResponseProto);
  681. rpc setOwner(SetOwnerRequestProto) returns(SetOwnerResponseProto);
  682. rpc abandonBlock(AbandonBlockRequestProto) returns(AbandonBlockResponseProto);
  683. rpc addBlock(AddBlockRequestProto) returns(AddBlockResponseProto);
  684. rpc getAdditionalDatanode(GetAdditionalDatanodeRequestProto)
  685. returns(GetAdditionalDatanodeResponseProto);
  686. rpc complete(CompleteRequestProto) returns(CompleteResponseProto);
  687. rpc reportBadBlocks(ReportBadBlocksRequestProto)
  688. returns(ReportBadBlocksResponseProto);
  689. rpc concat(ConcatRequestProto) returns(ConcatResponseProto);
  690. rpc truncate(TruncateRequestProto) returns(TruncateResponseProto);
  691. rpc rename(RenameRequestProto) returns(RenameResponseProto);
  692. rpc rename2(Rename2RequestProto) returns(Rename2ResponseProto);
  693. rpc delete(DeleteRequestProto) returns(DeleteResponseProto);
  694. rpc mkdirs(MkdirsRequestProto) returns(MkdirsResponseProto);
  695. rpc getListing(GetListingRequestProto) returns(GetListingResponseProto);
  696. rpc renewLease(RenewLeaseRequestProto) returns(RenewLeaseResponseProto);
  697. rpc recoverLease(RecoverLeaseRequestProto)
  698. returns(RecoverLeaseResponseProto);
  699. rpc getFsStats(GetFsStatusRequestProto) returns(GetFsStatsResponseProto);
  700. rpc getFsReplicatedBlockStats(GetFsReplicatedBlockStatsRequestProto)
  701. returns (GetFsReplicatedBlockStatsResponseProto);
  702. rpc getFsECBlockGroupStats(GetFsECBlockGroupStatsRequestProto)
  703. returns (GetFsECBlockGroupStatsResponseProto);
  704. rpc getDatanodeReport(GetDatanodeReportRequestProto)
  705. returns(GetDatanodeReportResponseProto);
  706. rpc getDatanodeStorageReport(GetDatanodeStorageReportRequestProto)
  707. returns(GetDatanodeStorageReportResponseProto);
  708. rpc getPreferredBlockSize(GetPreferredBlockSizeRequestProto)
  709. returns(GetPreferredBlockSizeResponseProto);
  710. rpc setSafeMode(SetSafeModeRequestProto)
  711. returns(SetSafeModeResponseProto);
  712. rpc saveNamespace(SaveNamespaceRequestProto)
  713. returns(SaveNamespaceResponseProto);
  714. rpc rollEdits(RollEditsRequestProto)
  715. returns(RollEditsResponseProto);
  716. rpc restoreFailedStorage(RestoreFailedStorageRequestProto)
  717. returns(RestoreFailedStorageResponseProto);
  718. rpc refreshNodes(RefreshNodesRequestProto) returns(RefreshNodesResponseProto);
  719. rpc finalizeUpgrade(FinalizeUpgradeRequestProto)
  720. returns(FinalizeUpgradeResponseProto);
  721. rpc upgradeStatus(UpgradeStatusRequestProto)
  722. returns(UpgradeStatusResponseProto);
  723. rpc rollingUpgrade(RollingUpgradeRequestProto)
  724. returns(RollingUpgradeResponseProto);
  725. rpc listCorruptFileBlocks(ListCorruptFileBlocksRequestProto)
  726. returns(ListCorruptFileBlocksResponseProto);
  727. rpc metaSave(MetaSaveRequestProto) returns(MetaSaveResponseProto);
  728. rpc getFileInfo(GetFileInfoRequestProto) returns(GetFileInfoResponseProto);
  729. rpc getLocatedFileInfo(GetLocatedFileInfoRequestProto)
  730. returns(GetLocatedFileInfoResponseProto);
  731. rpc addCacheDirective(AddCacheDirectiveRequestProto)
  732. returns (AddCacheDirectiveResponseProto);
  733. rpc modifyCacheDirective(ModifyCacheDirectiveRequestProto)
  734. returns (ModifyCacheDirectiveResponseProto);
  735. rpc removeCacheDirective(RemoveCacheDirectiveRequestProto)
  736. returns (RemoveCacheDirectiveResponseProto);
  737. rpc listCacheDirectives(ListCacheDirectivesRequestProto)
  738. returns (ListCacheDirectivesResponseProto);
  739. rpc addCachePool(AddCachePoolRequestProto)
  740. returns(AddCachePoolResponseProto);
  741. rpc modifyCachePool(ModifyCachePoolRequestProto)
  742. returns(ModifyCachePoolResponseProto);
  743. rpc removeCachePool(RemoveCachePoolRequestProto)
  744. returns(RemoveCachePoolResponseProto);
  745. rpc listCachePools(ListCachePoolsRequestProto)
  746. returns(ListCachePoolsResponseProto);
  747. rpc getFileLinkInfo(GetFileLinkInfoRequestProto)
  748. returns(GetFileLinkInfoResponseProto);
  749. rpc getContentSummary(GetContentSummaryRequestProto)
  750. returns(GetContentSummaryResponseProto);
  751. rpc setQuota(SetQuotaRequestProto) returns(SetQuotaResponseProto);
  752. rpc fsync(FsyncRequestProto) returns(FsyncResponseProto);
  753. rpc setTimes(SetTimesRequestProto) returns(SetTimesResponseProto);
  754. rpc createSymlink(CreateSymlinkRequestProto)
  755. returns(CreateSymlinkResponseProto);
  756. rpc getLinkTarget(GetLinkTargetRequestProto)
  757. returns(GetLinkTargetResponseProto);
  758. rpc updateBlockForPipeline(UpdateBlockForPipelineRequestProto)
  759. returns(UpdateBlockForPipelineResponseProto);
  760. rpc updatePipeline(UpdatePipelineRequestProto)
  761. returns(UpdatePipelineResponseProto);
  762. rpc getDelegationToken(hadoop.common.GetDelegationTokenRequestProto)
  763. returns(hadoop.common.GetDelegationTokenResponseProto);
  764. rpc renewDelegationToken(hadoop.common.RenewDelegationTokenRequestProto)
  765. returns(hadoop.common.RenewDelegationTokenResponseProto);
  766. rpc cancelDelegationToken(hadoop.common.CancelDelegationTokenRequestProto)
  767. returns(hadoop.common.CancelDelegationTokenResponseProto);
  768. rpc setBalancerBandwidth(SetBalancerBandwidthRequestProto)
  769. returns(SetBalancerBandwidthResponseProto);
  770. rpc getDataEncryptionKey(GetDataEncryptionKeyRequestProto)
  771. returns(GetDataEncryptionKeyResponseProto);
  772. rpc createSnapshot(CreateSnapshotRequestProto)
  773. returns(CreateSnapshotResponseProto);
  774. rpc renameSnapshot(RenameSnapshotRequestProto)
  775. returns(RenameSnapshotResponseProto);
  776. rpc allowSnapshot(AllowSnapshotRequestProto)
  777. returns(AllowSnapshotResponseProto);
  778. rpc disallowSnapshot(DisallowSnapshotRequestProto)
  779. returns(DisallowSnapshotResponseProto);
  780. rpc getSnapshottableDirListing(GetSnapshottableDirListingRequestProto)
  781. returns(GetSnapshottableDirListingResponseProto);
  782. rpc deleteSnapshot(DeleteSnapshotRequestProto)
  783. returns(DeleteSnapshotResponseProto);
  784. rpc getSnapshotDiffReport(GetSnapshotDiffReportRequestProto)
  785. returns(GetSnapshotDiffReportResponseProto);
  786. rpc getSnapshotDiffReportListing(GetSnapshotDiffReportListingRequestProto)
  787. returns(GetSnapshotDiffReportListingResponseProto);
  788. rpc isFileClosed(IsFileClosedRequestProto)
  789. returns(IsFileClosedResponseProto);
  790. rpc modifyAclEntries(ModifyAclEntriesRequestProto)
  791. returns(ModifyAclEntriesResponseProto);
  792. rpc removeAclEntries(RemoveAclEntriesRequestProto)
  793. returns(RemoveAclEntriesResponseProto);
  794. rpc removeDefaultAcl(RemoveDefaultAclRequestProto)
  795. returns(RemoveDefaultAclResponseProto);
  796. rpc removeAcl(RemoveAclRequestProto)
  797. returns(RemoveAclResponseProto);
  798. rpc setAcl(SetAclRequestProto)
  799. returns(SetAclResponseProto);
  800. rpc getAclStatus(GetAclStatusRequestProto)
  801. returns(GetAclStatusResponseProto);
  802. rpc setXAttr(SetXAttrRequestProto)
  803. returns(SetXAttrResponseProto);
  804. rpc getXAttrs(GetXAttrsRequestProto)
  805. returns(GetXAttrsResponseProto);
  806. rpc listXAttrs(ListXAttrsRequestProto)
  807. returns(ListXAttrsResponseProto);
  808. rpc removeXAttr(RemoveXAttrRequestProto)
  809. returns(RemoveXAttrResponseProto);
  810. rpc checkAccess(CheckAccessRequestProto)
  811. returns(CheckAccessResponseProto);
  812. rpc createEncryptionZone(CreateEncryptionZoneRequestProto)
  813. returns(CreateEncryptionZoneResponseProto);
  814. rpc listEncryptionZones(ListEncryptionZonesRequestProto)
  815. returns(ListEncryptionZonesResponseProto);
  816. rpc reencryptEncryptionZone(ReencryptEncryptionZoneRequestProto)
  817. returns(ReencryptEncryptionZoneResponseProto);
  818. rpc listReencryptionStatus(ListReencryptionStatusRequestProto)
  819. returns(ListReencryptionStatusResponseProto);
  820. rpc getEZForPath(GetEZForPathRequestProto)
  821. returns(GetEZForPathResponseProto);
  822. rpc setErasureCodingPolicy(SetErasureCodingPolicyRequestProto)
  823. returns(SetErasureCodingPolicyResponseProto);
  824. rpc unsetErasureCodingPolicy(UnsetErasureCodingPolicyRequestProto)
  825. returns(UnsetErasureCodingPolicyResponseProto);
  826. rpc getCurrentEditLogTxid(GetCurrentEditLogTxidRequestProto)
  827. returns(GetCurrentEditLogTxidResponseProto);
  828. rpc getEditsFromTxid(GetEditsFromTxidRequestProto)
  829. returns(GetEditsFromTxidResponseProto);
  830. rpc getErasureCodingPolicies(GetErasureCodingPoliciesRequestProto)
  831. returns(GetErasureCodingPoliciesResponseProto);
  832. rpc addErasureCodingPolicies(AddErasureCodingPoliciesRequestProto)
  833. returns(AddErasureCodingPoliciesResponseProto);
  834. rpc removeErasureCodingPolicy(RemoveErasureCodingPolicyRequestProto)
  835. returns(RemoveErasureCodingPolicyResponseProto);
  836. rpc enableErasureCodingPolicy(EnableErasureCodingPolicyRequestProto)
  837. returns(EnableErasureCodingPolicyResponseProto);
  838. rpc disableErasureCodingPolicy(DisableErasureCodingPolicyRequestProto)
  839. returns(DisableErasureCodingPolicyResponseProto);
  840. rpc getErasureCodingPolicy(GetErasureCodingPolicyRequestProto)
  841. returns(GetErasureCodingPolicyResponseProto);
  842. rpc getErasureCodingCodecs(GetErasureCodingCodecsRequestProto)
  843. returns(GetErasureCodingCodecsResponseProto);
  844. rpc getQuotaUsage(GetQuotaUsageRequestProto)
  845. returns(GetQuotaUsageResponseProto);
  846. rpc listOpenFiles(ListOpenFilesRequestProto)
  847. returns(ListOpenFilesResponseProto);
  848. }