milvus
/
milvus-sdk-java
mirror of https://github.com/milvus-io/milvus-sdk-java.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884
							<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Wed Nov 08 12:07:04 CST 2023 -->
<title>ConnectParam.Builder</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-11-08">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../jquery/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-ui.min.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 data = {"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":10,"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";
var pathtoroot = "../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../index.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" id="allclasses_navbar_top">
<li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">io.milvus.param</a></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><code><a href="MultiConnectParam.Builder.html" title="class in io.milvus.param">MultiConnectParam.Builder</a></code></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="ConnectParam.html" title="class in io.milvus.param">ConnectParam</a></dd>
</dl>
<hr>
<pre>public static class <span class="typeNameLabel">ConnectParam.Builder</span>
extends java.lang.Object</pre>
<div class="block">Builder for <a href="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">
<!-- =========== FIELD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!--   -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#secure">secure</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!--   -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colSecond" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">Builder</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="ConnectParam.html" title="class in io.milvus.param">ConnectParam</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#build()">build</a></span>()</code></th>
<td class="colLast">
<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>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#keepAliveWithoutCalls(boolean)">keepAliveWithoutCalls</a></span>&#8203;(boolean&nbsp;enable)</code></th>
<td class="colLast">
<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="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#secure(boolean)">secure</a></span>&#8203;(boolean&nbsp;enable)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#verify()">verify</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
<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>
<td class="colLast">
<div class="block">Sets the secure for this connection</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withAuthorization(java.lang.String,java.lang.String)">withAuthorization</a></span>&#8203;(java.lang.String&nbsp;username,
                 java.lang.String&nbsp;password)</code></th>
<td class="colLast">
<div class="block">Sets the username and password for this connection</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withCaPemPath(java.lang.String)">withCaPemPath</a></span>&#8203;(@NonNull java.lang.String&nbsp;caPemPath)</code></th>
<td class="colLast">
<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="i7" class="rowColor">
<td class="colFirst"><code><a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withClientKeyPath(java.lang.String)">withClientKeyPath</a></span>&#8203;(@NonNull java.lang.String&nbsp;clientKeyPath)</code></th>
<td class="colLast">
<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="i8" class="altColor">
<td class="colFirst"><code><a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withClientPemPath(java.lang.String)">withClientPemPath</a></span>&#8203;(@NonNull java.lang.String&nbsp;clientPemPath)</code></th>
<td class="colLast">
<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="i9" class="rowColor">
<td class="colFirst"><code><a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withConnectTimeout(long,java.util.concurrent.TimeUnit)">withConnectTimeout</a></span>&#8203;(long&nbsp;connectTimeout,
                  @NonNull java.util.concurrent.TimeUnit&nbsp;timeUnit)</code></th>
<td class="colLast">
<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="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withDatabaseName(java.lang.String)">withDatabaseName</a></span>&#8203;(java.lang.String&nbsp;databaseName)</code></th>
<td class="colLast">
<div class="block">Sets the database name.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
<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>
<td class="colLast">
<div class="block">Sets the host name/address.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withIdleTimeout(long,java.util.concurrent.TimeUnit)">withIdleTimeout</a></span>&#8203;(long&nbsp;idleTimeout,
               @NonNull java.util.concurrent.TimeUnit&nbsp;timeUnit)</code></th>
<td class="colLast">
<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="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withKeepAliveTime(long,java.util.concurrent.TimeUnit)">withKeepAliveTime</a></span>&#8203;(long&nbsp;keepAliveTime,
                 @NonNull java.util.concurrent.TimeUnit&nbsp;timeUnit)</code></th>
<td class="colLast">
<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="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withKeepAliveTimeout(long,java.util.concurrent.TimeUnit)">withKeepAliveTimeout</a></span>&#8203;(long&nbsp;keepAliveTimeout,
                    @NonNull java.util.concurrent.TimeUnit&nbsp;timeUnit)</code></th>
<td class="colLast">
<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="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withPort(int)">withPort</a></span>&#8203;(int&nbsp;port)</code></th>
<td class="colLast">
<div class="block">Sets the connection port.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withRpcDeadline(long,java.util.concurrent.TimeUnit)">withRpcDeadline</a></span>&#8203;(long&nbsp;deadline,
               @NonNull java.util.concurrent.TimeUnit&nbsp;timeUnit)</code></th>
<td class="colLast">
<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="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withSecure(boolean)">withSecure</a></span>&#8203;(boolean&nbsp;secure)</code></th>
<td class="colLast">
<div class="block">Sets secure the authorization for this connection, set to True to enable TLS</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withServerName(java.lang.String)">withServerName</a></span>&#8203;(@NonNull java.lang.String&nbsp;serverName)</code></th>
<td class="colLast">
<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="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withServerPemPath(java.lang.String)">withServerPemPath</a></span>&#8203;(@NonNull java.lang.String&nbsp;serverPemPath)</code></th>
<td class="colLast">
<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="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withToken(java.lang.String)">withToken</a></span>&#8203;(java.lang.String&nbsp;token)</code></th>
<td class="colLast">
<div class="block">Sets the token</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code><a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a></code></td>
<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>
<td class="colLast">
<div class="block">Sets the uri</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!--   -->
</a>
<h3>Field Detail</h3>
<a id="secure">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>secure</h4>
<pre>protected&nbsp;boolean secure</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Builder</h4>
<pre>protected&nbsp;Builder()</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a id="withHost(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withHost</h4>
<pre class="methodSignature">public&nbsp;<a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a>&nbsp;withHost&#8203;(@NonNull
                                     @NonNull java.lang.String&nbsp;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 id="withPort(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withPort</h4>
