ClientNamenodeProtocol.proto 31 KB

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