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


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418
							<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.13) on Thu Jan 27 15:31:54 CST 2022 -->
<title>MilvusServiceClient</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2022-01-27">
<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="MilvusServiceClient";
        }
    }
    catch(err) {
    }
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":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><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>Field&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.client</a></div>
<h2 title="Class MilvusServiceClient" class="title">Class MilvusServiceClient</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="AbstractMilvusGrpcClient.html" title="class in io.milvus.client">io.milvus.client.AbstractMilvusGrpcClient</a></li>
<li>
<ul class="inheritance">
<li>io.milvus.client.MilvusServiceClient</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">MilvusServiceClient</span>
extends <a href="AbstractMilvusGrpcClient.html" title="class in io.milvus.client">AbstractMilvusGrpcClient</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<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">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(io.milvus.param.ConnectParam)">MilvusServiceClient</a></span>&#8203;(@NonNull <a href="../param/ConnectParam.html" title="class in io.milvus.param">ConnectParam</a>&nbsp;connectParam)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== 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>protected io.milvus.grpc.MilvusServiceGrpc.MilvusServiceBlockingStub</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#blockingStub()">blockingStub</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clientIsReady()">clientIsReady</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close(long)">close</a></span>&#8203;(long&nbsp;maxWaitSeconds)</code></th>
<td class="colLast">
<div class="block">Disconnects from a Milvus server with configurable timeout.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected io.milvus.grpc.MilvusServiceGrpc.MilvusServiceFutureStub</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#futureStub()">futureStub</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withTimeout(long,java.util.concurrent.TimeUnit)">withTimeout</a></span>&#8203;(long&nbsp;timeout,
           java.util.concurrent.TimeUnit&nbsp;timeoutUnit)</code></th>
<td class="colLast">
<div class="block">Timeout setting for rpc call.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.io.milvus.client.AbstractMilvusGrpcClient">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;io.milvus.client.<a href="AbstractMilvusGrpcClient.html" title="class in io.milvus.client">AbstractMilvusGrpcClient</a></h3>
<code><a href="AbstractMilvusGrpcClient.html#alterAlias(io.milvus.param.alias.AlterAliasParam)">alterAlias</a>, <a href="AbstractMilvusGrpcClient.html#calcDistance(io.milvus.param.dml.CalcDistanceParam)">calcDistance</a>, <a href="AbstractMilvusGrpcClient.html#createAlias(io.milvus.param.alias.CreateAliasParam)">createAlias</a>, <a href="AbstractMilvusGrpcClient.html#createCollection(io.milvus.param.collection.CreateCollectionParam)">createCollection</a>, <a href="AbstractMilvusGrpcClient.html#createIndex(io.milvus.param.index.CreateIndexParam)">createIndex</a>, <a href="AbstractMilvusGrpcClient.html#createPartition(io.milvus.param.partition.CreatePartitionParam)">createPartition</a>, <a href="AbstractMilvusGrpcClient.html#delete(io.milvus.param.dml.DeleteParam)">delete</a>, <a href="AbstractMilvusGrpcClient.html#describeCollection(io.milvus.param.collection.DescribeCollectionParam)">describeCollection</a>, <a href="AbstractMilvusGrpcClient.html#describeIndex(io.milvus.param.index.DescribeIndexParam)">describeIndex</a>, <a href="AbstractMilvusGrpcClient.html#dropAlias(io.milvus.param.alias.DropAliasParam)">dropAlias</a>, <a href="AbstractMilvusGrpcClient.html#dropCollection(io.milvus.param.collection.DropCollectionParam)">dropCollection</a>, <a href="AbstractMilvusGrpcClient.html#dropIndex(io.milvus.param.index.DropIndexParam)">dropIndex</a>, <a href="AbstractMilvusGrpcClient.html#dropPartition(io.milvus.param.partition.DropPartitionParam)">dropPartition</a>, <a href="AbstractMilvusGrpcClient.html#getCollectionStatistics(io.milvus.param.collection.GetCollectionStatisticsParam)">getCollectionStatistics</a>, <a href="AbstractMilvusGrpcClient.html#getCompactionState(io.milvus.param.control.GetCompactionStateParam)">getCompactionState</a>, <a href="AbstractMilvusGrpcClient.html#getCompactionStateWithPlans(io.milvus.param.control.GetCompactionPlansParam)">getCompactionStateWithPlans</a>, <a href="AbstractMilvusGrpcClient.html#getFlushState(io.milvus.param.control.GetFlushStateParam)">getFlushState</a>, <a href="AbstractMilvusGrpcClient.html#getIndexBuildProgress(io.milvus.param.index.GetIndexBuildProgressParam)">getIndexBuildProgress</a>, <a href="AbstractMilvusGrpcClient.html#getIndexState(io.milvus.param.index.GetIndexStateParam)">getIndexState</a>, <a href="AbstractMilvusGrpcClient.html#getMetrics(io.milvus.param.control.GetMetricsParam)">getMetrics</a>, <a href="AbstractMilvusGrpcClient.html#getPartitionStatistics(io.milvus.param.partition.GetPartitionStatisticsParam)">getPartitionStatistics</a>, <a href="AbstractMilvusGrpcClient.html#getPersistentSegmentInfo(io.milvus.param.control.GetPersistentSegmentInfoParam)">getPersistentSegmentInfo</a>, <a href="AbstractMilvusGrpcClient.html#getQuerySegmentInfo(io.milvus.param.control.GetQuerySegmentInfoParam)">getQuerySegmentInfo</a>, <a href="AbstractMilvusGrpcClient.html#hasCollection(io.milvus.param.collection.HasCollectionParam)">hasCollection</a>, <a href="AbstractMilvusGrpcClient.html#hasPartition(io.milvus.param.partition.HasPartitionParam)">hasPartition</a>, <a href="AbstractMilvusGrpcClient.html#insert(io.milvus.param.dml.InsertParam)">insert</a>, <a href="AbstractMilvusGrpcClient.html#loadBalance(io.milvus.param.control.LoadBalanceParam)">loadBalance</a>, <a href="AbstractMilvusGrpcClient.html#loadCollection(io.milvus.param.collection.LoadCollectionParam)">loadCollection</a>, <a href="AbstractMilvusGrpcClient.html#loadPartitions(io.milvus.param.partition.LoadPartitionsParam)">loadPartitions</a>, <a href="AbstractMilvusGrpcClient.html#manualCompaction(io.milvus.param.control.ManualCompactionParam)">manualCompaction</a>, <a href="AbstractMilvusGrpcClient.html#query(io.milvus.param.dml.QueryParam)">query</a>, <a href="AbstractMilvusGrpcClient.html#releaseCollection(io.milvus.param.collection.ReleaseCollectionParam)">releaseCollection</a>, <a href="AbstractMilvusGrpcClient.html#releasePartitions(io.milvus.param.partition.ReleasePartitionsParam)">releasePartitions</a>, <a href="AbstractMilvusGrpcClient.html#search(io.milvus.param.dml.SearchParam)">search</a>, <a href="AbstractMilvusGrpcClient.html#showCollections(io.milvus.param.collection.ShowCollectionsParam)">showCollections</a>, <a href="AbstractMilvusGrpcClient.html#showPartitions(io.milvus.param.partition.ShowPartitionsParam)">showPartitions</a></code></li>
</ul>
<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>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.io.milvus.client.MilvusClient">
<!--   -->
</a>
<h3>Methods inherited from interface&nbsp;io.milvus.client.<a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></h3>
<code><a href="MilvusClient.html#close()">close</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(io.milvus.param.ConnectParam)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MilvusServiceClient</h4>
<pre>public&nbsp;MilvusServiceClient&#8203;(@NonNull
                           @NonNull <a href="../param/ConnectParam.html" title="class in io.milvus.param">ConnectParam</a>&nbsp;connectParam)</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a id="blockingStub()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>blockingStub</h4>
