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


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408
							<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.13) on Mon Jan 24 16:25:44 CST 2022 -->
<title>FlushParam.Builder</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2022-01-24">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.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.5.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="FlushParam.Builder";
        }
    }
    catch(err) {
    }
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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.collection</a></div>
<h2 title="Class FlushParam.Builder" class="title">Class FlushParam.Builder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>io.milvus.param.collection.FlushParam.Builder</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Enclosing class:</dt>
<dd><a href="FlushParam.html" title="class in io.milvus.param.collection">FlushParam</a></dd>
</dl>
<hr>
<pre>public static final class <span class="typeNameLabel">FlushParam.Builder</span>
extends java.lang.Object</pre>
<div class="block">Builder for <code>FlushParam</code> class.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<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></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="FlushParam.Builder.html" title="class in io.milvus.param.collection">FlushParam.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addCollectionName(java.lang.String)">addCollectionName</a></span>&#8203;(@NonNull java.lang.String&nbsp;collectionName)</code></th>
<td class="colLast">
<div class="block">Adds a collection to be flushed.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="FlushParam.html" title="class in io.milvus.param.collection">FlushParam</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 <code>FlushParam</code> instance.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="FlushParam.Builder.html" title="class in io.milvus.param.collection">FlushParam.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withCollectionNames(java.util.List)">withCollectionNames</a></span>&#8203;(@NonNull java.util.List&lt;java.lang.String&gt;&nbsp;collectionNames)</code></th>
<td class="colLast">
<div class="block">Sets a list of collections to be flushed.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="FlushParam.Builder.html" title="class in io.milvus.param.collection">FlushParam.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withSyncFlush(java.lang.Boolean)">withSyncFlush</a></span>&#8203;(@NonNull java.lang.Boolean&nbsp;syncFlush)</code></th>
<td class="colLast">
<div class="block">Sets the flush function to sync mode.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="FlushParam.Builder.html" title="class in io.milvus.param.collection">FlushParam.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withSyncFlushWaitingInterval(java.lang.Long)">withSyncFlushWaitingInterval</a></span>&#8203;(@NonNull java.lang.Long&nbsp;milliseconds)</code></th>
<td class="colLast">
<div class="block">Sets waiting interval in sync mode.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="FlushParam.Builder.html" title="class in io.milvus.param.collection">FlushParam.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withSyncFlushWaitingTimeout(java.lang.Long)">withSyncFlushWaitingTimeout</a></span>&#8203;(@NonNull java.lang.Long&nbsp;seconds)</code></th>
<td class="colLast">
<div class="block">Sets timeout value for sync mode.</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">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a id="withCollectionNames(java.util.List)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withCollectionNames</h4>
<pre class="methodSignature">public&nbsp;<a href="FlushParam.Builder.html" title="class in io.milvus.param.collection">FlushParam.Builder</a>&nbsp;withCollectionNames&#8203;(@NonNull
                                              @NonNull java.util.List&lt;java.lang.String&gt;&nbsp;collectionNames)</pre>
<div class="block">Sets a list of collections to be flushed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>collectionNames</code> - a list of collections</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>Builder</code></dd>
</dl>
</li>
</ul>
<a id="addCollectionName(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addCollectionName</h4>
<pre class="methodSignature">public&nbsp;<a href="FlushParam.Builder.html" title="class in io.milvus.param.collection">FlushParam.Builder</a>&nbsp;addCollectionName&#8203;(@NonNull
                                            @NonNull java.lang.String&nbsp;collectionName)</pre>
<div class="block">Adds a collection to be flushed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>collectionName</code> - name of the collections</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>Builder</code></dd>
</dl>
</li>
</ul>
<a id="withSyncFlush(java.lang.Boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withSyncFlush</h4>
<pre class="methodSignature">public&nbsp;<a href="FlushParam.Builder.html" title="class in io.milvus.param.collection">FlushParam.Builder</a>&nbsp;withSyncFlush&#8203;(@NonNull
                                        @NonNull java.lang.Boolean&nbsp;syncFlush)</pre>
<div class="block">Sets the flush function to sync mode.
 With sync mode enabled, the client keeps waiting until all segments of the collection successfully flushed.

 If sync mode disabled, client returns at once after the flush() is called.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>syncFlush</code> - <code>Boolean.TRUE</code> is sync mode, <code>Boolean.FALSE</code> is not</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>Builder</code></dd>
</dl>
</li>
</ul>
<a id="withSyncFlushWaitingInterval(java.lang.Long)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withSyncFlushWaitingInterval</h4>
<pre class="methodSignature">public&nbsp;<a href="FlushParam.Builder.html" title="class in io.milvus.param.collection">FlushParam.Builder</a>&nbsp;withSyncFlushWaitingInterval&#8203;(@NonNull
                                                       @NonNull java.lang.Long&nbsp;milliseconds)</pre>
<div class="block">Sets waiting interval in sync mode. With sync mode enabled, the client will constantly check segments state by interval.
 Interval must be greater than zero, and cannot be greater than Constant.MAX_WAITING_FLUSHING_INTERVAL.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>milliseconds</code> - interval</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>Builder</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../Constant.html" title="class in io.milvus.param"><code>Constant</code></a></dd>
</dl>
</li>
</ul>
<a id="withSyncFlushWaitingTimeout(java.lang.Long)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withSyncFlushWaitingTimeout</h4>
<pre class="methodSignature">public&nbsp;<a href="FlushParam.Builder.html" title="class in io.milvus.param.collection">FlushParam.Builder</a>&nbsp;withSyncFlushWaitingTimeout&#8203;(@NonNull
                                                      @NonNull java.lang.Long&nbsp;seconds)</pre>
<div class="block">Sets timeout value for sync mode.
 Timeout value must be greater than zero, and cannot be greater than Constant.MAX_WAITING_FLUSHING_TIMEOUT.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>seconds</code> - time out value for sync mode</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>Builder</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../Constant.html" title="class in io.milvus.param"><code>Constant</code></a></dd>
</dl>
</li>
</ul>
<a id="build()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>build</h4>
<pre class="methodSignature">public&nbsp;<a href="FlushParam.html" title="class in io.milvus.param.collection">FlushParam</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 <code>FlushParam</code> instance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>FlushParam</code></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>
</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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>