<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>
<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 id="withDatabaseName(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withDatabaseName</h4>
<pre class="methodSignature">public&nbsp;<a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a>&nbsp;withDatabaseName&#8203;(java.lang.String&nbsp;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 id="withUri(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withUri</h4>
<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>
<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 id="withToken(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withToken</h4>
<pre class="methodSignature">public&nbsp;<a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a>&nbsp;withToken&#8203;(java.lang.String&nbsp;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 id="withConnectTimeout(long,java.util.concurrent.TimeUnit)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withConnectTimeout</h4>
<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,
                                               @NonNull
                                               @NonNull java.util.concurrent.TimeUnit&nbsp;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 id="withKeepAliveTime(long,java.util.concurrent.TimeUnit)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withKeepAliveTime</h4>
<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,
                                              @NonNull
                                              @NonNull java.util.concurrent.TimeUnit&nbsp;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 id="withKeepAliveTimeout(long,java.util.concurrent.TimeUnit)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withKeepAliveTimeout</h4>
<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,
                                                 @NonNull
                                                 @NonNull java.util.concurrent.TimeUnit&nbsp;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 id="keepAliveWithoutCalls(boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keepAliveWithoutCalls</h4>
<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>
<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 id="secure(boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>secure</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;<a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a>&nbsp;secure&#8203;(boolean&nbsp;enable)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Enables the secure 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 id="withIdleTimeout(long,java.util.concurrent.TimeUnit)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withIdleTimeout</h4>
<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,
                                            @NonNull
                                            @NonNull java.util.concurrent.TimeUnit&nbsp;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 id="withRpcDeadline(long,java.util.concurrent.TimeUnit)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withRpcDeadline</h4>
<pre class="methodSignature">public&nbsp;<a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a>&nbsp;withRpcDeadline&#8203;(long&nbsp;deadline,
                                            @NonNull
                                            @NonNull java.util.concurrent.TimeUnit&nbsp;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 id="withAuthorization(java.lang.String,java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withAuthorization</h4>
<pre class="methodSignature">public&nbsp;<a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a>&nbsp;withAuthorization&#8203;(java.lang.String&nbsp;username,
                                              java.lang.String&nbsp;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 id="withSecure(boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withSecure</h4>
<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>
<div class="block">Sets secure the authorization for this connection, set to True to enable TLS</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 id="withAuthorization(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withAuthorization</h4>
<pre class="methodSignature">public&nbsp;<a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a>&nbsp;withAuthorization&#8203;(@NonNull
                                              @NonNull java.lang.String&nbsp;authorization)</pre>
<div class="block">Sets the secure for this connection</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>authorization</code> - the 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 id="withClientKeyPath(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withClientKeyPath</h4>
<pre class="methodSignature">public&nbsp;<a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a>&nbsp;withClientKeyPath&#8203;(@NonNull
                                              @NonNull java.lang.String&nbsp;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 id="withClientPemPath(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withClientPemPath</h4>
<pre class="methodSignature">public&nbsp;<a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a>&nbsp;withClientPemPath&#8203;(@NonNull
                                              @NonNull java.lang.String&nbsp;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 id="withCaPemPath(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withCaPemPath</h4>
<pre class="methodSignature">public&nbsp;<a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a>&nbsp;withCaPemPath&#8203;(@NonNull
                                          @NonNull java.lang.String&nbsp;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 id="withServerPemPath(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withServerPemPath</h4>
<pre class="methodSignature">public&nbsp;<a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a>&nbsp;withServerPemPath&#8203;(@NonNull
                                              @NonNull java.lang.String&nbsp;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 id="withServerName(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withServerName</h4>
<pre class="methodSignature">public&nbsp;<a href="ConnectParam.Builder.html" title="class in io.milvus.param">ConnectParam.Builder</a>&nbsp;withServerName&#8203;(@NonNull
                                           @NonNull java.lang.String&nbsp;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 id="build()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>build</h4>
<pre class="methodSignature">public&nbsp;<a href="ConnectParam.html" title="class in io.milvus.param">ConnectParam</a>&nbsp;build()
                   throws <a href="../exception/ParamException.html" title="class in io.milvus.exception">ParamException</a></pre>
<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>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="ConnectParam.html" title="class in io.milvus.param"><code>ConnectParam</code></a></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../exception/ParamException.html" title="class in io.milvus.exception">ParamException</a></code></dd>
</dl>
</li>
</ul>
<a id="verify()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>verify</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;verify()
               throws <a href="../exception/ParamException.html" title="class in io.milvus.exception">ParamException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../exception/ParamException.html" title="class in io.milvus.exception">ParamException</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../index.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" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses.html">All&nbsp;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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>