<pre class="methodSignature">protected&nbsp;io.milvus.grpc.MilvusServiceGrpc.MilvusServiceBlockingStub&nbsp;blockingStub()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="AbstractMilvusGrpcClient.html#blockingStub()">blockingStub</a></code>&nbsp;in class&nbsp;<code><a href="AbstractMilvusGrpcClient.html" title="class in io.milvus.client">AbstractMilvusGrpcClient</a></code></dd>
</dl>
</li>
</ul>
<a id="futureStub()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>futureStub</h4>
<pre class="methodSignature">protected&nbsp;io.milvus.grpc.MilvusServiceGrpc.MilvusServiceFutureStub&nbsp;futureStub()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="AbstractMilvusGrpcClient.html#futureStub()">futureStub</a></code>&nbsp;in class&nbsp;<code><a href="AbstractMilvusGrpcClient.html" title="class in io.milvus.client">AbstractMilvusGrpcClient</a></code></dd>
</dl>
</li>
</ul>
<a id="clientIsReady()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clientIsReady</h4>
<pre class="methodSignature">protected&nbsp;boolean&nbsp;clientIsReady()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="AbstractMilvusGrpcClient.html#clientIsReady()">clientIsReady</a></code>&nbsp;in class&nbsp;<code><a href="AbstractMilvusGrpcClient.html" title="class in io.milvus.client">AbstractMilvusGrpcClient</a></code></dd>
</dl>
</li>
</ul>
<a id="close(long)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;close&#8203;(long&nbsp;maxWaitSeconds)
           throws java.lang.InterruptedException</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#close(long)">MilvusClient</a></code></span></div>
<div class="block">Disconnects from a Milvus server with configurable timeout.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxWaitSeconds</code> - timeout unit: second</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.InterruptedException</code></dd>
</dl>
</li>
</ul>
<a id="withTimeout(long,java.util.concurrent.TimeUnit)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>withTimeout</h4>
<pre class="methodSignature">public&nbsp;<a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a>&nbsp;withTimeout&#8203;(long&nbsp;timeout,
                                java.util.concurrent.TimeUnit&nbsp;timeoutUnit)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#withTimeout(long,java.util.concurrent.TimeUnit)">MilvusClient</a></code></span></div>
<div class="block">Timeout setting for rpc call.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timeout</code> - set time waiting for a rpc call.</dd>
<dd><code>timeoutUnit</code> - time unit</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><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>Field&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>