ServerSetting.Builder.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326
  1. <!DOCTYPE HTML>
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (11.0.18) on Wed Oct 25 17:11:26 CST 2023 -->
  6. <title>ServerSetting.Builder</title>
  7. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  8. <meta name="dc.created" content="2023-10-25">
  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="ServerSetting.Builder";
  26. }
  27. }
  28. catch(err) {
  29. }
  30. //-->
  31. var data = {"i0":10,"i1":10,"i2":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 ServerSetting.Builder" class="title">Class ServerSetting.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.ServerSetting.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="ServerSetting.html" title="class in io.milvus.connection">ServerSetting</a></dd>
  137. </dl>
  138. <hr>
  139. <pre>public static class <span class="typeNameLabel">ServerSetting.Builder</span>
  140. extends java.lang.Object</pre>
  141. </li>
  142. </ul>
  143. </div>
  144. <div class="summary">
  145. <ul class="blockList">
  146. <li class="blockList">
  147. <!-- ========== METHOD SUMMARY =========== -->
  148. <section>
  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="ServerSetting.html" title="class in io.milvus.connection">ServerSetting</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 <a href="../param/ConnectParam.html" title="class in io.milvus.param"><code>ConnectParam</code></a> instance.</div>
  166. </td>
  167. </tr>
  168. <tr id="i1" class="rowColor">
  169. <td class="colFirst"><code><a href="ServerSetting.Builder.html" title="class in io.milvus.connection">ServerSetting.Builder</a></code></td>
  170. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withHost(io.milvus.param.ServerAddress)">withHost</a></span>&#8203;(@NonNull <a href="../param/ServerAddress.html" title="class in io.milvus.param">ServerAddress</a>&nbsp;serverAddress)</code></th>
  171. <td class="colLast">
  172. <div class="block">Sets the server address</div>
  173. </td>
  174. </tr>
  175. <tr id="i2" class="altColor">
  176. <td class="colFirst"><code><a href="ServerSetting.Builder.html" title="class in io.milvus.connection">ServerSetting.Builder</a></code></td>
  177. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withMilvusClient(io.milvus.client.MilvusClient)">withMilvusClient</a></span>&#8203;(<a href="../client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a>&nbsp;milvusClient)</code></th>
  178. <td class="colLast">
  179. <div class="block">Sets the server client for a cluster</div>
  180. </td>
  181. </tr>
  182. </table>
  183. <ul class="blockList">
  184. <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
  185. <!-- -->
  186. </a>
  187. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  188. <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  189. </ul>
  190. </li>
  191. </ul>
  192. </section>
  193. </li>
  194. </ul>
  195. </div>
  196. <div class="details">
  197. <ul class="blockList">
  198. <li class="blockList">
  199. <!-- ============ METHOD DETAIL ========== -->
  200. <section>
  201. <ul class="blockList">
  202. <li class="blockList"><a id="method.detail">
  203. <!-- -->
  204. </a>
  205. <h3>Method Detail</h3>
  206. <a id="withHost(io.milvus.param.ServerAddress)">
  207. <!-- -->
  208. </a>
  209. <ul class="blockList">
  210. <li class="blockList">
  211. <h4>withHost</h4>
  212. <pre class="methodSignature">public&nbsp;<a href="ServerSetting.Builder.html" title="class in io.milvus.connection">ServerSetting.Builder</a>&nbsp;withHost&#8203;(@NonNull
  213. @NonNull <a href="../param/ServerAddress.html" title="class in io.milvus.param">ServerAddress</a>&nbsp;serverAddress)</pre>
  214. <div class="block">Sets the server address</div>
  215. <dl>
  216. <dt><span class="paramLabel">Parameters:</span></dt>
  217. <dd><code>serverAddress</code> - ServerAddress host,port/server</dd>
  218. <dt><span class="returnLabel">Returns:</span></dt>
  219. <dd><code>Builder</code></dd>
  220. </dl>
  221. </li>
  222. </ul>
  223. <a id="withMilvusClient(io.milvus.client.MilvusClient)">
  224. <!-- -->
  225. </a>
  226. <ul class="blockList">
  227. <li class="blockList">
  228. <h4>withMilvusClient</h4>
  229. <pre class="methodSignature">public&nbsp;<a href="ServerSetting.Builder.html" title="class in io.milvus.connection">ServerSetting.Builder</a>&nbsp;withMilvusClient&#8203;(<a href="../client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a>&nbsp;milvusClient)</pre>
  230. <div class="block">Sets the server client for a cluster</div>
  231. <dl>
  232. <dt><span class="paramLabel">Parameters:</span></dt>
  233. <dd><code>milvusClient</code> - MilvusClient</dd>
  234. <dt><span class="returnLabel">Returns:</span></dt>
  235. <dd><code>Builder</code></dd>
  236. </dl>
  237. </li>
  238. </ul>
  239. <a id="build()">
  240. <!-- -->
  241. </a>
  242. <ul class="blockListLast">
  243. <li class="blockList">
  244. <h4>build</h4>
  245. <pre class="methodSignature">public&nbsp;<a href="ServerSetting.html" title="class in io.milvus.connection">ServerSetting</a>&nbsp;build()
  246. throws <a href="../exception/ParamException.html" title="class in io.milvus.exception">ParamException</a></pre>
  247. <div class="block">Verifies parameters and creates a new <a href="../param/ConnectParam.html" title="class in io.milvus.param"><code>ConnectParam</code></a> instance.</div>
  248. <dl>
  249. <dt><span class="returnLabel">Returns:</span></dt>
  250. <dd><a href="../param/ConnectParam.html" title="class in io.milvus.param"><code>ConnectParam</code></a></dd>
  251. <dt><span class="throwsLabel">Throws:</span></dt>
  252. <dd><code><a href="../exception/ParamException.html" title="class in io.milvus.exception">ParamException</a></code></dd>
  253. </dl>
  254. </li>
  255. </ul>
  256. </li>
  257. </ul>
  258. </section>
  259. </li>
  260. </ul>
  261. </div>
  262. </div>
  263. </main>
  264. <!-- ========= END OF CLASS DATA ========= -->
  265. <footer role="contentinfo">
  266. <nav role="navigation">
  267. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  268. <div class="bottomNav"><a id="navbar.bottom">
  269. <!-- -->
  270. </a>
  271. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  272. <a id="navbar.bottom.firstrow">
  273. <!-- -->
  274. </a>
  275. <ul class="navList" title="Navigation">
  276. <li><a href="../../../index.html">Overview</a></li>
  277. <li><a href="package-summary.html">Package</a></li>
  278. <li class="navBarCell1Rev">Class</li>
  279. <li><a href="package-tree.html">Tree</a></li>
  280. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  281. <li><a href="../../../index-files/index-1.html">Index</a></li>
  282. <li><a href="../../../help-doc.html">Help</a></li>
  283. </ul>
  284. </div>
  285. <div class="subNav">
  286. <ul class="navList" id="allclasses_navbar_bottom">
  287. <li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
  288. </ul>
  289. <div>
  290. <script type="text/javascript"><!--
  291. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  292. if(window==top) {
  293. allClassesLink.style.display = "block";
  294. }
  295. else {
  296. allClassesLink.style.display = "none";
  297. }
  298. //-->
  299. </script>
  300. <noscript>
  301. <div>JavaScript is disabled on your browser.</div>
  302. </noscript>
  303. </div>
  304. <div>
  305. <ul class="subNavList">
  306. <li>Summary:&nbsp;</li>
  307. <li>Nested&nbsp;|&nbsp;</li>
  308. <li>Field&nbsp;|&nbsp;</li>
  309. <li>Constr&nbsp;|&nbsp;</li>
  310. <li><a href="#method.summary">Method</a></li>
  311. </ul>
  312. <ul class="subNavList">
  313. <li>Detail:&nbsp;</li>
  314. <li>Field&nbsp;|&nbsp;</li>
  315. <li>Constr&nbsp;|&nbsp;</li>
  316. <li><a href="#method.detail">Method</a></li>
  317. </ul>
  318. </div>
  319. <a id="skip.navbar.bottom">
  320. <!-- -->
  321. </a></div>
  322. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  323. </nav>
  324. </footer>
  325. </body>
  326. </html>