ConnectParam.Builder.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457
  1. <!DOCTYPE HTML>
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (11.0.13) on Thu Jan 27 15:31:54 CST 2022 -->
  6. <title>ConnectParam.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="ConnectParam.Builder";
  25. }
  26. }
  27. catch(err) {
  28. }
  29. //-->
  30. var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":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</a></div>
  119. <h2 title="Class ConnectParam.Builder" class="title">Class ConnectParam.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.ConnectParam.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="ConnectParam.html" title="class in io.milvus.param">ConnectParam</a></dd>
  136. </dl>
  137. <hr>
  138. <pre>public static class <span class="typeNameLabel">ConnectParam.Builder</span>
  139. extends java.lang.Object</pre>
  140. <div class="block">Builder for <a href="ConnectParam.html" title="class in io.milvus.param"><code>ConnectParam</code></a></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="ConnectParam.html" title="class in io.milvus.param">ConnectParam</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="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="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
  170. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#keepAliveWithoutCalls(boolean)">keepAliveWithoutCalls</a></span>&#8203;(boolean&nbsp;enable)</code></th>
  171. <td class="colLast">
  172. <div class="block">Enables the keep-alive function for client channel.</div>
  173. </td>
  174. </tr>
  175. <tr id="i2" class="altColor">
  176. <td class="colFirst"><code><a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
  177. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withConnectTimeout(long,java.util.concurrent.TimeUnit)">withConnectTimeout</a></span>&#8203;(long&nbsp;connectTimeout,
  178. @NonNull java.util.concurrent.TimeUnit&nbsp;timeUnit)</code></th>
  179. <td class="colLast">
  180. <div class="block">Sets the connection timeout value of client channel.</div>
  181. </td>
  182. </tr>
  183. <tr id="i3" class="rowColor">
  184. <td class="colFirst"><code><a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
  185. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withHost(java.lang.String)">withHost</a></span>&#8203;(@NonNull java.lang.String&nbsp;host)</code></th>
  186. <td class="colLast">
  187. <div class="block">Sets the host name/address.</div>
  188. </td>
  189. </tr>
  190. <tr id="i4" class="altColor">
  191. <td class="colFirst"><code><a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
  192. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withIdleTimeout(long,java.util.concurrent.TimeUnit)">withIdleTimeout</a></span>&#8203;(long&nbsp;idleTimeout,
  193. @NonNull java.util.concurrent.TimeUnit&nbsp;timeUnit)</code></th>
  194. <td class="colLast">
  195. <div class="block">Sets the idle timeout value of client channel.</div>
  196. </td>
  197. </tr>
  198. <tr id="i5" class="rowColor">
  199. <td class="colFirst"><code><a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
  200. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withKeepAliveTime(long,java.util.concurrent.TimeUnit)">withKeepAliveTime</a></span>&#8203;(long&nbsp;keepAliveTime,
  201. @NonNull java.util.concurrent.TimeUnit&nbsp;timeUnit)</code></th>
  202. <td class="colLast">
  203. <div class="block">Sets the keep-alive time value of client channel.</div>
  204. </td>
  205. </tr>
  206. <tr id="i6" class="altColor">
  207. <td class="colFirst"><code><a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
  208. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withKeepAliveTimeout(long,java.util.concurrent.TimeUnit)">withKeepAliveTimeout</a></span>&#8203;(long&nbsp;keepAliveTimeout,
  209. @NonNull java.util.concurrent.TimeUnit&nbsp;timeUnit)</code></th>
  210. <td class="colLast">
  211. <div class="block">Sets the keep-alive timeout value of client channel.</div>
  212. </td>
  213. </tr>
  214. <tr id="i7" class="rowColor">
  215. <td class="colFirst"><code><a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
  216. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withPort(int)">withPort</a></span>&#8203;(int&nbsp;port)</code></th>
  217. <td class="colLast">
  218. <div class="block">Sets the connection port.</div>
  219. </td>
  220. </tr>
  221. </table>
  222. <ul class="blockList">
  223. <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
  224. <!-- -->
  225. </a>
  226. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  227. <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  228. </ul>
  229. </li>
  230. </ul>
  231. </section>
  232. </li>
  233. </ul>
  234. </div>
  235. <div class="details">
  236. <ul class="blockList">
  237. <li class="blockList">
  238. <!-- ============ METHOD DETAIL ========== -->
  239. <section role="region">
  240. <ul class="blockList">
  241. <li class="blockList"><a id="method.detail">
  242. <!-- -->
  243. </a>
  244. <h3>Method Detail</h3>
  245. <a id="withHost(java.lang.String)">
  246. <!-- -->
  247. </a>
  248. <ul class="blockList">
  249. <li class="blockList">
  250. <h4>withHost</h4>
  251. <pre class="methodSignature">public&nbsp;<a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a>&nbsp;withHost&#8203;(@NonNull
  252. @NonNull java.lang.String&nbsp;host)</pre>
  253. <div class="block">Sets the host name/address.</div>
  254. <dl>
  255. <dt><span class="paramLabel">Parameters:</span></dt>
  256. <dd><code>host</code> - host name/address</dd>
  257. <dt><span class="returnLabel">Returns:</span></dt>
  258. <dd><code>Builder</code></dd>
  259. </dl>
  260. </li>
  261. </ul>
  262. <a id="withPort(int)">
  263. <!-- -->
  264. </a>
  265. <ul class="blockList">
  266. <li class="blockList">
  267. <h4>withPort</h4>
  268. <pre class="methodSignature">public&nbsp;<a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a>&nbsp;withPort&#8203;(int&nbsp;port)</pre>
  269. <div class="block">Sets the connection port. Port value must be greater than zero and less than 65536.</div>
  270. <dl>
  271. <dt><span class="paramLabel">Parameters:</span></dt>
  272. <dd><code>port</code> - port value</dd>
  273. <dt><span class="returnLabel">Returns:</span></dt>
  274. <dd><code>Builder</code></dd>
  275. </dl>
  276. </li>
  277. </ul>
  278. <a id="withConnectTimeout(long,java.util.concurrent.TimeUnit)">
  279. <!-- -->
  280. </a>
  281. <ul class="blockList">
  282. <li class="blockList">
  283. <h4>withConnectTimeout</h4>
  284. <pre class="methodSignature">public&nbsp;<a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a>&nbsp;withConnectTimeout&#8203;(long&nbsp;connectTimeout,
  285. @NonNull
  286. @NonNull java.util.concurrent.TimeUnit&nbsp;timeUnit)</pre>
  287. <div class="block">Sets the connection timeout value of client channel. The timeout value must be greater than zero.</div>
  288. <dl>
  289. <dt><span class="paramLabel">Parameters:</span></dt>
  290. <dd><code>connectTimeout</code> - timeout value</dd>
  291. <dd><code>timeUnit</code> - timeout unit</dd>
  292. <dt><span class="returnLabel">Returns:</span></dt>
  293. <dd><code>Builder</code></dd>
  294. </dl>
  295. </li>
  296. </ul>
  297. <a id="withKeepAliveTime(long,java.util.concurrent.TimeUnit)">
  298. <!-- -->
  299. </a>
  300. <ul class="blockList">
  301. <li class="blockList">
  302. <h4>withKeepAliveTime</h4>
  303. <pre class="methodSignature">public&nbsp;<a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a>&nbsp;withKeepAliveTime&#8203;(long&nbsp;keepAliveTime,
  304. @NonNull
  305. @NonNull java.util.concurrent.TimeUnit&nbsp;timeUnit)</pre>
  306. <div class="block">Sets the keep-alive time value of client channel. The keep-alive value must be greater than zero.</div>
  307. <dl>
  308. <dt><span class="paramLabel">Parameters:</span></dt>
  309. <dd><code>keepAliveTime</code> - keep-alive value</dd>
  310. <dd><code>timeUnit</code> - keep-alive unit</dd>
  311. <dt><span class="returnLabel">Returns:</span></dt>
  312. <dd><code>Builder</code></dd>
  313. </dl>
  314. </li>
  315. </ul>
  316. <a id="withKeepAliveTimeout(long,java.util.concurrent.TimeUnit)">
  317. <!-- -->
  318. </a>
  319. <ul class="blockList">
  320. <li class="blockList">
  321. <h4>withKeepAliveTimeout</h4>
  322. <pre class="methodSignature">public&nbsp;<a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a>&nbsp;withKeepAliveTimeout&#8203;(long&nbsp;keepAliveTimeout,
  323. @NonNull
  324. @NonNull java.util.concurrent.TimeUnit&nbsp;timeUnit)</pre>
  325. <div class="block">Sets the keep-alive timeout value of client channel. The timeout value must be greater than zero.</div>
  326. <dl>
  327. <dt><span class="paramLabel">Parameters:</span></dt>
  328. <dd><code>keepAliveTimeout</code> - timeout value</dd>
  329. <dd><code>timeUnit</code> - timeout unit</dd>
  330. <dt><span class="returnLabel">Returns:</span></dt>
  331. <dd><code>Builder</code></dd>
  332. </dl>
  333. </li>
  334. </ul>
  335. <a id="keepAliveWithoutCalls(boolean)">
  336. <!-- -->
  337. </a>
  338. <ul class="blockList">
  339. <li class="blockList">
  340. <h4>keepAliveWithoutCalls</h4>
  341. <pre class="methodSignature">public&nbsp;<a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a>&nbsp;keepAliveWithoutCalls&#8203;(boolean&nbsp;enable)</pre>
  342. <div class="block">Enables the keep-alive function for client channel.</div>
  343. <dl>
  344. <dt><span class="paramLabel">Parameters:</span></dt>
  345. <dd><code>enable</code> - true keep-alive</dd>
  346. <dt><span class="returnLabel">Returns:</span></dt>
  347. <dd><code>Builder</code></dd>
  348. </dl>
  349. </li>
  350. </ul>
  351. <a id="withIdleTimeout(long,java.util.concurrent.TimeUnit)">
  352. <!-- -->
  353. </a>
  354. <ul class="blockList">
  355. <li class="blockList">
  356. <h4>withIdleTimeout</h4>
  357. <pre class="methodSignature">public&nbsp;<a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a>&nbsp;withIdleTimeout&#8203;(long&nbsp;idleTimeout,
  358. @NonNull
  359. @NonNull java.util.concurrent.TimeUnit&nbsp;timeUnit)</pre>
  360. <div class="block">Sets the idle timeout value of client channel. The timeout value must be larger than zero.</div>
  361. <dl>
  362. <dt><span class="paramLabel">Parameters:</span></dt>
  363. <dd><code>idleTimeout</code> - timeout value</dd>
  364. <dd><code>timeUnit</code> - timeout unit</dd>
  365. <dt><span class="returnLabel">Returns:</span></dt>
  366. <dd><code>Builder</code></dd>
  367. </dl>
  368. </li>
  369. </ul>
  370. <a id="build()">
  371. <!-- -->
  372. </a>
  373. <ul class="blockListLast">
  374. <li class="blockList">
  375. <h4>build</h4>
  376. <pre class="methodSignature">public&nbsp;<a href="ConnectParam.html" title="class in io.milvus.param">ConnectParam</a>&nbsp;build()
  377. throws <a href="../exception/ParamException.html" title="class in io.milvus.exception">ParamException</a></pre>
  378. <div class="block">Verifies parameters and creates a new <a href="ConnectParam.html" title="class in io.milvus.param"><code>ConnectParam</code></a> instance.</div>
  379. <dl>
  380. <dt><span class="returnLabel">Returns:</span></dt>
  381. <dd><a href="ConnectParam.html" title="class in io.milvus.param"><code>ConnectParam</code></a></dd>
  382. <dt><span class="throwsLabel">Throws:</span></dt>
  383. <dd><code><a href="../exception/ParamException.html" title="class in io.milvus.exception">ParamException</a></code></dd>
  384. </dl>
  385. </li>
  386. </ul>
  387. </li>
  388. </ul>
  389. </section>
  390. </li>
  391. </ul>
  392. </div>
  393. </div>
  394. </main>
  395. <!-- ========= END OF CLASS DATA ========= -->
  396. <footer role="contentinfo">
  397. <nav role="navigation">
  398. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  399. <div class="bottomNav"><a id="navbar.bottom">
  400. <!-- -->
  401. </a>
  402. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  403. <a id="navbar.bottom.firstrow">
  404. <!-- -->
  405. </a>
  406. <ul class="navList" title="Navigation">
  407. <li><a href="../../../index.html">Overview</a></li>
  408. <li><a href="package-summary.html">Package</a></li>
  409. <li class="navBarCell1Rev">Class</li>
  410. <li><a href="package-tree.html">Tree</a></li>
  411. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  412. <li><a href="../../../index-files/index-1.html">Index</a></li>
  413. <li><a href="../../../help-doc.html">Help</a></li>
  414. </ul>
  415. </div>
  416. <div class="subNav">
  417. <ul class="navList" id="allclasses_navbar_bottom">
  418. <li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
  419. </ul>
  420. <div>
  421. <script type="text/javascript"><!--
  422. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  423. if(window==top) {
  424. allClassesLink.style.display = "block";
  425. }
  426. else {
  427. allClassesLink.style.display = "none";
  428. }
  429. //-->
  430. </script>
  431. <noscript>
  432. <div>JavaScript is disabled on your browser.</div>
  433. </noscript>
  434. </div>
  435. <div>
  436. <ul class="subNavList">
  437. <li>Summary:&nbsp;</li>
  438. <li>Nested&nbsp;|&nbsp;</li>
  439. <li>Field&nbsp;|&nbsp;</li>
  440. <li>Constr&nbsp;|&nbsp;</li>
  441. <li><a href="#method.summary">Method</a></li>
  442. </ul>
  443. <ul class="subNavList">
  444. <li>Detail:&nbsp;</li>
  445. <li>Field&nbsp;|&nbsp;</li>
  446. <li>Constr&nbsp;|&nbsp;</li>
  447. <li><a href="#method.detail">Method</a></li>
  448. </ul>
  449. </div>
  450. <a id="skip.navbar.bottom">
  451. <!-- -->
  452. </a></div>
  453. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  454. </nav>
  455. </footer>
  456. </body>
  457. </html>