ManualCompactionParam.Builder.html 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303
  1. <!DOCTYPE HTML>
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (11.0.13) on Thu Jan 27 13:56:42 CST 2022 -->
  6. <title>ManualCompactionParam.Builder</title>
  7. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  8. <meta name="dc.created" content="2022-01-27">
  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="ManualCompactionParam.Builder";
  25. }
  26. }
  27. catch(err) {
  28. }
  29. //-->
  30. var data = {"i0":10,"i1":10};
  31. var tabs = {65535:["t0","All 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>Nested&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 ManualCompactionParam.Builder" class="title">Class ManualCompactionParam.Builder</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.ManualCompactionParam.Builder</li>
  127. </ul>
  128. </li>
  129. </ul>
  130. <div class="description">
  131. <ul class="blockList">
  132. <li class="blockList">
  133. <dl>
  134. <dt>Enclosing class:</dt>
  135. <dd><a href="ManualCompactionParam.html" title="class in io.milvus.param.control">ManualCompactionParam</a></dd>
  136. </dl>
  137. <hr>
  138. <pre>public static final class <span class="typeNameLabel">ManualCompactionParam.Builder</span>
  139. extends java.lang.Object</pre>
  140. <div class="block">Builder for <code>ManualCompactionParam</code> class.</div>
  141. </li>
  142. </ul>
  143. </div>
  144. <div class="summary">
  145. <ul class="blockList">
  146. <li class="blockList">
  147. <!-- ========== METHOD SUMMARY =========== -->
  148. <section role="region">
  149. <ul class="blockList">
  150. <li class="blockList"><a id="method.summary">
  151. <!-- -->
  152. </a>
  153. <h3>Method Summary</h3>
  154. <table class="memberSummary">
  155. <caption><span id="t0" class="activeTableTab"><span>All Methods</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>
  156. <tr>
  157. <th class="colFirst" scope="col">Modifier and Type</th>
  158. <th class="colSecond" scope="col">Method</th>
  159. <th class="colLast" scope="col">Description</th>
  160. </tr>
  161. <tr id="i0" class="altColor">
  162. <td class="colFirst"><code><a href="ManualCompactionParam.html" title="class in io.milvus.param.control">ManualCompactionParam</a></code></td>
  163. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#build()">build</a></span>()</code></th>
  164. <td class="colLast">
  165. <div class="block">Verifies parameters and creates a new <code>ManualCompactionParam</code> instance.</div>
  166. </td>
  167. </tr>
  168. <tr id="i1" class="rowColor">
  169. <td class="colFirst"><code><a href="ManualCompactionParam.Builder.html" title="class in io.milvus.param.control">ManualCompactionParam.Builder</a></code></td>
  170. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withCollectionName(java.lang.String)">withCollectionName</a></span>&#8203;(@NonNull java.lang.String&nbsp;collectionName)</code></th>
  171. <td class="colLast">
  172. <div class="block">Sets the collection name.</div>
  173. </td>
  174. </tr>
  175. </table>
  176. <ul class="blockList">
  177. <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
  178. <!-- -->
  179. </a>
  180. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  181. <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  182. </ul>
  183. </li>
  184. </ul>
  185. </section>
  186. </li>
  187. </ul>
  188. </div>
  189. <div class="details">
  190. <ul class="blockList">
  191. <li class="blockList">
  192. <!-- ============ METHOD DETAIL ========== -->
  193. <section role="region">
  194. <ul class="blockList">
  195. <li class="blockList"><a id="method.detail">
  196. <!-- -->
  197. </a>
  198. <h3>Method Detail</h3>
  199. <a id="withCollectionName(java.lang.String)">
  200. <!-- -->
  201. </a>
  202. <ul class="blockList">
  203. <li class="blockList">
  204. <h4>withCollectionName</h4>
  205. <pre class="methodSignature">public&nbsp;<a href="ManualCompactionParam.Builder.html" title="class in io.milvus.param.control">ManualCompactionParam.Builder</a>&nbsp;withCollectionName&#8203;(@NonNull
  206. @NonNull java.lang.String&nbsp;collectionName)</pre>
  207. <div class="block">Sets the collection name. Collection name cannot be empty or null.</div>
  208. <dl>
  209. <dt><span class="paramLabel">Parameters:</span></dt>
  210. <dd><code>collectionName</code> - collection name</dd>
  211. <dt><span class="returnLabel">Returns:</span></dt>
  212. <dd><code>Builder</code></dd>
  213. </dl>
  214. </li>
  215. </ul>
  216. <a id="build()">
  217. <!-- -->
  218. </a>
  219. <ul class="blockListLast">
  220. <li class="blockList">
  221. <h4>build</h4>
  222. <pre class="methodSignature">public&nbsp;<a href="ManualCompactionParam.html" title="class in io.milvus.param.control">ManualCompactionParam</a>&nbsp;build()
  223. throws <a href="../../exception/ParamException.html" title="class in io.milvus.exception">ParamException</a></pre>
  224. <div class="block">Verifies parameters and creates a new <code>ManualCompactionParam</code> instance.</div>
  225. <dl>
  226. <dt><span class="returnLabel">Returns:</span></dt>
  227. <dd><code>ManualCompactionParam</code></dd>
  228. <dt><span class="throwsLabel">Throws:</span></dt>
  229. <dd><code><a href="../../exception/ParamException.html" title="class in io.milvus.exception">ParamException</a></code></dd>
  230. </dl>
  231. </li>
  232. </ul>
  233. </li>
  234. </ul>
  235. </section>
  236. </li>
  237. </ul>
  238. </div>
  239. </div>
  240. </main>
  241. <!-- ========= END OF CLASS DATA ========= -->
  242. <footer role="contentinfo">
  243. <nav role="navigation">
  244. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  245. <div class="bottomNav"><a id="navbar.bottom">
  246. <!-- -->
  247. </a>
  248. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  249. <a id="navbar.bottom.firstrow">
  250. <!-- -->
  251. </a>
  252. <ul class="navList" title="Navigation">
  253. <li><a href="../../../../index.html">Overview</a></li>
  254. <li><a href="package-summary.html">Package</a></li>
  255. <li class="navBarCell1Rev">Class</li>
  256. <li><a href="package-tree.html">Tree</a></li>
  257. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  258. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  259. <li><a href="../../../../help-doc.html">Help</a></li>
  260. </ul>
  261. </div>
  262. <div class="subNav">
  263. <ul class="navList" id="allclasses_navbar_bottom">
  264. <li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
  265. </ul>
  266. <div>
  267. <script type="text/javascript"><!--
  268. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  269. if(window==top) {
  270. allClassesLink.style.display = "block";
  271. }
  272. else {
  273. allClassesLink.style.display = "none";
  274. }
  275. //-->
  276. </script>
  277. <noscript>
  278. <div>JavaScript is disabled on your browser.</div>
  279. </noscript>
  280. </div>
  281. <div>
  282. <ul class="subNavList">
  283. <li>Summary:&nbsp;</li>
  284. <li>Nested&nbsp;|&nbsp;</li>
  285. <li>Field&nbsp;|&nbsp;</li>
  286. <li>Constr&nbsp;|&nbsp;</li>
  287. <li><a href="#method.summary">Method</a></li>
  288. </ul>
  289. <ul class="subNavList">
  290. <li>Detail:&nbsp;</li>
  291. <li>Field&nbsp;|&nbsp;</li>
  292. <li>Constr&nbsp;|&nbsp;</li>
  293. <li><a href="#method.detail">Method</a></li>
  294. </ul>
  295. </div>
  296. <a id="skip.navbar.bottom">
  297. <!-- -->
  298. </a></div>
  299. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  300. </nav>
  301. </footer>
  302. </body>
  303. </html>