GetCompactionPlansParam.html 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317
  1. <!DOCTYPE HTML>
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (11.0.13) on Mon Jan 24 16:25:44 CST 2022 -->
  6. <title>GetCompactionPlansParam</title>
  7. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  8. <meta name="dc.created" content="2022-01-24">
  9. <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
  10. <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
  11. <script type="text/javascript" src="../../../../script.js"></script>
  12. <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
  13. <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
  14. <!--[if IE]>
  15. <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
  16. <![endif]-->
  17. <script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script>
  18. <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
  19. </head>
  20. <body>
  21. <script type="text/javascript"><!--
  22. try {
  23. if (location.href.indexOf('is-external=true') == -1) {
  24. parent.document.title="GetCompactionPlansParam";
  25. }
  26. }
  27. catch(err) {
  28. }
  29. //-->
  30. var data = {"i0":9,"i1":10};
  31. var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
  32. var altColor = "altColor";
  33. var rowColor = "rowColor";
  34. var tableTab = "tableTab";
  35. var activeTableTab = "activeTableTab";
  36. var pathtoroot = "../../../../";
  37. var useModuleDirectories = true;
  38. loadScripts(document, 'script');</script>
  39. <noscript>
  40. <div>JavaScript is disabled on your browser.</div>
  41. </noscript>
  42. <header role="banner">
  43. <nav role="navigation">
  44. <div class="fixedNav">
  45. <!-- ========= START OF TOP NAVBAR ======= -->
  46. <div class="topNav"><a id="navbar.top">
  47. <!-- -->
  48. </a>
  49. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  50. <a id="navbar.top.firstrow">
  51. <!-- -->
  52. </a>
  53. <ul class="navList" title="Navigation">
  54. <li><a href="../../../../index.html">Overview</a></li>
  55. <li><a href="package-summary.html">Package</a></li>
  56. <li class="navBarCell1Rev">Class</li>
  57. <li><a href="package-tree.html">Tree</a></li>
  58. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  59. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  60. <li><a href="../../../../help-doc.html">Help</a></li>
  61. </ul>
  62. </div>
  63. <div class="subNav">
  64. <ul class="navList" id="allclasses_navbar_top">
  65. <li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
  66. </ul>
  67. <ul class="navListSearch">
  68. <li><label for="search">SEARCH:</label>
  69. <input type="text" id="search" value="search" disabled="disabled">
  70. <input type="reset" id="reset" value="reset" disabled="disabled">
  71. </li>
  72. </ul>
  73. <div>
  74. <script type="text/javascript"><!--
  75. allClassesLink = document.getElementById("allclasses_navbar_top");
  76. if(window==top) {
  77. allClassesLink.style.display = "block";
  78. }
  79. else {
  80. allClassesLink.style.display = "none";
  81. }
  82. //-->
  83. </script>
  84. <noscript>
  85. <div>JavaScript is disabled on your browser.</div>
  86. </noscript>
  87. </div>
  88. <div>
  89. <ul class="subNavList">
  90. <li>Summary:&nbsp;</li>
  91. <li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
  92. <li>Field&nbsp;|&nbsp;</li>
  93. <li>Constr&nbsp;|&nbsp;</li>
  94. <li><a href="#method.summary">Method</a></li>
  95. </ul>
  96. <ul class="subNavList">
  97. <li>Detail:&nbsp;</li>
  98. <li>Field&nbsp;|&nbsp;</li>
  99. <li>Constr&nbsp;|&nbsp;</li>
  100. <li><a href="#method.detail">Method</a></li>
  101. </ul>
  102. </div>
  103. <a id="skip.navbar.top">
  104. <!-- -->
  105. </a></div>
  106. <!-- ========= END OF TOP NAVBAR ========= -->
  107. </div>
  108. <div class="navPadding">&nbsp;</div>
  109. <script type="text/javascript"><!--
  110. $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
  111. //-->
  112. </script>
  113. </nav>
  114. </header>
  115. <!-- ======== START OF CLASS DATA ======== -->
  116. <main role="main">
  117. <div class="header">
  118. <div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">io.milvus.param.control</a></div>
  119. <h2 title="Class GetCompactionPlansParam" class="title">Class GetCompactionPlansParam</h2>
  120. </div>
  121. <div class="contentContainer">
  122. <ul class="inheritance">
  123. <li>java.lang.Object</li>
  124. <li>
  125. <ul class="inheritance">
  126. <li>io.milvus.param.control.GetCompactionPlansParam</li>
  127. </ul>
  128. </li>
  129. </ul>
  130. <div class="description">
  131. <ul class="blockList">
  132. <li class="blockList">
  133. <hr>
  134. <pre>public class <span class="typeNameLabel">GetCompactionPlansParam</span>
  135. extends java.lang.Object</pre>
  136. <div class="block">Parameters for <code>getCompactionStateWithPlans</code> interface.</div>
  137. <dl>
  138. <dt><span class="seeLabel">See Also:</span></dt>
  139. <dd><a href="https://wiki.lfaidata.foundation/display/MIL/MEP+16+--+Compaction">Metric function design</a></dd>
  140. </dl>
  141. </li>
  142. </ul>
  143. </div>
  144. <div class="summary">
  145. <ul class="blockList">
  146. <li class="blockList">
  147. <!-- ======== NESTED CLASS SUMMARY ======== -->
  148. <section role="region">
  149. <ul class="blockList">
  150. <li class="blockList"><a id="nested.class.summary">
  151. <!-- -->
  152. </a>
  153. <h3>Nested Class Summary</h3>
  154. <table class="memberSummary">
  155. <caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
  156. <tr>
  157. <th class="colFirst" scope="col">Modifier and Type</th>
  158. <th class="colSecond" scope="col">Class</th>
  159. <th class="colLast" scope="col">Description</th>
  160. </tr>
  161. <tr class="altColor">
  162. <td class="colFirst"><code>static class&nbsp;</code></td>
  163. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="GetCompactionPlansParam.Builder.html" title="class in io.milvus.param.control">GetCompactionPlansParam.Builder</a></span></code></th>
  164. <td class="colLast">
  165. <div class="block">Builder for <code>GetCompactionPlansParam</code> class.</div>
  166. </td>
  167. </tr>
  168. </table>
  169. </li>
  170. </ul>
  171. </section>
  172. <!-- ========== METHOD SUMMARY =========== -->
  173. <section role="region">
  174. <ul class="blockList">
  175. <li class="blockList"><a id="method.summary">
  176. <!-- -->
  177. </a>
  178. <h3>Method Summary</h3>
  179. <table class="memberSummary">
  180. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  181. <tr>
  182. <th class="colFirst" scope="col">Modifier and Type</th>
  183. <th class="colSecond" scope="col">Method</th>
  184. <th class="colLast" scope="col">Description</th>
  185. </tr>
  186. <tr id="i0" class="altColor">
  187. <td class="colFirst"><code>static <a href="GetCompactionPlansParam.Builder.html" title="class in io.milvus.param.control">GetCompactionPlansParam.Builder</a></code></td>
  188. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newBuilder()">newBuilder</a></span>()</code></th>
  189. <td class="colLast">&nbsp;</td>
  190. </tr>
  191. <tr id="i1" class="rowColor">
  192. <td class="colFirst"><code>java.lang.String</code></td>
  193. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
  194. <td class="colLast">
  195. <div class="block">Constructs a <code>String</code> by <code>GetCompactionPlansParam</code> instance.</div>
  196. </td>
  197. </tr>
  198. </table>
  199. <ul class="blockList">
  200. <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
  201. <!-- -->
  202. </a>
  203. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  204. <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
  205. </ul>
  206. </li>
  207. </ul>
  208. </section>
  209. </li>
  210. </ul>
  211. </div>
  212. <div class="details">
  213. <ul class="blockList">
  214. <li class="blockList">
  215. <!-- ============ METHOD DETAIL ========== -->
  216. <section role="region">
  217. <ul class="blockList">
  218. <li class="blockList"><a id="method.detail">
  219. <!-- -->
  220. </a>
  221. <h3>Method Detail</h3>
  222. <a id="newBuilder()">
  223. <!-- -->
  224. </a>
  225. <ul class="blockList">
  226. <li class="blockList">
  227. <h4>newBuilder</h4>
  228. <pre class="methodSignature">public static&nbsp;<a href="GetCompactionPlansParam.Builder.html" title="class in io.milvus.param.control">GetCompactionPlansParam.Builder</a>&nbsp;newBuilder()</pre>
  229. </li>
  230. </ul>
  231. <a id="toString()">
  232. <!-- -->
  233. </a>
  234. <ul class="blockListLast">
  235. <li class="blockList">
  236. <h4>toString</h4>
  237. <pre class="methodSignature">public&nbsp;java.lang.String&nbsp;toString()</pre>
  238. <div class="block">Constructs a <code>String</code> by <code>GetCompactionPlansParam</code> instance.</div>
  239. <dl>
  240. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  241. <dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  242. <dt><span class="returnLabel">Returns:</span></dt>
  243. <dd><code>String</code></dd>
  244. </dl>
  245. </li>
  246. </ul>
  247. </li>
  248. </ul>
  249. </section>
  250. </li>
  251. </ul>
  252. </div>
  253. </div>
  254. </main>
  255. <!-- ========= END OF CLASS DATA ========= -->
  256. <footer role="contentinfo">
  257. <nav role="navigation">
  258. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  259. <div class="bottomNav"><a id="navbar.bottom">
  260. <!-- -->
  261. </a>
  262. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  263. <a id="navbar.bottom.firstrow">
  264. <!-- -->
  265. </a>
  266. <ul class="navList" title="Navigation">
  267. <li><a href="../../../../index.html">Overview</a></li>
  268. <li><a href="package-summary.html">Package</a></li>
  269. <li class="navBarCell1Rev">Class</li>
  270. <li><a href="package-tree.html">Tree</a></li>
  271. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  272. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  273. <li><a href="../../../../help-doc.html">Help</a></li>
  274. </ul>
  275. </div>
  276. <div class="subNav">
  277. <ul class="navList" id="allclasses_navbar_bottom">
  278. <li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
  279. </ul>
  280. <div>
  281. <script type="text/javascript"><!--
  282. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  283. if(window==top) {
  284. allClassesLink.style.display = "block";
  285. }
  286. else {
  287. allClassesLink.style.display = "none";
  288. }
  289. //-->
  290. </script>
  291. <noscript>
  292. <div>JavaScript is disabled on your browser.</div>
  293. </noscript>
  294. </div>
  295. <div>
  296. <ul class="subNavList">
  297. <li>Summary:&nbsp;</li>
  298. <li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
  299. <li>Field&nbsp;|&nbsp;</li>
  300. <li>Constr&nbsp;|&nbsp;</li>
  301. <li><a href="#method.summary">Method</a></li>
  302. </ul>
  303. <ul class="subNavList">
  304. <li>Detail:&nbsp;</li>
  305. <li>Field&nbsp;|&nbsp;</li>
  306. <li>Constr&nbsp;|&nbsp;</li>
  307. <li><a href="#method.detail">Method</a></li>
  308. </ul>
  309. </div>
  310. <a id="skip.navbar.bottom">
  311. <!-- -->
  312. </a></div>
  313. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  314. </nav>
  315. </footer>
  316. </body>
  317. </html>