ClusterFactory.Builder.html 13 KB

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