Home Explore Help
Register Sign In
milvus
/
milvus-sdk-java
mirror of https://github.com/milvus-io/milvus-sdk-java.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: 5af961e0e4
Branches Tags
milvus-sdk-java
/
doc
/
io
/
milvus
/
param
/
ConnectParam.Builder.html

ConnectParam.Builder.html 23 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578 
  1. <!DOCTYPE HTML>
    2. 

  2. <!-- NewPage -->
    3. 

  3. <html lang="en">
    4. 

  4. <head>
    5. 

  5. <!-- Generated by javadoc (11.0.15) on Fri Nov 18 17:27:00 CST 2022 -->
    6. 

  6. <title>ConnectParam.Builder</title>
    7. 

  7. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    8. 

  8. <meta name="dc.created" content="2022-11-18">
    9. 

  9. <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
    10. 

  10. <link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
    11. 

  11. <script type="text/javascript" src="../../../script.js"></script>
    12. 

  12. <script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
    13. 

  13. <script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
    14. 

  14. <!--[if IE]>
    15. 

  15. <script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
    16. 

  16. <![endif]-->
    17. 

  17. <script type="text/javascript" src="../../../jquery/jquery-3.5.1.js"></script>
    18. 

  18. <script type="text/javascript" src="../../../jquery/jquery-ui.js"></script>
    19. 

  19. </head>
    20. 

  20. <body>
    21. 

  21. <script type="text/javascript"><!--
    22. 

  22.     try {
    23. 

  23.         if (location.href.indexOf('is-external=true') == -1) {
    24. 

  24.             parent.document.title="ConnectParam.Builder";
    25. 

  25.         }
    26. 

  26.     }
    27. 

  27.     catch(err) {
    28. 

  28.     }
    29. 

  29. //-->
    30. 

  30. var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10};
    31. 

  31. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
    32. 

  32. var altColor = "altColor";
    33. 

  33. var rowColor = "rowColor";
    34. 

  34. var tableTab = "tableTab";
    35. 

  35. var activeTableTab = "activeTableTab";
    36. 

  36. var pathtoroot = "../../../";
    37. 

  37. var useModuleDirectories = true;
    38. 

  38. loadScripts(document, 'script');</script>
    39. 

  39. <noscript>
    40. 

  40. <div>JavaScript is disabled on your browser.</div>
    41. 

  41. </noscript>
    42. 

  42. <header role="banner">
    43. 

  43. <nav role="navigation">
    44. 

  44. <div class="fixedNav">
    45. 

  45. <!-- ========= START OF TOP NAVBAR ======= -->
    46. 

  46. <div class="topNav"><a id="navbar.top">
    47. 

  47. <!--   -->
    48. 

  48. </a>
    49. 

  49. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
    50. 

  50. <a id="navbar.top.firstrow">
    51. 

  51. <!--   -->
    52. 

  52. </a>
    53. 

  53. <ul class="navList" title="Navigation">
    54. 

  54. <li><a href="../../../index.html">Overview</a></li>
    55. 

  55. <li><a href="package-summary.html">Package</a></li>
    56. 

  56. <li class="navBarCell1Rev">Class</li>
    57. 

  57. <li><a href="package-tree.html">Tree</a></li>
    58. 

  58. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
    59. 

  59. <li><a href="../../../index-files/index-1.html">Index</a></li>
    60. 

  60. <li><a href="../../../help-doc.html">Help</a></li>
    61. 

  61. </ul>
    62. 

  62. </div>
    63. 

  63. <div class="subNav">
    64. 

  64. <ul class="navList" id="allclasses_navbar_top">
    65. 

  65. <li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
    66. 

  66. </ul>
    67. 

  67. <ul class="navListSearch">
    68. 

  68. <li><label for="search">SEARCH:</label>
    69. 

  69. <input type="text" id="search" value="search" disabled="disabled">
    70. 

  70. <input type="reset" id="reset" value="reset" disabled="disabled">
    71. 

  71. </li>
    72. 

  72. </ul>
    73. 

  73. <div>
    74. 

  74. <script type="text/javascript"><!--
    75. 

  75.   allClassesLink = document.getElementById("allclasses_navbar_top");
    76. 

  76.   if(window==top) {
    77. 

  77.     allClassesLink.style.display = "block";
    78. 

  78.   }
    79. 

  79.   else {
    80. 

  80.     allClassesLink.style.display = "none";
    81. 

  81.   }
    82. 

  82.   //-->
    83. 

  83. </script>
    84. 

  84. <noscript>
    85. 

  85. <div>JavaScript is disabled on your browser.</div>
    86. 

  86. </noscript>
    87. 

  87. </div>
    88. 

  88. <div>
    89. 

  89. <ul class="subNavList">
    90. 

  90. <li>Summary:&nbsp;</li>
    91. 

  91. <li>Nested&nbsp;|&nbsp;</li>
    92. 

  92. <li>Field&nbsp;|&nbsp;</li>
    93. 

  93. <li>Constr&nbsp;|&nbsp;</li>
    94. 

  94. <li><a href="#method.summary">Method</a></li>
    95. 

  95. </ul>
    96. 

  96. <ul class="subNavList">
    97. 

  97. <li>Detail:&nbsp;</li>
    98. 

  98. <li>Field&nbsp;|&nbsp;</li>
    99. 

  99. <li>Constr&nbsp;|&nbsp;</li>
    100. 

  100. <li><a href="#method.detail">Method</a></li>
    101. 

  101. </ul>
    102. 

  102. </div>
    103. 

  103. <a id="skip.navbar.top">
    104. 

  104. <!--   -->
    105. 

  105. </a></div>
    106. 

  106. <!-- ========= END OF TOP NAVBAR ========= -->
    107. 

  107. </div>
    108. 

  108. <div class="navPadding">&nbsp;</div>
    109. 

  109. <script type="text/javascript"><!--
    110. 

  110. $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
    111. 

  111. //-->
    112. 

  112. </script>
    113. 

  113. </nav>
    114. 

  114. </header>
    115. 

  115. <!-- ======== START OF CLASS DATA ======== -->
    116. 

  116. <main role="main">
    117. 

  117. <div class="header">
    118. 

  118. <div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">io.milvus.param</a></div>
    119. 

  119. <h2 title="Class ConnectParam.Builder" class="title">Class ConnectParam.Builder</h2>
    120. 

  120. </div>
    121. 

  121. <div class="contentContainer">
    122. 

  122. <ul class="inheritance">
    123. 

  123. <li>java.lang.Object</li>
    124. 

  124. <li>
    125. 

  125. <ul class="inheritance">
    126. 

  126. <li>io.milvus.param.ConnectParam.Builder</li>
    127. 

  127. </ul>
    128. 

  128. </li>
    129. 

  129. </ul>
    130. 

  130. <div class="description">
    131. 

  131. <ul class="blockList">
    132. 

  132. <li class="blockList">
    133. 

  133. <dl>
    134. 

  134. <dt>Enclosing class:</dt>
    135. 

  135. <dd><a href="ConnectParam.html" title="class in io.milvus.param">ConnectParam</a></dd>
    136. 

  136. </dl>
    137. 

  137. <hr>
    138. 

  138. <pre>public static class <span class="typeNameLabel">ConnectParam.Builder</span>
    139. 

  139. extends java.lang.Object</pre>
    140. 

  140. <div class="block">Builder for <a href="ConnectParam.html" title="class in io.milvus.param"><code>ConnectParam</code></a></div>
    141. 

  141. </li>
    142. 

  142. </ul>
    143. 

  143. </div>
    144. 

  144. <div class="summary">
    145. 

  145. <ul class="blockList">
    146. 

  146. <li class="blockList">
    147. 

  147. <!-- ========== METHOD SUMMARY =========== -->
    148. 

  148. <section role="region">
    149. 

  149. <ul class="blockList">
    150. 

  150. <li class="blockList"><a id="method.summary">
    151. 

  151. <!--   -->
    152. 

  152. </a>
    153. 

  153. <h3>Method Summary</h3>
    154. 

  154. <table class="memberSummary">
    155. 

  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. 

  156. <tr>
    157. 

  157. <th class="colFirst" scope="col">Modifier and Type</th>
    158. 

  158. <th class="colSecond" scope="col">Method</th>
    159. 

  159. <th class="colLast" scope="col">Description</th>
    160. 

  160. </tr>
    161. 

  161. <tr id="i0" class="altColor">
    162. 

  162. <td class="colFirst"><code><a href="ConnectParam.html" title="class in io.milvus.param">ConnectParam</a></code></td>
    163. 

  163. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#build()">build</a></span>()</code></th>
    164. 

  164. <td class="colLast">
    165. 

  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. 

  166. </td>
    167. 

  167. </tr>
    168. 

  168. <tr id="i1" class="rowColor">
    169. 

  169. <td class="colFirst"><code><a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
    170. 

  170. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#keepAliveWithoutCalls(boolean)">keepAliveWithoutCalls</a></span>&#8203;(boolean&nbsp;enable)</code></th>
    171. 

  171. <td class="colLast">
    172. 

  172. <div class="block">Enables the keep-alive function for client channel.</div>
    173. 

  173. </td>
    174. 

  174. </tr>
    175. 

  175. <tr id="i2" class="altColor">
    176. 

  176. <td class="colFirst"><code><a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
    177. 

  177. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#secure(boolean)">secure</a></span>&#8203;(boolean&nbsp;enable)</code></th>
    178. 

  178. <td class="colLast">
    179. 

  179. <div class="block">Enables the secure for client channel.</div>
    180. 

  180. </td>
    181. 

  181. </tr>
    182. 

  182. <tr id="i3" class="rowColor">
    183. 

  183. <td class="colFirst"><code><a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
    184. 

  184. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withAuthorization(java.lang.String)">withAuthorization</a></span>&#8203;(@NonNull java.lang.String&nbsp;authorization)</code></th>
    185. 

  185. <td class="colLast">
    186. 

  186. <div class="block">Sets the secure for this connection</div>
    187. 

  187. </td>
    188. 

  188. </tr>
    189. 

  189. <tr id="i4" class="altColor">
    190. 

  190. <td class="colFirst"><code><a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
    191. 

  191. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withAuthorization(java.lang.String,java.lang.String)">withAuthorization</a></span>&#8203;(@NonNull java.lang.String&nbsp;username,
    192. 

  192.                  @NonNull java.lang.String&nbsp;password)</code></th>
    193. 

  193. <td class="colLast">
    194. 

  194. <div class="block">Sets the username and password for this connection</div>
    195. 

  195. </td>
    196. 

  196. </tr>
    197. 

  197. <tr id="i5" class="rowColor">
    198. 

  198. <td class="colFirst"><code><a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
    199. 

  199. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withConnectTimeout(long,java.util.concurrent.TimeUnit)">withConnectTimeout</a></span>&#8203;(long&nbsp;connectTimeout,
    200. 

  200.                   @NonNull java.util.concurrent.TimeUnit&nbsp;timeUnit)</code></th>
    201. 

  201. <td class="colLast">
    202. 

  202. <div class="block">Sets the connection timeout value of client channel.</div>
    203. 

  203. </td>
    204. 

  204. </tr>
    205. 

  205. <tr id="i6" class="altColor">
    206. 

  206. <td class="colFirst"><code><a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
    207. 

  207. <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>
    208. 

  208. <td class="colLast">
    209. 

  209. <div class="block">Sets the host name/address.</div>
    210. 

  210. </td>
    211. 

  211. </tr>
    212. 

  212. <tr id="i7" class="rowColor">
    213. 

  213. <td class="colFirst"><code><a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
    214. 

  214. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withIdleTimeout(long,java.util.concurrent.TimeUnit)">withIdleTimeout</a></span>&#8203;(long&nbsp;idleTimeout,
    215. 

  215.                @NonNull java.util.concurrent.TimeUnit&nbsp;timeUnit)</code></th>
    216. 

  216. <td class="colLast">
    217. 

  217. <div class="block">Sets the idle timeout value of client channel.</div>
    218. 

  218. </td>
    219. 

  219. </tr>
    220. 

  220. <tr id="i8" class="altColor">
    221. 

  221. <td class="colFirst"><code><a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
    222. 

  222. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withKeepAliveTime(long,java.util.concurrent.TimeUnit)">withKeepAliveTime</a></span>&#8203;(long&nbsp;keepAliveTime,
    223. 

  223.                  @NonNull java.util.concurrent.TimeUnit&nbsp;timeUnit)</code></th>
    224. 

  224. <td class="colLast">
    225. 

  225. <div class="block">Sets the keep-alive time value of client channel.</div>
    226. 

  226. </td>
    227. 

  227. </tr>
    228. 

  228. <tr id="i9" class="rowColor">
    229. 

  229. <td class="colFirst"><code><a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
    230. 

  230. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withKeepAliveTimeout(long,java.util.concurrent.TimeUnit)">withKeepAliveTimeout</a></span>&#8203;(long&nbsp;keepAliveTimeout,
    231. 

  231.                     @NonNull java.util.concurrent.TimeUnit&nbsp;timeUnit)</code></th>
    232. 

  232. <td class="colLast">
    233. 

  233. <div class="block">Sets the keep-alive timeout value of client channel.</div>
    234. 

  234. </td>
    235. 

  235. </tr>
    236. 

  236. <tr id="i10" class="altColor">
    237. 

  237. <td class="colFirst"><code><a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
    238. 

  238. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withPort(int)">withPort</a></span>&#8203;(int&nbsp;port)</code></th>
    239. 

  239. <td class="colLast">
    240. 

  240. <div class="block">Sets the connection port.</div>
    241. 

  241. </td>
    242. 

  242. </tr>
    243. 

  243. <tr id="i11" class="rowColor">
    244. 

  244. <td class="colFirst"><code><a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
    245. 

  245. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withSecure(boolean)">withSecure</a></span>&#8203;(boolean&nbsp;secure)</code></th>
    246. 

  246. <td class="colLast">
    247. 

  247. <div class="block">Sets secure the authorization for this connection</div>
    248. 

  248. </td>
    249. 

  249. </tr>
    250. 

  250. <tr id="i12" class="altColor">
    251. 

  251. <td class="colFirst"><code><a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
    252. 

  252. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withUri(java.lang.String)">withUri</a></span>&#8203;(java.lang.String&nbsp;uri)</code></th>
    253. 

  253. <td class="colLast">
    254. 

  254. <div class="block">Sets the uri</div>
    255. 

  255. </td>
    256. 

  256. </tr>
    257. 

  257. </table>
    258. 

  258. <ul class="blockList">
    259. 

  259. <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
    260. 

  260. <!--   -->
    261. 

  261. </a>
    262. 

  262. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
    263. 

  263. <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
    264. 

  264. </ul>
    265. 

  265. </li>
    266. 

  266. </ul>
    267. 

  267. </section>
    268. 

  268. </li>
    269. 

  269. </ul>
    270. 

  270. </div>
    271. 

  271. <div class="details">
    272. 

  272. <ul class="blockList">
    273. 

  273. <li class="blockList">
    274. 

  274. <!-- ============ METHOD DETAIL ========== -->
    275. 

  275. <section role="region">
    276. 

  276. <ul class="blockList">
    277. 

  277. <li class="blockList"><a id="method.detail">
    278. 

  278. <!--   -->
    279. 

  279. </a>
    280. 

  280. <h3>Method Detail</h3>
    281. 

  281. <a id="withHost(java.lang.String)">
    282. 

  282. <!--   -->
    283. 

  283. </a>
    284. 

  284. <ul class="blockList">
    285. 

  285. <li class="blockList">
    286. 

  286. <h4>withHost</h4>
    287. 

  287. <pre class="methodSignature">public&nbsp;<a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a>&nbsp;withHost&#8203;(@NonNull
    288. 

  288.                                      @NonNull java.lang.String&nbsp;host)</pre>
    289. 

  289. <div class="block">Sets the host name/address.</div>
    290. 

  290. <dl>
    291. 

  291. <dt><span class="paramLabel">Parameters:</span></dt>
    292. 

  292. <dd><code>host</code> - host name/address</dd>
    293. 

  293. <dt><span class="returnLabel">Returns:</span></dt>
    294. 

  294. <dd><code>Builder</code></dd>
    295. 

  295. </dl>
    296. 

  296. </li>
    297. 

  297. </ul>
    298. 

  298. <a id="withPort(int)">
    299. 

  299. <!--   -->
    300. 

  300. </a>
    301. 

  301. <ul class="blockList">
    302. 

  302. <li class="blockList">
    303. 

  303. <h4>withPort</h4>
    304. 

  304. <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>
    305. 

  305. <div class="block">Sets the connection port. Port value must be greater than zero and less than 65536.</div>
    306. 

  306. <dl>
    307. 

  307. <dt><span class="paramLabel">Parameters:</span></dt>
    308. 

  308. <dd><code>port</code> - port value</dd>
    309. 

  309. <dt><span class="returnLabel">Returns:</span></dt>
    310. 

  310. <dd><code>Builder</code></dd>
    311. 

  311. </dl>
    312. 

  312. </li>
    313. 

  313. </ul>
    314. 

  314. <a id="withUri(java.lang.String)">
    315. 

  315. <!--   -->
    316. 

  316. </a>
    317. 

  317. <ul class="blockList">
    318. 

  318. <li class="blockList">
    319. 

  319. <h4>withUri</h4>
    320. 

  320. <pre class="methodSignature">public&nbsp;<a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a>&nbsp;withUri&#8203;(java.lang.String&nbsp;uri)</pre>
    321. 

  321. <div class="block">Sets the uri</div>
    322. 

  322. <dl>
    323. 

  323. <dt><span class="paramLabel">Parameters:</span></dt>
    324. 

  324. <dd><code>uri</code> - </dd>
    325. 

  325. <dt><span class="returnLabel">Returns:</span></dt>
    326. 

  326. <dd><code>Builder</code></dd>
    327. 

  327. </dl>
    328. 

  328. </li>
    329. 

  329. </ul>
    330. 

  330. <a id="withConnectTimeout(long,java.util.concurrent.TimeUnit)">
    331. 

  331. <!--   -->
    332. 

  332. </a>
    333. 

  333. <ul class="blockList">
    334. 

  334. <li class="blockList">
    335. 

  335. <h4>withConnectTimeout</h4>
    336. 

  336. <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,
    337. 

  337.                                                @NonNull
    338. 

  338.                                                @NonNull java.util.concurrent.TimeUnit&nbsp;timeUnit)</pre>
    339. 

  339. <div class="block">Sets the connection timeout value of client channel. The timeout value must be greater than zero.</div>
    340. 

  340. <dl>
    341. 

  341. <dt><span class="paramLabel">Parameters:</span></dt>
    342. 

  342. <dd><code>connectTimeout</code> - timeout value</dd>
    343. 

  343. <dd><code>timeUnit</code> - timeout unit</dd>
    344. 

  344. <dt><span class="returnLabel">Returns:</span></dt>
    345. 

  345. <dd><code>Builder</code></dd>
    346. 

  346. </dl>
    347. 

  347. </li>
    348. 

  348. </ul>
    349. 

  349. <a id="withKeepAliveTime(long,java.util.concurrent.TimeUnit)">
    350. 

  350. <!--   -->
    351. 

  351. </a>
    352. 

  352. <ul class="blockList">
    353. 

  353. <li class="blockList">
    354. 

  354. <h4>withKeepAliveTime</h4>
    355. 

  355. <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,
    356. 

  356.                                               @NonNull
    357. 

  357.                                               @NonNull java.util.concurrent.TimeUnit&nbsp;timeUnit)</pre>
    358. 

  358. <div class="block">Sets the keep-alive time value of client channel. The keep-alive value must be greater than zero.</div>
    359. 

  359. <dl>
    360. 

  360. <dt><span class="paramLabel">Parameters:</span></dt>
    361. 

  361. <dd><code>keepAliveTime</code> - keep-alive value</dd>
    362. 

  362. <dd><code>timeUnit</code> - keep-alive unit</dd>
    363. 

  363. <dt><span class="returnLabel">Returns:</span></dt>
    364. 

  364. <dd><code>Builder</code></dd>
    365. 

  365. </dl>
    366. 

  366. </li>
    367. 

  367. </ul>
    368. 

  368. <a id="withKeepAliveTimeout(long,java.util.concurrent.TimeUnit)">
    369. 

  369. <!--   -->
    370. 

  370. </a>
    371. 

  371. <ul class="blockList">
    372. 

  372. <li class="blockList">
    373. 

  373. <h4>withKeepAliveTimeout</h4>
    374. 

  374. <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,
    375. 

  375.                                                  @NonNull
    376. 

  376.                                                  @NonNull java.util.concurrent.TimeUnit&nbsp;timeUnit)</pre>
    377. 

  377. <div class="block">Sets the keep-alive timeout value of client channel. The timeout value must be greater than zero.</div>
    378. 

  378. <dl>
    379. 

  379. <dt><span class="paramLabel">Parameters:</span></dt>
    380. 

  380. <dd><code>keepAliveTimeout</code> - timeout value</dd>
    381. 

  381. <dd><code>timeUnit</code> - timeout unit</dd>
    382. 

  382. <dt><span class="returnLabel">Returns:</span></dt>
    383. 

  383. <dd><code>Builder</code></dd>
    384. 

  384. </dl>
    385. 

  385. </li>
    386. 

  386. </ul>
    387. 

  387. <a id="keepAliveWithoutCalls(boolean)">
    388. 

  388. <!--   -->
    389. 

  389. </a>
    390. 

  390. <ul class="blockList">
    391. 

  391. <li class="blockList">
    392. 

  392. <h4>keepAliveWithoutCalls</h4>
    393. 

  393. <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>
    394. 

  394. <div class="block">Enables the keep-alive function for client channel.</div>
    395. 

  395. <dl>
    396. 

  396. <dt><span class="paramLabel">Parameters:</span></dt>
    397. 

  397. <dd><code>enable</code> - true keep-alive</dd>
    398. 

  398. <dt><span class="returnLabel">Returns:</span></dt>
    399. 

  399. <dd><code>Builder</code></dd>
    400. 

  400. </dl>
    401. 

  401. </li>
    402. 

  402. </ul>
    403. 

  403. <a id="secure(boolean)">
    404. 

  404. <!--   -->
    405. 

  405. </a>
    406. 

  406. <ul class="blockList">
    407. 

  407. <li class="blockList">
    408. 

  408. <h4>secure</h4>
    409. 

  409. <pre class="methodSignature">public&nbsp;<a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a>&nbsp;secure&#8203;(boolean&nbsp;enable)</pre>
    410. 

  410. <div class="block">Enables the secure for client channel.</div>
    411. 

  411. <dl>
    412. 

  412. <dt><span class="paramLabel">Parameters:</span></dt>
    413. 

  413. <dd><code>enable</code> - true keep-alive</dd>
    414. 

  414. <dt><span class="returnLabel">Returns:</span></dt>
    415. 

  415. <dd><code>Builder</code></dd>
    416. 

  416. </dl>
    417. 

  417. </li>
    418. 

  418. </ul>
    419. 

  419. <a id="withIdleTimeout(long,java.util.concurrent.TimeUnit)">
    420. 

  420. <!--   -->
    421. 

  421. </a>
    422. 

  422. <ul class="blockList">
    423. 

  423. <li class="blockList">
    424. 

  424. <h4>withIdleTimeout</h4>
    425. 

  425. <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,
    426. 

  426.                                             @NonNull
    427. 

  427.                                             @NonNull java.util.concurrent.TimeUnit&nbsp;timeUnit)</pre>
    428. 

  428. <div class="block">Sets the idle timeout value of client channel. The timeout value must be larger than zero.</div>
    429. 

  429. <dl>
    430. 

  430. <dt><span class="paramLabel">Parameters:</span></dt>
    431. 

  431. <dd><code>idleTimeout</code> - timeout value</dd>
    432. 

  432. <dd><code>timeUnit</code> - timeout unit</dd>
    433. 

  433. <dt><span class="returnLabel">Returns:</span></dt>
    434. 

  434. <dd><code>Builder</code></dd>
    435. 

  435. </dl>
    436. 

  436. </li>
    437. 

  437. </ul>
    438. 

  438. <a id="withAuthorization(java.lang.String,java.lang.String)">
    439. 

  439. <!--   -->
    440. 

  440. </a>
    441. 

  441. <ul class="blockList">
    442. 

  442. <li class="blockList">
    443. 

  443. <h4>withAuthorization</h4>
    444. 

  444. <pre class="methodSignature">public&nbsp;<a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a>&nbsp;withAuthorization&#8203;(@NonNull
    445. 

  445.                                               @NonNull java.lang.String&nbsp;username,
    446. 

  446.                                               @NonNull
    447. 

  447.                                               @NonNull java.lang.String&nbsp;password)</pre>
    448. 

  448. <div class="block">Sets the username and password for this connection</div>
    449. 

  449. <dl>
    450. 

  450. <dt><span class="paramLabel">Parameters:</span></dt>
    451. 

  451. <dd><code>username</code> - current user</dd>
    452. 

  452. <dd><code>password</code> - password</dd>
    453. 

  453. <dt><span class="returnLabel">Returns:</span></dt>
    454. 

  454. <dd><code>Builder</code></dd>
    455. 

  455. </dl>
    456. 

  456. </li>
    457. 

  457. </ul>
    458. 

  458. <a id="withSecure(boolean)">
    459. 

  459. <!--   -->
    460. 

  460. </a>
    461. 

  461. <ul class="blockList">
    462. 

  462. <li class="blockList">
    463. 

  463. <h4>withSecure</h4>
    464. 

  464. <pre class="methodSignature">public&nbsp;<a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a>&nbsp;withSecure&#8203;(boolean&nbsp;secure)</pre>
    465. 

  465. <div class="block">Sets secure the authorization for this connection</div>
    466. 

  466. <dl>
    467. 

  467. <dt><span class="paramLabel">Parameters:</span></dt>
    468. 

  468. <dd><code>secure</code> - boolean</dd>
    469. 

  469. <dt><span class="returnLabel">Returns:</span></dt>
    470. 

  470. <dd><code>Builder</code></dd>
    471. 

  471. </dl>
    472. 

  472. </li>
    473. 

  473. </ul>
    474. 

  474. <a id="withAuthorization(java.lang.String)">
    475. 

  475. <!--   -->
    476. 

  476. </a>
    477. 

  477. <ul class="blockList">
    478. 

  478. <li class="blockList">
    479. 

  479. <h4>withAuthorization</h4>
    480. 

  480. <pre class="methodSignature">public&nbsp;<a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a>&nbsp;withAuthorization&#8203;(@NonNull
    481. 

  481.                                               @NonNull java.lang.String&nbsp;authorization)</pre>
    482. 

  482. <div class="block">Sets the secure for this connection</div>
    483. 

  483. <dl>
    484. 

  484. <dt><span class="paramLabel">Parameters:</span></dt>
    485. 

  485. <dd><code>authorization</code> - the authorization info that has included the encoded username and password info</dd>
    486. 

  486. <dt><span class="returnLabel">Returns:</span></dt>
    487. 

  487. <dd><code>Builder</code></dd>
    488. 

  488. </dl>
    489. 

  489. </li>
    490. 

  490. </ul>
    491. 

  491. <a id="build()">
    492. 

  492. <!--   -->
    493. 

  493. </a>
    494. 

  494. <ul class="blockListLast">
    495. 

  495. <li class="blockList">
    496. 

  496. <h4>build</h4>
    497. 

  497. <pre class="methodSignature">public&nbsp;<a href="ConnectParam.html" title="class in io.milvus.param">ConnectParam</a>&nbsp;build()
    498. 

  498.                    throws <a href="../exception/ParamException.html" title="class in io.milvus.exception">ParamException</a></pre>
    499. 

  499. <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>
    500. 

  500. <dl>
    501. 

  501. <dt><span class="returnLabel">Returns:</span></dt>
    502. 

  502. <dd><a href="ConnectParam.html" title="class in io.milvus.param"><code>ConnectParam</code></a></dd>
    503. 

  503. <dt><span class="throwsLabel">Throws:</span></dt>
    504. 

  504. <dd><code><a href="../exception/ParamException.html" title="class in io.milvus.exception">ParamException</a></code></dd>
    505. 

  505. </dl>
    506. 

  506. </li>
    507. 

  507. </ul>
    508. 

  508. </li>
    509. 

  509. </ul>
    510. 

  510. </section>
    511. 

  511. </li>
    512. 

  512. </ul>
    513. 

  513. </div>
    514. 

  514. </div>
    515. 

  515. </main>
    516. 

  516. <!-- ========= END OF CLASS DATA ========= -->
    517. 

  517. <footer role="contentinfo">
    518. 

  518. <nav role="navigation">
    519. 

  519. <!-- ======= START OF BOTTOM NAVBAR ====== -->
    520. 

  520. <div class="bottomNav"><a id="navbar.bottom">
    521. 

  521. <!--   -->
    522. 

  522. </a>
    523. 

  523. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
    524. 

  524. <a id="navbar.bottom.firstrow">
    525. 

  525. <!--   -->
    526. 

  526. </a>
    527. 

  527. <ul class="navList" title="Navigation">
    528. 

  528. <li><a href="../../../index.html">Overview</a></li>
    529. 

  529. <li><a href="package-summary.html">Package</a></li>
    530. 

  530. <li class="navBarCell1Rev">Class</li>
    531. 

  531. <li><a href="package-tree.html">Tree</a></li>
    532. 

  532. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
    533. 

  533. <li><a href="../../../index-files/index-1.html">Index</a></li>
    534. 

  534. <li><a href="../../../help-doc.html">Help</a></li>
    535. 

  535. </ul>
    536. 

  536. </div>
    537. 

  537. <div class="subNav">
    538. 

  538. <ul class="navList" id="allclasses_navbar_bottom">
    539. 

  539. <li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
    540. 

  540. </ul>
    541. 

  541. <div>
    542. 

  542. <script type="text/javascript"><!--
    543. 

  543.   allClassesLink = document.getElementById("allclasses_navbar_bottom");
    544. 

  544.   if(window==top) {
    545. 

  545.     allClassesLink.style.display = "block";
    546. 

  546.   }
    547. 

  547.   else {
    548. 

  548.     allClassesLink.style.display = "none";
    549. 

  549.   }
    550. 

  550.   //-->
    551. 

  551. </script>
    552. 

  552. <noscript>
    553. 

  553. <div>JavaScript is disabled on your browser.</div>
    554. 

  554. </noscript>
    555. 

  555. </div>
    556. 

  556. <div>
    557. 

  557. <ul class="subNavList">
    558. 

  558. <li>Summary:&nbsp;</li>
    559. 

  559. <li>Nested&nbsp;|&nbsp;</li>
    560. 

  560. <li>Field&nbsp;|&nbsp;</li>
    561. 

  561. <li>Constr&nbsp;|&nbsp;</li>
    562. 

  562. <li><a href="#method.summary">Method</a></li>
    563. 

  563. </ul>
    564. 

  564. <ul class="subNavList">
    565. 

  565. <li>Detail:&nbsp;</li>
    566. 

  566. <li>Field&nbsp;|&nbsp;</li>
    567. 

  567. <li>Constr&nbsp;|&nbsp;</li>
    568. 

  568. <li><a href="#method.detail">Method</a></li>
    569. 

  569. </ul>
    570. 

  570. </div>
    571. 

  571. <a id="skip.navbar.bottom">
    572. 

  572. <!--   -->
    573. 

  573. </a></div>
    574. 

  574. <!-- ======== END OF BOTTOM NAVBAR ======= -->
    575. 

  575. </nav>
    576. 

  576. </footer>
    577. 

  577. </body>
    578. 

  578. </html>
    579.