ClusterFactory.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417
  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</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";
  26. }
  27. }
  28. catch(err) {
  29. }
  30. //-->
  31. var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":9};
  32. var tabs = {65535:["t0","All Methods"],1:["t1","Static 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><a href="#nested.class.summary">Nested</a>&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" class="title">Class ClusterFactory</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</li>
  128. </ul>
  129. </li>
  130. </ul>
  131. <div class="description">
  132. <ul class="blockList">
  133. <li class="blockList">
  134. <hr>
  135. <pre>public class <span class="typeNameLabel">ClusterFactory</span>
  136. extends java.lang.Object</pre>
  137. <div class="block">Factory with managing multi cluster.</div>
  138. </li>
  139. </ul>
  140. </div>
  141. <div class="summary">
  142. <ul class="blockList">
  143. <li class="blockList">
  144. <!-- ======== NESTED CLASS SUMMARY ======== -->
  145. <section>
  146. <ul class="blockList">
  147. <li class="blockList"><a id="nested.class.summary">
  148. <!-- -->
  149. </a>
  150. <h3>Nested Class Summary</h3>
  151. <table class="memberSummary">
  152. <caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
  153. <tr>
  154. <th class="colFirst" scope="col">Modifier and Type</th>
  155. <th class="colSecond" scope="col">Class</th>
  156. <th class="colLast" scope="col">Description</th>
  157. </tr>
  158. <tr class="altColor">
  159. <td class="colFirst"><code>static class&nbsp;</code></td>
  160. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="ClusterFactory.Builder.html" title="class in io.milvus.connection">ClusterFactory.Builder</a></span></code></th>
  161. <td class="colLast">
  162. <div class="block">Builder for <a href="ClusterFactory.html" title="class in io.milvus.connection"><code>ClusterFactory</code></a></div>
  163. </td>
  164. </tr>
  165. </table>
  166. </li>
  167. </ul>
  168. </section>
  169. <!-- ========== METHOD SUMMARY =========== -->
  170. <section>
  171. <ul class="blockList">
  172. <li class="blockList"><a id="method.summary">
  173. <!-- -->
  174. </a>
  175. <h3>Method Summary</h3>
  176. <table class="memberSummary">
  177. <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>
  178. <tr>
  179. <th class="colFirst" scope="col">Modifier and Type</th>
  180. <th class="colSecond" scope="col">Method</th>
  181. <th class="colLast" scope="col">Description</th>
  182. </tr>
  183. <tr id="i0" class="altColor">
  184. <td class="colFirst"><code>void</code></td>
  185. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#availableServerChange(java.util.List)">availableServerChange</a></span>&#8203;(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">&nbsp;</td>
  187. </tr>
  188. <tr id="i1" class="rowColor">
  189. <td class="colFirst"><code>void</code></td>
  190. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close()">close</a></span>()</code></th>
  191. <td class="colLast">&nbsp;</td>
  192. </tr>
  193. <tr id="i2" class="altColor">
  194. <td class="colFirst"><code><a href="ServerSetting.html" title="class in io.milvus.connection">ServerSetting</a></code></td>
  195. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#electMaster()">electMaster</a></span>()</code></th>
  196. <td class="colLast">&nbsp;</td>
  197. </tr>
  198. <tr id="i3" class="rowColor">
  199. <td class="colFirst"><code>java.util.List&lt;<a href="ServerSetting.html" title="class in io.milvus.connection">ServerSetting</a>&gt;</code></td>
  200. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAvailableServerSettings()">getAvailableServerSettings</a></span>()</code></th>
  201. <td class="colLast">&nbsp;</td>
  202. </tr>
  203. <tr id="i4" class="altColor">
  204. <td class="colFirst"><code><a href="ServerSetting.html" title="class in io.milvus.connection">ServerSetting</a></code></td>
  205. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDefaultServer()">getDefaultServer</a></span>()</code></th>
  206. <td class="colLast">&nbsp;</td>
  207. </tr>
  208. <tr id="i5" class="rowColor">
  209. <td class="colFirst"><code><a href="ServerSetting.html" title="class in io.milvus.connection">ServerSetting</a></code></td>
  210. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaster()">getMaster</a></span>()</code></th>
  211. <td class="colLast">&nbsp;</td>
  212. </tr>
  213. <tr id="i6" class="altColor">
  214. <td class="colFirst"><code>java.util.List&lt;<a href="ServerSetting.html" title="class in io.milvus.connection">ServerSetting</a>&gt;</code></td>
  215. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getServerSettings()">getServerSettings</a></span>()</code></th>
  216. <td class="colLast">&nbsp;</td>
  217. </tr>
  218. <tr id="i7" class="rowColor">
  219. <td class="colFirst"><code>void</code></td>
  220. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#masterChange(io.milvus.connection.ServerSetting)">masterChange</a></span>&#8203;(<a href="ServerSetting.html" title="class in io.milvus.connection">ServerSetting</a>&nbsp;serverSetting)</code></th>
  221. <td class="colLast">&nbsp;</td>
  222. </tr>
  223. <tr id="i8" class="altColor">
  224. <td class="colFirst"><code>boolean</code></td>
  225. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#masterIsRunning()">masterIsRunning</a></span>()</code></th>
  226. <td class="colLast">&nbsp;</td>
  227. </tr>
  228. <tr id="i9" class="rowColor">
  229. <td class="colFirst"><code>static <a href="ClusterFactory.Builder.html" title="class in io.milvus.connection">ClusterFactory.Builder</a></code></td>
  230. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newBuilder()">newBuilder</a></span>()</code></th>
  231. <td class="colLast">&nbsp;</td>
  232. </tr>
  233. </table>
  234. <ul class="blockList">
  235. <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
  236. <!-- -->
  237. </a>
  238. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  239. <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  240. </ul>
  241. </li>
  242. </ul>
  243. </section>
  244. </li>
  245. </ul>
  246. </div>
  247. <div class="details">
  248. <ul class="blockList">
  249. <li class="blockList">
  250. <!-- ============ METHOD DETAIL ========== -->
  251. <section>
  252. <ul class="blockList">
  253. <li class="blockList"><a id="method.detail">
  254. <!-- -->
  255. </a>
  256. <h3>Method Detail</h3>
  257. <a id="getDefaultServer()">
  258. <!-- -->
  259. </a>
  260. <ul class="blockList">
  261. <li class="blockList">
  262. <h4>getDefaultServer</h4>
  263. <pre class="methodSignature">public&nbsp;<a href="ServerSetting.html" title="class in io.milvus.connection">ServerSetting</a>&nbsp;getDefaultServer()</pre>
  264. </li>
  265. </ul>
  266. <a id="masterIsRunning()">
  267. <!-- -->
  268. </a>
  269. <ul class="blockList">
  270. <li class="blockList">
  271. <h4>masterIsRunning</h4>
  272. <pre class="methodSignature">public&nbsp;boolean&nbsp;masterIsRunning()</pre>
  273. </li>
  274. </ul>
  275. <a id="masterChange(io.milvus.connection.ServerSetting)">
  276. <!-- -->
  277. </a>
  278. <ul class="blockList">
  279. <li class="blockList">
  280. <h4>masterChange</h4>
  281. <pre class="methodSignature">public&nbsp;void&nbsp;masterChange&#8203;(<a href="ServerSetting.html" title="class in io.milvus.connection">ServerSetting</a>&nbsp;serverSetting)</pre>
  282. </li>
  283. </ul>
  284. <a id="availableServerChange(java.util.List)">
  285. <!-- -->
  286. </a>
  287. <ul class="blockList">
  288. <li class="blockList">
  289. <h4>availableServerChange</h4>
  290. <pre class="methodSignature">public&nbsp;void&nbsp;availableServerChange&#8203;(java.util.List&lt;<a href="ServerSetting.html" title="class in io.milvus.connection">ServerSetting</a>&gt;&nbsp;serverSettings)</pre>
  291. </li>
  292. </ul>
  293. <a id="electMaster()">
  294. <!-- -->
  295. </a>
  296. <ul class="blockList">
  297. <li class="blockList">
  298. <h4>electMaster</h4>
  299. <pre class="methodSignature">public&nbsp;<a href="ServerSetting.html" title="class in io.milvus.connection">ServerSetting</a>&nbsp;electMaster()</pre>
  300. </li>
  301. </ul>
  302. <a id="close()">
  303. <!-- -->
  304. </a>
  305. <ul class="blockList">
  306. <li class="blockList">
  307. <h4>close</h4>
  308. <pre class="methodSignature">public&nbsp;void&nbsp;close()</pre>
  309. </li>
  310. </ul>
  311. <a id="getServerSettings()">
  312. <!-- -->
  313. </a>
  314. <ul class="blockList">
  315. <li class="blockList">
  316. <h4>getServerSettings</h4>
  317. <pre class="methodSignature">public&nbsp;java.util.List&lt;<a href="ServerSetting.html" title="class in io.milvus.connection">ServerSetting</a>&gt;&nbsp;getServerSettings()</pre>
  318. </li>
  319. </ul>
  320. <a id="getMaster()">
  321. <!-- -->
  322. </a>
  323. <ul class="blockList">
  324. <li class="blockList">
  325. <h4>getMaster</h4>
  326. <pre class="methodSignature">public&nbsp;<a href="ServerSetting.html" title="class in io.milvus.connection">ServerSetting</a>&nbsp;getMaster()</pre>
  327. </li>
  328. </ul>
  329. <a id="getAvailableServerSettings()">
  330. <!-- -->
  331. </a>
  332. <ul class="blockList">
  333. <li class="blockList">
  334. <h4>getAvailableServerSettings</h4>
  335. <pre class="methodSignature">public&nbsp;java.util.List&lt;<a href="ServerSetting.html" title="class in io.milvus.connection">ServerSetting</a>&gt;&nbsp;getAvailableServerSettings()</pre>
  336. </li>
  337. </ul>
  338. <a id="newBuilder()">
  339. <!-- -->
  340. </a>
  341. <ul class="blockListLast">
  342. <li class="blockList">
  343. <h4>newBuilder</h4>
  344. <pre class="methodSignature">public static&nbsp;<a href="ClusterFactory.Builder.html" title="class in io.milvus.connection">ClusterFactory.Builder</a>&nbsp;newBuilder()</pre>
  345. </li>
  346. </ul>
  347. </li>
  348. </ul>
  349. </section>
  350. </li>
  351. </ul>
  352. </div>
  353. </div>
  354. </main>
  355. <!-- ========= END OF CLASS DATA ========= -->
  356. <footer role="contentinfo">
  357. <nav role="navigation">
  358. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  359. <div class="bottomNav"><a id="navbar.bottom">
  360. <!-- -->
  361. </a>
  362. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  363. <a id="navbar.bottom.firstrow">
  364. <!-- -->
  365. </a>
  366. <ul class="navList" title="Navigation">
  367. <li><a href="../../../index.html">Overview</a></li>
  368. <li><a href="package-summary.html">Package</a></li>
  369. <li class="navBarCell1Rev">Class</li>
  370. <li><a href="package-tree.html">Tree</a></li>
  371. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  372. <li><a href="../../../index-files/index-1.html">Index</a></li>
  373. <li><a href="../../../help-doc.html">Help</a></li>
  374. </ul>
  375. </div>
  376. <div class="subNav">
  377. <ul class="navList" id="allclasses_navbar_bottom">
  378. <li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
  379. </ul>
  380. <div>
  381. <script type="text/javascript"><!--
  382. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  383. if(window==top) {
  384. allClassesLink.style.display = "block";
  385. }
  386. else {
  387. allClassesLink.style.display = "none";
  388. }
  389. //-->
  390. </script>
  391. <noscript>
  392. <div>JavaScript is disabled on your browser.</div>
  393. </noscript>
  394. </div>
  395. <div>
  396. <ul class="subNavList">
  397. <li>Summary:&nbsp;</li>
  398. <li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
  399. <li>Field&nbsp;|&nbsp;</li>
  400. <li>Constr&nbsp;|&nbsp;</li>
  401. <li><a href="#method.summary">Method</a></li>
  402. </ul>
  403. <ul class="subNavList">
  404. <li>Detail:&nbsp;</li>
  405. <li>Field&nbsp;|&nbsp;</li>
  406. <li>Constr&nbsp;|&nbsp;</li>
  407. <li><a href="#method.detail">Method</a></li>
  408. </ul>
  409. </div>
  410. <a id="skip.navbar.bottom">
  411. <!-- -->
  412. </a></div>
  413. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  414. </nav>
  415. </footer>
  416. </body>
  417. </html>