ClientNamenodeProtocol.proto 30 KB

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