123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751 |
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
- <!-- NewPage -->
- <html lang="en">
- <head>
- <!-- Generated by javadoc (1.8.0_402-402) on Fri Oct 18 12:22:15 CST 2024 -->
- <title>ConnectParam.Builder</title>
- <meta name="date" content="2024-10-18">
- <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
- <script type="text/javascript" src="../../../script.js"></script>
- </head>
- <body>
- <script type="text/javascript"><!--
- try {
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="ConnectParam.Builder";
- }
- }
- catch(err) {
- }
- //-->
- var methods = {"i0":10,"i1":10,"i2":42,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":42,"i18":10,"i19":10,"i20":10,"i21":10};
- var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
- var altColor = "altColor";
- var rowColor = "rowColor";
- var tableTab = "tableTab";
- var activeTableTab = "activeTableTab";
- </script>
- <noscript>
- <div>JavaScript is disabled on your browser.</div>
- </noscript>
- <!-- ========= START OF TOP NAVBAR ======= -->
- <div class="topNav"><a name="navbar.top">
- <!-- -->
- </a>
- <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
- <a name="navbar.top.firstrow">
- <!-- -->
- </a>
- <ul class="navList" title="Navigation">
- <li><a href="../../../overview-summary.html">Overview</a></li>
- <li><a href="package-summary.html">Package</a></li>
- <li class="navBarCell1Rev">Class</li>
- <li><a href="package-tree.html">Tree</a></li>
- <li><a href="../../../deprecated-list.html">Deprecated</a></li>
- <li><a href="../../../index-files/index-1.html">Index</a></li>
- <li><a href="../../../help-doc.html">Help</a></li>
- </ul>
- </div>
- <div class="subNav">
- <ul class="navList">
- <li><a href="../../../io/milvus/param/ConnectParam.html" title="class in io.milvus.param"><span class="typeNameLink">Prev Class</span></a></li>
- <li><a href="../../../io/milvus/param/Constant.html" title="class in io.milvus.param"><span class="typeNameLink">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../../../index.html?io/milvus/param/ConnectParam.Builder.html" target="_top">Frames</a></li>
- <li><a href="ConnectParam.Builder.html" target="_top">No Frames</a></li>
- </ul>
- <ul class="navList" id="allclasses_navbar_top">
- <li><a href="../../../allclasses-noframe.html">All Classes</a></li>
- </ul>
- <div>
- <script type="text/javascript"><!--
- allClassesLink = document.getElementById("allclasses_navbar_top");
- if(window==top) {
- allClassesLink.style.display = "block";
- }
- else {
- allClassesLink.style.display = "none";
- }
- //-->
- </script>
- </div>
- <div>
- <ul class="subNavList">
- <li>Summary: </li>
- <li>Nested | </li>
- <li>Field | </li>
- <li>Constr | </li>
- <li><a href="#method.summary">Method</a></li>
- </ul>
- <ul class="subNavList">
- <li>Detail: </li>
- <li>Field | </li>
- <li>Constr | </li>
- <li><a href="#method.detail">Method</a></li>
- </ul>
- </div>
- <a name="skip.navbar.top">
- <!-- -->
- </a></div>
- <!-- ========= END OF TOP NAVBAR ========= -->
- <!-- ======== START OF CLASS DATA ======== -->
- <div class="header">
- <div class="subTitle">io.milvus.param</div>
- <h2 title="Class ConnectParam.Builder" class="title">Class ConnectParam.Builder</h2>
- </div>
- <div class="contentContainer">
- <ul class="inheritance">
- <li>java.lang.Object</li>
- <li>
- <ul class="inheritance">
- <li>io.milvus.param.ConnectParam.Builder</li>
- </ul>
- </li>
- </ul>
- <div class="description">
- <ul class="blockList">
- <li class="blockList">
- <dl>
- <dt>Direct Known Subclasses:</dt>
- <dd><a href="../../../io/milvus/param/MultiConnectParam.Builder.html" title="class in io.milvus.param">MultiConnectParam.Builder</a></dd>
- </dl>
- <dl>
- <dt>Enclosing class:</dt>
- <dd><a href="../../../io/milvus/param/ConnectParam.html" title="class in io.milvus.param">ConnectParam</a></dd>
- </dl>
- <hr>
- <br>
- <pre>public static class <span class="typeNameLabel">ConnectParam.Builder</span>
- extends java.lang.Object</pre>
- <div class="block">Builder for <a href="../../../io/milvus/param/ConnectParam.html" title="class in io.milvus.param"><code>ConnectParam</code></a></div>
- </li>
- </ul>
- </div>
- <div class="summary">
- <ul class="blockList">
- <li class="blockList">
- <!-- ========== METHOD SUMMARY =========== -->
- <ul class="blockList">
- <li class="blockList"><a name="method.summary">
- <!-- -->
- </a>
- <h3>Method Summary</h3>
- <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
- <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption>
- <tr>
- <th class="colFirst" scope="col">Modifier and Type</th>
- <th class="colLast" scope="col">Method and Description</th>
- </tr>
- <tr id="i0" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/ConnectParam.html" title="class in io.milvus.param">ConnectParam</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/param/ConnectParam.Builder.html#build--">build</a></span>()</code>
- <div class="block">Verifies parameters and creates a new <a href="../../../io/milvus/param/ConnectParam.html" title="class in io.milvus.param"><code>ConnectParam</code></a> instance.</div>
- </td>
- </tr>
- <tr id="i1" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/param/ConnectParam.Builder.html#keepAliveWithoutCalls-boolean-">keepAliveWithoutCalls</a></span>(boolean enable)</code>
- <div class="block">Enables the keep-alive function for client channel.</div>
- </td>
- </tr>
- <tr id="i2" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/param/ConnectParam.Builder.html#secure-boolean-">secure</a></span>(boolean enable)</code>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
- </td>
- </tr>
- <tr id="i3" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/param/ConnectParam.Builder.html#withAuthorization-java.lang.String-">withAuthorization</a></span>(@NonNull java.lang.String authorization)</code>
- <div class="block">Sets the authorization for this connection</div>
- </td>
- </tr>
- <tr id="i4" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/param/ConnectParam.Builder.html#withAuthorization-java.lang.String-java.lang.String-">withAuthorization</a></span>(java.lang.String username,
- java.lang.String password)</code>
- <div class="block">Sets the username and password for this connection</div>
- </td>
- </tr>
- <tr id="i5" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/param/ConnectParam.Builder.html#withCaPemPath-java.lang.String-">withCaPemPath</a></span>(@NonNull java.lang.String caPemPath)</code>
- <div class="block">Set the ca.pem path for tls two-way authentication, only takes effect when "secure" is True.</div>
- </td>
- </tr>
- <tr id="i6" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/param/ConnectParam.Builder.html#withClientKeyPath-java.lang.String-">withClientKeyPath</a></span>(@NonNull java.lang.String clientKeyPath)</code>
- <div class="block">Set the client.key path for tls two-way authentication, only takes effect when "secure" is True.</div>
- </td>
- </tr>
- <tr id="i7" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/param/ConnectParam.Builder.html#withClientPemPath-java.lang.String-">withClientPemPath</a></span>(@NonNull java.lang.String clientPemPath)</code>
- <div class="block">Set the client.pem path for tls two-way authentication, only takes effect when "secure" is True.</div>
- </td>
- </tr>
- <tr id="i8" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/param/ConnectParam.Builder.html#withClientRequestId-java.lang.ThreadLocal-">withClientRequestId</a></span>(@NonNull java.lang.ThreadLocal<java.lang.String> clientRequestId)</code> </td>
- </tr>
- <tr id="i9" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/param/ConnectParam.Builder.html#withConnectTimeout-long-java.util.concurrent.TimeUnit-">withConnectTimeout</a></span>(long connectTimeout,
- @NonNull java.util.concurrent.TimeUnit timeUnit)</code>
- <div class="block">Sets the connection timeout value of client channel.</div>
- </td>
- </tr>
- <tr id="i10" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/param/ConnectParam.Builder.html#withDatabaseName-java.lang.String-">withDatabaseName</a></span>(java.lang.String databaseName)</code>
- <div class="block">Sets the database name.</div>
- </td>
- </tr>
- <tr id="i11" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/param/ConnectParam.Builder.html#withHost-java.lang.String-">withHost</a></span>(@NonNull java.lang.String host)</code>
- <div class="block">Sets the host name/address.</div>
- </td>
- </tr>
- <tr id="i12" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/param/ConnectParam.Builder.html#withIdleTimeout-long-java.util.concurrent.TimeUnit-">withIdleTimeout</a></span>(long idleTimeout,
- @NonNull java.util.concurrent.TimeUnit timeUnit)</code>
- <div class="block">Sets the idle timeout value of client channel.</div>
- </td>
- </tr>
- <tr id="i13" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/param/ConnectParam.Builder.html#withKeepAliveTime-long-java.util.concurrent.TimeUnit-">withKeepAliveTime</a></span>(long keepAliveTime,
- @NonNull java.util.concurrent.TimeUnit timeUnit)</code>
- <div class="block">Sets the keep-alive time value of client channel.</div>
- </td>
- </tr>
- <tr id="i14" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/param/ConnectParam.Builder.html#withKeepAliveTimeout-long-java.util.concurrent.TimeUnit-">withKeepAliveTimeout</a></span>(long keepAliveTimeout,
- @NonNull java.util.concurrent.TimeUnit timeUnit)</code>
- <div class="block">Sets the keep-alive timeout value of client channel.</div>
- </td>
- </tr>
- <tr id="i15" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/param/ConnectParam.Builder.html#withPort-int-">withPort</a></span>(int port)</code>
- <div class="block">Sets the connection port.</div>
- </td>
- </tr>
- <tr id="i16" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/param/ConnectParam.Builder.html#withRpcDeadline-long-java.util.concurrent.TimeUnit-">withRpcDeadline</a></span>(long deadline,
- @NonNull java.util.concurrent.TimeUnit timeUnit)</code>
- <div class="block">Set a deadline for how long you are willing to wait for a reply from the server.</div>
- </td>
- </tr>
- <tr id="i17" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/param/ConnectParam.Builder.html#withSecure-boolean-">withSecure</a></span>(boolean secure)</code>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
- </td>
- </tr>
- <tr id="i18" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/param/ConnectParam.Builder.html#withServerName-java.lang.String-">withServerName</a></span>(@NonNull java.lang.String serverName)</code>
- <div class="block">Set target name override for SSL host name checking, only takes effect when "secure" is True.</div>
- </td>
- </tr>
- <tr id="i19" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/param/ConnectParam.Builder.html#withServerPemPath-java.lang.String-">withServerPemPath</a></span>(@NonNull java.lang.String serverPemPath)</code>
- <div class="block">Set the server.pem path for tls one-way authentication, only takes effect when "secure" is True.</div>
- </td>
- </tr>
- <tr id="i20" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/param/ConnectParam.Builder.html#withToken-java.lang.String-">withToken</a></span>(java.lang.String token)</code>
- <div class="block">Sets the token</div>
- </td>
- </tr>
- <tr id="i21" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/param/ConnectParam.Builder.html#withUri-java.lang.String-">withUri</a></span>(java.lang.String uri)</code>
- <div class="block">Sets the uri</div>
- </td>
- </tr>
- </table>
- <ul class="blockList">
- <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
- <!-- -->
- </a>
- <h3>Methods inherited from class java.lang.Object</h3>
- <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- </div>
- <div class="details">
- <ul class="blockList">
- <li class="blockList">
- <!-- ============ METHOD DETAIL ========== -->
- <ul class="blockList">
- <li class="blockList"><a name="method.detail">
- <!-- -->
- </a>
- <h3>Method Detail</h3>
- <a name="withHost-java.lang.String-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>withHost</h4>
- <pre>public <a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a> withHost(@NonNull
- @NonNull java.lang.String host)</pre>
- <div class="block">Sets the host name/address.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>host</code> - host name/address</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>Builder</code></dd>
- </dl>
- </li>
- </ul>
- <a name="withPort-int-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>withPort</h4>
- <pre>public <a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a> withPort(int port)</pre>
- <div class="block">Sets the connection port. Port value must be greater than zero and less than 65536.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>port</code> - port value</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>Builder</code></dd>
- </dl>
- </li>
- </ul>
- <a name="withDatabaseName-java.lang.String-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>withDatabaseName</h4>
- <pre>public <a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a> withDatabaseName(java.lang.String databaseName)</pre>
- <div class="block">Sets the database name.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>databaseName</code> - databaseName</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>Builder</code></dd>
- </dl>
- </li>
- </ul>
- <a name="withUri-java.lang.String-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>withUri</h4>
- <pre>public <a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a> withUri(java.lang.String uri)</pre>
- <div class="block">Sets the uri</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>uri</code> - the uri of Milvus instance</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>Builder</code></dd>
- </dl>
- </li>
- </ul>
- <a name="withToken-java.lang.String-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>withToken</h4>
- <pre>public <a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a> withToken(java.lang.String token)</pre>
- <div class="block">Sets the token</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>token</code> - serving as the key for identification and authentication purposes.</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>Builder</code></dd>
- </dl>
- </li>
- </ul>
- <a name="withConnectTimeout-long-java.util.concurrent.TimeUnit-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>withConnectTimeout</h4>
- <pre>public <a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a> withConnectTimeout(long connectTimeout,
- @NonNull
- @NonNull java.util.concurrent.TimeUnit timeUnit)</pre>
- <div class="block">Sets the connection timeout value of client channel. The timeout value must be greater than zero.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>connectTimeout</code> - timeout value</dd>
- <dd><code>timeUnit</code> - timeout unit</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>Builder</code></dd>
- </dl>
- </li>
- </ul>
- <a name="withKeepAliveTime-long-java.util.concurrent.TimeUnit-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>withKeepAliveTime</h4>
- <pre>public <a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a> withKeepAliveTime(long keepAliveTime,
- @NonNull
- @NonNull java.util.concurrent.TimeUnit timeUnit)</pre>
- <div class="block">Sets the keep-alive time value of client channel. The keep-alive value must be greater than zero.
- Default is 55000 ms.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>keepAliveTime</code> - keep-alive value</dd>
- <dd><code>timeUnit</code> - keep-alive unit</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>Builder</code></dd>
- </dl>
- </li>
- </ul>
- <a name="withKeepAliveTimeout-long-java.util.concurrent.TimeUnit-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>withKeepAliveTimeout</h4>
- <pre>public <a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a> withKeepAliveTimeout(long keepAliveTimeout,
- @NonNull
- @NonNull java.util.concurrent.TimeUnit timeUnit)</pre>
- <div class="block">Sets the keep-alive timeout value of client channel. The timeout value must be greater than zero.
- Default value is 20000 ms</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>keepAliveTimeout</code> - timeout value</dd>
- <dd><code>timeUnit</code> - timeout unit</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>Builder</code></dd>
- </dl>
- </li>
- </ul>
- <a name="keepAliveWithoutCalls-boolean-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>keepAliveWithoutCalls</h4>
- <pre>public <a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a> keepAliveWithoutCalls(boolean enable)</pre>
- <div class="block">Enables the keep-alive function for client channel.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>enable</code> - true keep-alive</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>Builder</code></dd>
- </dl>
- </li>
- </ul>
- <a name="secure-boolean-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>secure</h4>
- <pre>@Deprecated
- public <a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a> secure(boolean enable)</pre>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
- <div class="block">Enables the secure for client channel.
- Deprecated from v2.3.6, this flag is auto-detected, no need to specify</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>enable</code> - true keep-alive</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>Builder</code></dd>
- </dl>
- </li>
- </ul>
- <a name="withIdleTimeout-long-java.util.concurrent.TimeUnit-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>withIdleTimeout</h4>
- <pre>public <a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a> withIdleTimeout(long idleTimeout,
- @NonNull
- @NonNull java.util.concurrent.TimeUnit timeUnit)</pre>
- <div class="block">Sets the idle timeout value of client channel. The timeout value must be larger than zero.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>idleTimeout</code> - timeout value</dd>
- <dd><code>timeUnit</code> - timeout unit</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>Builder</code></dd>
- </dl>
- </li>
- </ul>
- <a name="withRpcDeadline-long-java.util.concurrent.TimeUnit-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>withRpcDeadline</h4>
- <pre>public <a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a> withRpcDeadline(long deadline,
- @NonNull
- @NonNull java.util.concurrent.TimeUnit timeUnit)</pre>
- <div class="block">Set a deadline for how long you are willing to wait for a reply from the server.
- With a deadline setting, the client will wait when encounter fast RPC fail caused by network fluctuations.
- The deadline value must be larger than or equal to zero. Default value is 0, deadline is disabled.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>deadline</code> - deadline value</dd>
- <dd><code>timeUnit</code> - deadline unit</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>Builder</code></dd>
- </dl>
- </li>
- </ul>
- <a name="withAuthorization-java.lang.String-java.lang.String-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>withAuthorization</h4>
- <pre>public <a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a> withAuthorization(java.lang.String username,
- java.lang.String password)</pre>
- <div class="block">Sets the username and password for this connection</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>username</code> - current user</dd>
- <dd><code>password</code> - password</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>Builder</code></dd>
- </dl>
- </li>
- </ul>
- <a name="withSecure-boolean-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>withSecure</h4>
- <pre>@Deprecated
- public <a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a> withSecure(boolean secure)</pre>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
- <div class="block">Sets secure the authorization for this connection, set to True to enable TLS
- Deprecated from v2.3.6, this flag is auto-detected, no need to specify</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>secure</code> - boolean</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>Builder</code></dd>
- </dl>
- </li>
- </ul>
- <a name="withAuthorization-java.lang.String-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>withAuthorization</h4>
- <pre>public <a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a> withAuthorization(@NonNull
- @NonNull java.lang.String authorization)</pre>
- <div class="block">Sets the authorization for this connection</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>authorization</code> - the encoded authorization info that has included the encoded username and password info</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>Builder</code></dd>
- </dl>
- </li>
- </ul>
- <a name="withClientKeyPath-java.lang.String-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>withClientKeyPath</h4>
- <pre>public <a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a> withClientKeyPath(@NonNull
- @NonNull java.lang.String clientKeyPath)</pre>
- <div class="block">Set the client.key path for tls two-way authentication, only takes effect when "secure" is True.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>clientKeyPath</code> - path of client.key</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>Builder</code></dd>
- </dl>
- </li>
- </ul>
- <a name="withClientPemPath-java.lang.String-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>withClientPemPath</h4>
- <pre>public <a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a> withClientPemPath(@NonNull
- @NonNull java.lang.String clientPemPath)</pre>
- <div class="block">Set the client.pem path for tls two-way authentication, only takes effect when "secure" is True.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>clientPemPath</code> - path of client.pem</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>Builder</code></dd>
- </dl>
- </li>
- </ul>
- <a name="withCaPemPath-java.lang.String-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>withCaPemPath</h4>
- <pre>public <a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a> withCaPemPath(@NonNull
- @NonNull java.lang.String caPemPath)</pre>
- <div class="block">Set the ca.pem path for tls two-way authentication, only takes effect when "secure" is True.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>caPemPath</code> - path of ca.pem</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>Builder</code></dd>
- </dl>
- </li>
- </ul>
- <a name="withServerPemPath-java.lang.String-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>withServerPemPath</h4>
- <pre>public <a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a> withServerPemPath(@NonNull
- @NonNull java.lang.String serverPemPath)</pre>
- <div class="block">Set the server.pem path for tls one-way authentication, only takes effect when "secure" is True.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>serverPemPath</code> - path of server.pem</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>Builder</code></dd>
- </dl>
- </li>
- </ul>
- <a name="withServerName-java.lang.String-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>withServerName</h4>
- <pre>public <a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a> withServerName(@NonNull
- @NonNull java.lang.String serverName)</pre>
- <div class="block">Set target name override for SSL host name checking, only takes effect when "secure" is True.
- Note: this value is passed to grpc.ssl_target_name_override</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>serverName</code> - override name for SSL host</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>Builder</code></dd>
- </dl>
- </li>
- </ul>
- <a name="withClientRequestId-java.lang.ThreadLocal-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>withClientRequestId</h4>
- <pre>public <a href="../../../io/milvus/param/ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a> withClientRequestId(@NonNull
- @NonNull java.lang.ThreadLocal<java.lang.String> clientRequestId)</pre>
- </li>
- </ul>
- <a name="build--">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>build</h4>
- <pre>public <a href="../../../io/milvus/param/ConnectParam.html" title="class in io.milvus.param">ConnectParam</a> build()
- throws <a href="../../../io/milvus/exception/ParamException.html" title="class in io.milvus.exception">ParamException</a></pre>
- <div class="block">Verifies parameters and creates a new <a href="../../../io/milvus/param/ConnectParam.html" title="class in io.milvus.param"><code>ConnectParam</code></a> instance.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><a href="../../../io/milvus/param/ConnectParam.html" title="class in io.milvus.param"><code>ConnectParam</code></a></dd>
- <dt><span class="throwsLabel">Throws:</span></dt>
- <dd><code><a href="../../../io/milvus/exception/ParamException.html" title="class in io.milvus.exception">ParamException</a></code></dd>
- </dl>
- </li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- </div>
- </div>
- <!-- ========= END OF CLASS DATA ========= -->
- <!-- ======= START OF BOTTOM NAVBAR ====== -->
- <div class="bottomNav"><a name="navbar.bottom">
- <!-- -->
- </a>
- <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
- <a name="navbar.bottom.firstrow">
- <!-- -->
- </a>
- <ul class="navList" title="Navigation">
- <li><a href="../../../overview-summary.html">Overview</a></li>
- <li><a href="package-summary.html">Package</a></li>
- <li class="navBarCell1Rev">Class</li>
- <li><a href="package-tree.html">Tree</a></li>
- <li><a href="../../../deprecated-list.html">Deprecated</a></li>
- <li><a href="../../../index-files/index-1.html">Index</a></li>
- <li><a href="../../../help-doc.html">Help</a></li>
- </ul>
- </div>
- <div class="subNav">
- <ul class="navList">
- <li><a href="../../../io/milvus/param/ConnectParam.html" title="class in io.milvus.param"><span class="typeNameLink">Prev Class</span></a></li>
- <li><a href="../../../io/milvus/param/Constant.html" title="class in io.milvus.param"><span class="typeNameLink">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../../../index.html?io/milvus/param/ConnectParam.Builder.html" target="_top">Frames</a></li>
- <li><a href="ConnectParam.Builder.html" target="_top">No Frames</a></li>
- </ul>
- <ul class="navList" id="allclasses_navbar_bottom">
- <li><a href="../../../allclasses-noframe.html">All Classes</a></li>
- </ul>
- <div>
- <script type="text/javascript"><!--
- allClassesLink = document.getElementById("allclasses_navbar_bottom");
- if(window==top) {
- allClassesLink.style.display = "block";
- }
- else {
- allClassesLink.style.display = "none";
- }
- //-->
- </script>
- </div>
- <div>
- <ul class="subNavList">
- <li>Summary: </li>
- <li>Nested | </li>
- <li>Field | </li>
- <li>Constr | </li>
- <li><a href="#method.summary">Method</a></li>
- </ul>
- <ul class="subNavList">
- <li>Detail: </li>
- <li>Field | </li>
- <li>Constr | </li>
- <li><a href="#method.detail">Method</a></li>
- </ul>
- </div>
- <a name="skip.navbar.bottom">
- <!-- -->
- </a></div>
- <!-- ======== END OF BOTTOM NAVBAR ======= -->
- </body>
- </html>
|