Index.Builder.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (1.8.0_03-Ubuntu) on Fri Oct 11 16:42:53 CST 2019 -->
  6. <title>Index.Builder</title>
  7. <meta name="date" content="2019-10-11">
  8. <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
  9. <script type="text/javascript" src="../../../script.js"></script>
  10. </head>
  11. <body>
  12. <script type="text/javascript"><!--
  13. try {
  14. if (location.href.indexOf('is-external=true') == -1) {
  15. parent.document.title="Index.Builder";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10,"i2":10};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
  23. var altColor = "altColor";
  24. var rowColor = "rowColor";
  25. var tableTab = "tableTab";
  26. var activeTableTab = "activeTableTab";
  27. </script>
  28. <noscript>
  29. <div>JavaScript is disabled on your browser.</div>
  30. </noscript>
  31. <!-- ========= START OF TOP NAVBAR ======= -->
  32. <div class="topNav"><a name="navbar.top">
  33. <!-- -->
  34. </a>
  35. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  36. <a name="navbar.top.firstrow">
  37. <!-- -->
  38. </a>
  39. <ul class="navList" title="Navigation">
  40. <li><a href="../../../io/milvus/client/package-summary.html">Package</a></li>
  41. <li class="navBarCell1Rev">Class</li>
  42. <li><a href="package-tree.html">Tree</a></li>
  43. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  44. <li><a href="../../../index-files/index-1.html">Index</a></li>
  45. <li><a href="../../../help-doc.html">Help</a></li>
  46. </ul>
  47. </div>
  48. <div class="subNav">
  49. <ul class="navList">
  50. <li><a href="../../../io/milvus/client/Index.html" title="class in io.milvus.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  51. <li><a href="../../../io/milvus/client/IndexType.html" title="enum in io.milvus.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  52. </ul>
  53. <ul class="navList">
  54. <li><a href="../../../index.html?io/milvus/client/Index.Builder.html" target="_top">Frames</a></li>
  55. <li><a href="Index.Builder.html" target="_top">No&nbsp;Frames</a></li>
  56. </ul>
  57. <ul class="navList" id="allclasses_navbar_top">
  58. <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  59. </ul>
  60. <div>
  61. <script type="text/javascript"><!--
  62. allClassesLink = document.getElementById("allclasses_navbar_top");
  63. if(window==top) {
  64. allClassesLink.style.display = "block";
  65. }
  66. else {
  67. allClassesLink.style.display = "none";
  68. }
  69. //-->
  70. </script>
  71. </div>
  72. <div>
  73. <ul class="subNavList">
  74. <li>Summary:&nbsp;</li>
  75. <li>Nested&nbsp;|&nbsp;</li>
  76. <li>Field&nbsp;|&nbsp;</li>
  77. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  78. <li><a href="#method.summary">Method</a></li>
  79. </ul>
  80. <ul class="subNavList">
  81. <li>Detail:&nbsp;</li>
  82. <li>Field&nbsp;|&nbsp;</li>
  83. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  84. <li><a href="#method.detail">Method</a></li>
  85. </ul>
  86. </div>
  87. <a name="skip.navbar.top">
  88. <!-- -->
  89. </a></div>
  90. <!-- ========= END OF TOP NAVBAR ========= -->
  91. <!-- ======== START OF CLASS DATA ======== -->
  92. <div class="header">
  93. <div class="subTitle">io.milvus.client</div>
  94. <h2 title="Class Index.Builder" class="title">Class Index.Builder</h2>
  95. </div>
  96. <div class="contentContainer">
  97. <ul class="inheritance">
  98. <li>java.lang.Object</li>
  99. <li>
  100. <ul class="inheritance">
  101. <li>io.milvus.client.Index.Builder</li>
  102. </ul>
  103. </li>
  104. </ul>
  105. <div class="description">
  106. <ul class="blockList">
  107. <li class="blockList">
  108. <dl>
  109. <dt>Enclosing class:</dt>
  110. <dd><a href="../../../io/milvus/client/Index.html" title="class in io.milvus.client">Index</a></dd>
  111. </dl>
  112. <hr>
  113. <br>
  114. <pre>public static class <span class="typeNameLabel">Index.Builder</span>
  115. extends java.lang.Object</pre>
  116. <div class="block">Builder for <code>Index</code></div>
  117. </li>
  118. </ul>
  119. </div>
  120. <div class="summary">
  121. <ul class="blockList">
  122. <li class="blockList">
  123. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  124. <ul class="blockList">
  125. <li class="blockList"><a name="constructor.summary">
  126. <!-- -->
  127. </a>
  128. <h3>Constructor Summary</h3>
  129. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  130. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  131. <tr>
  132. <th class="colOne" scope="col">Constructor and Description</th>
  133. </tr>
  134. <tr class="altColor">
  135. <td class="colOne"><code><span class="memberNameLink"><a href="../../../io/milvus/client/Index.Builder.html#Builder--">Builder</a></span>()</code>&nbsp;</td>
  136. </tr>
  137. </table>
  138. </li>
  139. </ul>
  140. <!-- ========== METHOD SUMMARY =========== -->
  141. <ul class="blockList">
  142. <li class="blockList"><a name="method.summary">
  143. <!-- -->
  144. </a>
  145. <h3>Method Summary</h3>
  146. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  147. <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>
  148. <tr>
  149. <th class="colFirst" scope="col">Modifier and Type</th>
  150. <th class="colLast" scope="col">Method and Description</th>
  151. </tr>
  152. <tr id="i0" class="altColor">
  153. <td class="colFirst"><code><a href="../../../io/milvus/client/Index.html" title="class in io.milvus.client">Index</a></code></td>
  154. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/Index.Builder.html#build--">build</a></span>()</code>&nbsp;</td>
  155. </tr>
  156. <tr id="i1" class="rowColor">
  157. <td class="colFirst"><code><a href="../../../io/milvus/client/Index.Builder.html" title="class in io.milvus.client">Index.Builder</a></code></td>
  158. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/Index.Builder.html#withIndexType-io.milvus.client.IndexType-">withIndexType</a></span>(<a href="../../../io/milvus/client/IndexType.html" title="enum in io.milvus.client">IndexType</a>&nbsp;indexType)</code>
  159. <div class="block">Optional.</div>
  160. </td>
  161. </tr>
  162. <tr id="i2" class="altColor">
  163. <td class="colFirst"><code><a href="../../../io/milvus/client/Index.Builder.html" title="class in io.milvus.client">Index.Builder</a></code></td>
  164. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/Index.Builder.html#withNList-int-">withNList</a></span>(int&nbsp;nList)</code>
  165. <div class="block">Optional.</div>
  166. </td>
  167. </tr>
  168. </table>
  169. <ul class="blockList">
  170. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  171. <!-- -->
  172. </a>
  173. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  174. <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  175. </ul>
  176. </li>
  177. </ul>
  178. </li>
  179. </ul>
  180. </div>
  181. <div class="details">
  182. <ul class="blockList">
  183. <li class="blockList">
  184. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  185. <ul class="blockList">
  186. <li class="blockList"><a name="constructor.detail">
  187. <!-- -->
  188. </a>
  189. <h3>Constructor Detail</h3>
  190. <a name="Builder--">
  191. <!-- -->
  192. </a>
  193. <ul class="blockListLast">
  194. <li class="blockList">
  195. <h4>Builder</h4>
  196. <pre>public&nbsp;Builder()</pre>
  197. </li>
  198. </ul>
  199. </li>
  200. </ul>
  201. <!-- ============ METHOD DETAIL ========== -->
  202. <ul class="blockList">
  203. <li class="blockList"><a name="method.detail">
  204. <!-- -->
  205. </a>
  206. <h3>Method Detail</h3>
  207. <a name="withIndexType-io.milvus.client.IndexType-">
  208. <!-- -->
  209. </a>
  210. <ul class="blockList">
  211. <li class="blockList">
  212. <h4>withIndexType</h4>
  213. <pre>public&nbsp;<a href="../../../io/milvus/client/Index.Builder.html" title="class in io.milvus.client">Index.Builder</a>&nbsp;withIndexType(@Nonnull
  214. <a href="../../../io/milvus/client/IndexType.html" title="enum in io.milvus.client">IndexType</a>&nbsp;indexType)</pre>
  215. <div class="block">Optional. Default to <code>IndexType.FLAT</code></div>
  216. <dl>
  217. <dt><span class="paramLabel">Parameters:</span></dt>
  218. <dd><code>indexType</code> - a <code>IndexType</code> object</dd>
  219. <dt><span class="returnLabel">Returns:</span></dt>
  220. <dd><code>Builder</code></dd>
  221. </dl>
  222. </li>
  223. </ul>
  224. <a name="withNList-int-">
  225. <!-- -->
  226. </a>
  227. <ul class="blockList">
  228. <li class="blockList">
  229. <h4>withNList</h4>
  230. <pre>public&nbsp;<a href="../../../io/milvus/client/Index.Builder.html" title="class in io.milvus.client">Index.Builder</a>&nbsp;withNList(int&nbsp;nList)</pre>
  231. <div class="block">Optional. Default to 16384.</div>
  232. <dl>
  233. <dt><span class="paramLabel">Parameters:</span></dt>
  234. <dd><code>nList</code> - nList of the index</dd>
  235. <dt><span class="returnLabel">Returns:</span></dt>
  236. <dd><code>Builder</code></dd>
  237. </dl>
  238. </li>
  239. </ul>
  240. <a name="build--">
  241. <!-- -->
  242. </a>
  243. <ul class="blockListLast">
  244. <li class="blockList">
  245. <h4>build</h4>
  246. <pre>public&nbsp;<a href="../../../io/milvus/client/Index.html" title="class in io.milvus.client">Index</a>&nbsp;build()</pre>
  247. </li>
  248. </ul>
  249. </li>
  250. </ul>
  251. </li>
  252. </ul>
  253. </div>
  254. </div>
  255. <!-- ========= END OF CLASS DATA ========= -->
  256. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  257. <div class="bottomNav"><a name="navbar.bottom">
  258. <!-- -->
  259. </a>
  260. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  261. <a name="navbar.bottom.firstrow">
  262. <!-- -->
  263. </a>
  264. <ul class="navList" title="Navigation">
  265. <li><a href="../../../io/milvus/client/package-summary.html">Package</a></li>
  266. <li class="navBarCell1Rev">Class</li>
  267. <li><a href="package-tree.html">Tree</a></li>
  268. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  269. <li><a href="../../../index-files/index-1.html">Index</a></li>
  270. <li><a href="../../../help-doc.html">Help</a></li>
  271. </ul>
  272. </div>
  273. <div class="subNav">
  274. <ul class="navList">
  275. <li><a href="../../../io/milvus/client/Index.html" title="class in io.milvus.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  276. <li><a href="../../../io/milvus/client/IndexType.html" title="enum in io.milvus.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  277. </ul>
  278. <ul class="navList">
  279. <li><a href="../../../index.html?io/milvus/client/Index.Builder.html" target="_top">Frames</a></li>
  280. <li><a href="Index.Builder.html" target="_top">No&nbsp;Frames</a></li>
  281. </ul>
  282. <ul class="navList" id="allclasses_navbar_bottom">
  283. <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  284. </ul>
  285. <div>
  286. <script type="text/javascript"><!--
  287. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  288. if(window==top) {
  289. allClassesLink.style.display = "block";
  290. }
  291. else {
  292. allClassesLink.style.display = "none";
  293. }
  294. //-->
  295. </script>
  296. </div>
  297. <div>
  298. <ul class="subNavList">
  299. <li>Summary:&nbsp;</li>
  300. <li>Nested&nbsp;|&nbsp;</li>
  301. <li>Field&nbsp;|&nbsp;</li>
  302. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  303. <li><a href="#method.summary">Method</a></li>
  304. </ul>
  305. <ul class="subNavList">
  306. <li>Detail:&nbsp;</li>
  307. <li>Field&nbsp;|&nbsp;</li>
  308. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  309. <li><a href="#method.detail">Method</a></li>
  310. </ul>
  311. </div>
  312. <a name="skip.navbar.bottom">
  313. <!-- -->
  314. </a></div>
  315. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  316. </body>
  317. </html>