|
|
@@ -2,9 +2,9 @@
|
|
|
<!-- NewPage -->
|
|
|
<html lang="en">
|
|
|
<head>
|
|
|
-<!-- Generated by javadoc (1.8.0_251) on Sat Feb 11 00:14:25 CST 2023 -->
|
|
|
+<!-- Generated by javadoc (1.8.0_251) on Sun Mar 26 19:16:12 CST 2023 -->
|
|
|
<title>AbstractMilvusGrpcClient</title>
|
|
|
-<meta name="date" content="2023-02-11">
|
|
|
+<meta name="date" content="2023-03-26">
|
|
|
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
|
|
|
<script type="text/javascript" src="../../../script.js"></script>
|
|
|
</head>
|
|
|
@@ -18,7 +18,7 @@
|
|
|
catch(err) {
|
|
|
}
|
|
|
//-->
|
|
|
-var methods = {"i0":10,"i1":10,"i2":6,"i3":10,"i4":10,"i5":6,"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,"i22":6,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":42,"i29":42,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10,"i57":10,"i58":10,"i59":10,"i60":10,"i61":10,"i62":10,"i63":10};
|
|
|
+var methods = {"i0":10,"i1":10,"i2":10,"i3":6,"i4":10,"i5":10,"i6":6,"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,"i22":10,"i23":6,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":42,"i30":42,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10,"i57":10,"i58":10,"i59":10,"i60":10,"i61":10,"i62":10,"i63":10,"i64":10};
|
|
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
|
|
|
var altColor = "altColor";
|
|
|
var rowColor = "rowColor";
|
|
|
@@ -167,368 +167,374 @@ implements <a href="../../../io/milvus/client/MilvusClient.html" title="interfac
|
|
|
</td>
|
|
|
</tr>
|
|
|
<tr id="i2" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#alterCollection-io.milvus.param.collection.AlterCollectionParam-">alterCollection</a></span>(<a href="../../../io/milvus/param/collection/AlterCollectionParam.html" title="class in io.milvus.param.collection">AlterCollectionParam</a> requestParam)</code>
|
|
|
+<div class="block">Alter collection.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i3" class="rowColor">
|
|
|
<td class="colFirst"><code>protected abstract io.milvus.grpc.MilvusServiceGrpc.MilvusServiceBlockingStub</code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#blockingStub--">blockingStub</a></span>()</code> </td>
|
|
|
</tr>
|
|
|
-<tr id="i3" class="rowColor">
|
|
|
+<tr id="i4" class="altColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ImportResponse></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#bulkInsert-io.milvus.param.bulkinsert.BulkInsertParam-">bulkInsert</a></span>(<a href="../../../io/milvus/param/bulkinsert/BulkInsertParam.html" title="class in io.milvus.param.bulkinsert">BulkInsertParam</a> requestParam)</code>
|
|
|
<div class="block">Import data from external files, currently support JSON format</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i4" class="altColor">
|
|
|
+<tr id="i5" class="rowColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.CheckHealthResponse></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#checkHealth--">checkHealth</a></span>()</code>
|
|
|
<div class="block">Check server health</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i5" class="rowColor">
|
|
|
+<tr id="i6" class="altColor">
|
|
|
<td class="colFirst"><code>protected abstract boolean</code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#clientIsReady--">clientIsReady</a></span>()</code> </td>
|
|
|
</tr>
|
|
|
-<tr id="i6" class="altColor">
|
|
|
+<tr id="i7" class="rowColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#createAlias-io.milvus.param.alias.CreateAliasParam-">createAlias</a></span>(@NonNull <a href="../../../io/milvus/param/alias/CreateAliasParam.html" title="class in io.milvus.param.alias">CreateAliasParam</a> requestParam)</code>
|
|
|
<div class="block">Creates an alias for a collection.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i7" class="rowColor">
|
|
|
+<tr id="i8" class="altColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#createCollection-io.milvus.param.collection.CreateCollectionParam-">createCollection</a></span>(@NonNull <a href="../../../io/milvus/param/collection/CreateCollectionParam.html" title="class in io.milvus.param.collection">CreateCollectionParam</a> requestParam)</code>
|
|
|
<div class="block">Creates a collection in Milvus.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i8" class="altColor">
|
|
|
+<tr id="i9" class="rowColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#createCredential-io.milvus.param.credential.CreateCredentialParam-">createCredential</a></span>(<a href="../../../io/milvus/param/credential/CreateCredentialParam.html" title="class in io.milvus.param.credential">CreateCredentialParam</a> requestParam)</code>
|
|
|
<div class="block">Create credential using the given user and password.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i9" class="rowColor">
|
|
|
+<tr id="i10" class="altColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#createIndex-io.milvus.param.index.CreateIndexParam-">createIndex</a></span>(@NonNull <a href="../../../io/milvus/param/index/CreateIndexParam.html" title="class in io.milvus.param.index">CreateIndexParam</a> requestParam)</code>
|
|
|
<div class="block">Creates an index on a vector field in the specified collection.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i10" class="altColor">
|
|
|
+<tr id="i11" class="rowColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#createPartition-io.milvus.param.partition.CreatePartitionParam-">createPartition</a></span>(@NonNull <a href="../../../io/milvus/param/partition/CreatePartitionParam.html" title="class in io.milvus.param.partition">CreatePartitionParam</a> requestParam)</code>
|
|
|
<div class="block">Creates a partition in the specified collection.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i11" class="rowColor">
|
|
|
+<tr id="i12" class="altColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#createRole-io.milvus.param.role.CreateRoleParam-">createRole</a></span>(<a href="../../../io/milvus/param/role/CreateRoleParam.html" title="class in io.milvus.param.role">CreateRoleParam</a> requestParam)</code>
|
|
|
<div class="block">It will success if the role isn't existed, otherwise fail.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i12" class="altColor">
|
|
|
+<tr id="i13" class="rowColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.MutationResult></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#delete-io.milvus.param.dml.DeleteParam-">delete</a></span>(@NonNull <a href="../../../io/milvus/param/dml/DeleteParam.html" title="class in io.milvus.param.dml">DeleteParam</a> requestParam)</code>
|
|
|
<div class="block">Deletes entity(s) based on primary key(s) filtered by boolean expression.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i13" class="rowColor">
|
|
|
+<tr id="i14" class="altColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#deleteCredential-io.milvus.param.credential.DeleteCredentialParam-">deleteCredential</a></span>(<a href="../../../io/milvus/param/credential/DeleteCredentialParam.html" title="class in io.milvus.param.credential">DeleteCredentialParam</a> requestParam)</code>
|
|
|
<div class="block">Delete credential corresponding to the user.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i14" class="altColor">
|
|
|
+<tr id="i15" class="rowColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.DescribeCollectionResponse></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#describeCollection-io.milvus.param.collection.DescribeCollectionParam-">describeCollection</a></span>(@NonNull <a href="../../../io/milvus/param/collection/DescribeCollectionParam.html" title="class in io.milvus.param.collection">DescribeCollectionParam</a> requestParam)</code>
|
|
|
<div class="block">Shows the details of a collection, e.g.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i15" class="rowColor">
|
|
|
+<tr id="i16" class="altColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.DescribeIndexResponse></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#describeIndex-io.milvus.param.index.DescribeIndexParam-">describeIndex</a></span>(@NonNull <a href="../../../io/milvus/param/index/DescribeIndexParam.html" title="class in io.milvus.param.index">DescribeIndexParam</a> requestParam)</code>
|
|
|
<div class="block">Shows the information of the specified index.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i16" class="altColor">
|
|
|
+<tr id="i17" class="rowColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#dropAlias-io.milvus.param.alias.DropAliasParam-">dropAlias</a></span>(@NonNull <a href="../../../io/milvus/param/alias/DropAliasParam.html" title="class in io.milvus.param.alias">DropAliasParam</a> requestParam)</code>
|
|
|
<div class="block">Drops an alias for the specified collection.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i17" class="rowColor">
|
|
|
+<tr id="i18" class="altColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#dropCollection-io.milvus.param.collection.DropCollectionParam-">dropCollection</a></span>(@NonNull <a href="../../../io/milvus/param/collection/DropCollectionParam.html" title="class in io.milvus.param.collection">DropCollectionParam</a> requestParam)</code>
|
|
|
<div class="block">Drops a collection.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i18" class="altColor">
|
|
|
+<tr id="i19" class="rowColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#dropIndex-io.milvus.param.index.DropIndexParam-">dropIndex</a></span>(@NonNull <a href="../../../io/milvus/param/index/DropIndexParam.html" title="class in io.milvus.param.index">DropIndexParam</a> requestParam)</code>
|
|
|
<div class="block">Drops the index on a vector field in the specified collection.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i19" class="rowColor">
|
|
|
+<tr id="i20" class="altColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#dropPartition-io.milvus.param.partition.DropPartitionParam-">dropPartition</a></span>(@NonNull <a href="../../../io/milvus/param/partition/DropPartitionParam.html" title="class in io.milvus.param.partition">DropPartitionParam</a> requestParam)</code>
|
|
|
<div class="block">Drops a partition.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i20" class="altColor">
|
|
|
+<tr id="i21" class="rowColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#dropRole-io.milvus.param.role.DropRoleParam-">dropRole</a></span>(<a href="../../../io/milvus/param/role/DropRoleParam.html" title="class in io.milvus.param.role">DropRoleParam</a> requestParam)</code>
|
|
|
<div class="block">It will success if the role is existed, otherwise fail.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i21" class="rowColor">
|
|
|
+<tr id="i22" class="altColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.FlushResponse></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#flush-io.milvus.param.collection.FlushParam-">flush</a></span>(@NonNull <a href="../../../io/milvus/param/collection/FlushParam.html" title="class in io.milvus.param.collection">FlushParam</a> requestParam)</code>
|
|
|
<div class="block">Flush insert buffer into storage.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i22" class="altColor">
|
|
|
+<tr id="i23" class="rowColor">
|
|
|
<td class="colFirst"><code>protected abstract io.milvus.grpc.MilvusServiceGrpc.MilvusServiceFutureStub</code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#futureStub--">futureStub</a></span>()</code> </td>
|
|
|
</tr>
|
|
|
-<tr id="i23" class="rowColor">
|
|
|
+<tr id="i24" class="altColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetImportStateResponse></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#getBulkInsertState-io.milvus.param.bulkinsert.GetBulkInsertStateParam-">getBulkInsertState</a></span>(<a href="../../../io/milvus/param/bulkinsert/GetBulkInsertStateParam.html" title="class in io.milvus.param.bulkinsert">GetBulkInsertStateParam</a> requestParam)</code>
|
|
|
<div class="block">Get state of bulk insert task</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i24" class="altColor">
|
|
|
+<tr id="i25" class="rowColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetCollectionStatisticsResponse></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#getCollectionStatistics-io.milvus.param.collection.GetCollectionStatisticsParam-">getCollectionStatistics</a></span>(@NonNull <a href="../../../io/milvus/param/collection/GetCollectionStatisticsParam.html" title="class in io.milvus.param.collection">GetCollectionStatisticsParam</a> requestParam)</code>
|
|
|
<div class="block">Shows the statistics information of a collection.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i25" class="rowColor">
|
|
|
+<tr id="i26" class="altColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetCompactionStateResponse></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#getCompactionState-io.milvus.param.control.GetCompactionStateParam-">getCompactionState</a></span>(<a href="../../../io/milvus/param/control/GetCompactionStateParam.html" title="class in io.milvus.param.control">GetCompactionStateParam</a> requestParam)</code>
|
|
|
<div class="block">Gets the compaction state by id.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i26" class="altColor">
|
|
|
+<tr id="i27" class="rowColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetCompactionPlansResponse></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#getCompactionStateWithPlans-io.milvus.param.control.GetCompactionPlansParam-">getCompactionStateWithPlans</a></span>(<a href="../../../io/milvus/param/control/GetCompactionPlansParam.html" title="class in io.milvus.param.control">GetCompactionPlansParam</a> requestParam)</code>
|
|
|
<div class="block">Gets compaction state with its plan.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i27" class="rowColor">
|
|
|
+<tr id="i28" class="altColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetFlushStateResponse></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#getFlushState-io.milvus.param.control.GetFlushStateParam-">getFlushState</a></span>(@NonNull <a href="../../../io/milvus/param/control/GetFlushStateParam.html" title="class in io.milvus.param.control">GetFlushStateParam</a> requestParam)</code>
|
|
|
<div class="block">Get flush state of specified segments.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i28" class="altColor">
|
|
|
+<tr id="i29" class="rowColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetIndexBuildProgressResponse></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#getIndexBuildProgress-io.milvus.param.index.GetIndexBuildProgressParam-">getIndexBuildProgress</a></span>(@NonNull <a href="../../../io/milvus/param/index/GetIndexBuildProgressParam.html" title="class in io.milvus.param.index">GetIndexBuildProgressParam</a> requestParam)</code>
|
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i29" class="rowColor">
|
|
|
+<tr id="i30" class="altColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetIndexStateResponse></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#getIndexState-io.milvus.param.index.GetIndexStateParam-">getIndexState</a></span>(@NonNull <a href="../../../io/milvus/param/index/GetIndexStateParam.html" title="class in io.milvus.param.index">GetIndexStateParam</a> requestParam)</code>
|
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i30" class="altColor">
|
|
|
+<tr id="i31" class="rowColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetLoadingProgressResponse></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#getLoadingProgress-io.milvus.param.collection.GetLoadingProgressParam-">getLoadingProgress</a></span>(<a href="../../../io/milvus/param/collection/GetLoadingProgressParam.html" title="class in io.milvus.param.collection">GetLoadingProgressParam</a> requestParam)</code>
|
|
|
<div class="block">Get collection loading progress</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i31" class="rowColor">
|
|
|
+<tr id="i32" class="altColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetLoadStateResponse></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#getLoadState-io.milvus.param.collection.GetLoadStateParam-">getLoadState</a></span>(<a href="../../../io/milvus/param/collection/GetLoadStateParam.html" title="class in io.milvus.param.collection">GetLoadStateParam</a> requestParam)</code>
|
|
|
<div class="block">Get collection loading state</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i32" class="altColor">
|
|
|
+<tr id="i33" class="rowColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetMetricsResponse></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#getMetrics-io.milvus.param.control.GetMetricsParam-">getMetrics</a></span>(@NonNull <a href="../../../io/milvus/param/control/GetMetricsParam.html" title="class in io.milvus.param.control">GetMetricsParam</a> requestParam)</code>
|
|
|
<div class="block">Gets the runtime metrics information of Milvus, returns the result in .json format.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i33" class="rowColor">
|
|
|
+<tr id="i34" class="altColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetPartitionStatisticsResponse></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#getPartitionStatistics-io.milvus.param.partition.GetPartitionStatisticsParam-">getPartitionStatistics</a></span>(@NonNull <a href="../../../io/milvus/param/partition/GetPartitionStatisticsParam.html" title="class in io.milvus.param.partition">GetPartitionStatisticsParam</a> requestParam)</code>
|
|
|
<div class="block">Shows the statistics information of a partition.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i34" class="altColor">
|
|
|
+<tr id="i35" class="rowColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetPersistentSegmentInfoResponse></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#getPersistentSegmentInfo-io.milvus.param.control.GetPersistentSegmentInfoParam-">getPersistentSegmentInfo</a></span>(@NonNull <a href="../../../io/milvus/param/control/GetPersistentSegmentInfoParam.html" title="class in io.milvus.param.control">GetPersistentSegmentInfoParam</a> requestParam)</code>
|
|
|
<div class="block">Gets the information of persistent segments from data node, including row count,
|
|
|
persistence state(growing or flushed), etc.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i35" class="rowColor">
|
|
|
+<tr id="i36" class="altColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetQuerySegmentInfoResponse></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#getQuerySegmentInfo-io.milvus.param.control.GetQuerySegmentInfoParam-">getQuerySegmentInfo</a></span>(@NonNull <a href="../../../io/milvus/param/control/GetQuerySegmentInfoParam.html" title="class in io.milvus.param.control">GetQuerySegmentInfoParam</a> requestParam)</code>
|
|
|
<div class="block">Gets the query information of segments in a collection from query node, including row count,
|
|
|
memory usage size, index name, etc.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i36" class="altColor">
|
|
|
+<tr id="i37" class="rowColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetReplicasResponse></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#getReplicas-io.milvus.param.control.GetReplicasParam-">getReplicas</a></span>(<a href="../../../io/milvus/param/control/GetReplicasParam.html" title="class in io.milvus.param.control">GetReplicasParam</a> requestParam)</code>
|
|
|
<div class="block">Returns the collection's replica information</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i37" class="rowColor">
|
|
|
+<tr id="i38" class="altColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetVersionResponse></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#getVersion--">getVersion</a></span>()</code>
|
|
|
<div class="block">Get server version</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i38" class="altColor">
|
|
|
+<tr id="i39" class="rowColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#grantRolePrivilege-io.milvus.param.role.GrantRolePrivilegeParam-">grantRolePrivilege</a></span>(<a href="../../../io/milvus/param/role/GrantRolePrivilegeParam.html" title="class in io.milvus.param.role">GrantRolePrivilegeParam</a> requestParam)</code>
|
|
|
<div class="block">Grant Role Privilege.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i39" class="rowColor">
|
|
|
+<tr id="i40" class="altColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><java.lang.Boolean></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#hasCollection-io.milvus.param.collection.HasCollectionParam-">hasCollection</a></span>(@NonNull <a href="../../../io/milvus/param/collection/HasCollectionParam.html" title="class in io.milvus.param.collection">HasCollectionParam</a> requestParam)</code>
|
|
|
<div class="block">Checks if a collection exists.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i40" class="altColor">
|
|
|
+<tr id="i41" class="rowColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><java.lang.Boolean></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#hasPartition-io.milvus.param.partition.HasPartitionParam-">hasPartition</a></span>(@NonNull <a href="../../../io/milvus/param/partition/HasPartitionParam.html" title="class in io.milvus.param.partition">HasPartitionParam</a> requestParam)</code>
|
|
|
<div class="block">Checks if a partition exists in the specified collection.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i41" class="rowColor">
|
|
|
+<tr id="i42" class="altColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.MutationResult></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#insert-io.milvus.param.dml.InsertParam-">insert</a></span>(@NonNull <a href="../../../io/milvus/param/dml/InsertParam.html" title="class in io.milvus.param.dml">InsertParam</a> requestParam)</code>
|
|
|
<div class="block">Inserts entities into a specified collection .</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i42" class="altColor">
|
|
|
+<tr id="i43" class="rowColor">
|
|
|
<td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<<a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.MutationResult>></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#insertAsync-io.milvus.param.dml.InsertParam-">insertAsync</a></span>(<a href="../../../io/milvus/param/dml/InsertParam.html" title="class in io.milvus.param.dml">InsertParam</a> requestParam)</code>
|
|
|
<div class="block">Inserts entities into a specified collection asynchronously.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i43" class="rowColor">
|
|
|
+<tr id="i44" class="altColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ListImportTasksResponse></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#listBulkInsertTasks-io.milvus.param.bulkinsert.ListBulkInsertTasksParam-">listBulkInsertTasks</a></span>(<a href="../../../io/milvus/param/bulkinsert/ListBulkInsertTasksParam.html" title="class in io.milvus.param.bulkinsert">ListBulkInsertTasksParam</a> requestParam)</code>
|
|
|
<div class="block">List bulk insert tasks</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i44" class="altColor">
|
|
|
+<tr id="i45" class="rowColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ListCredUsersResponse></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#listCredUsers-io.milvus.param.credential.ListCredUsersParam-">listCredUsers</a></span>(<a href="../../../io/milvus/param/credential/ListCredUsersParam.html" title="class in io.milvus.param.credential">ListCredUsersParam</a> requestParam)</code>
|
|
|
<div class="block">List all user names.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i45" class="rowColor">
|
|
|
+<tr id="i46" class="altColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#loadBalance-io.milvus.param.control.LoadBalanceParam-">loadBalance</a></span>(<a href="../../../io/milvus/param/control/LoadBalanceParam.html" title="class in io.milvus.param.control">LoadBalanceParam</a> requestParam)</code>
|
|
|
<div class="block">Moves segment from a query node to another to keep the load balanced.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i46" class="altColor">
|
|
|
+<tr id="i47" class="rowColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#loadCollection-io.milvus.param.collection.LoadCollectionParam-">loadCollection</a></span>(@NonNull <a href="../../../io/milvus/param/collection/LoadCollectionParam.html" title="class in io.milvus.param.collection">LoadCollectionParam</a> requestParam)</code>
|
|
|
<div class="block">Loads a collection to memory before search or query.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i47" class="rowColor">
|
|
|
+<tr id="i48" class="altColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#loadPartitions-io.milvus.param.partition.LoadPartitionsParam-">loadPartitions</a></span>(@NonNull <a href="../../../io/milvus/param/partition/LoadPartitionsParam.html" title="class in io.milvus.param.partition">LoadPartitionsParam</a> requestParam)</code>
|
|
|
<div class="block">Loads a partition into memory.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i48" class="altColor">
|
|
|
+<tr id="i49" class="rowColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ManualCompactionResponse></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#manualCompact-io.milvus.param.control.ManualCompactParam-">manualCompact</a></span>(<a href="../../../io/milvus/param/control/ManualCompactParam.html" title="class in io.milvus.param.control">ManualCompactParam</a> requestParam)</code>
|
|
|
<div class="block">Performs a manual compaction.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i49" class="rowColor">
|
|
|
+<tr id="i50" class="altColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.QueryResults></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#query-io.milvus.param.dml.QueryParam-">query</a></span>(@NonNull <a href="../../../io/milvus/param/dml/QueryParam.html" title="class in io.milvus.param.dml">QueryParam</a> requestParam)</code>
|
|
|
<div class="block">Queries entity(s) based on scalar field(s) filtered by boolean expression.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i50" class="altColor">
|
|
|
+<tr id="i51" class="rowColor">
|
|
|
<td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<<a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.QueryResults>></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#queryAsync-io.milvus.param.dml.QueryParam-">queryAsync</a></span>(<a href="../../../io/milvus/param/dml/QueryParam.html" title="class in io.milvus.param.dml">QueryParam</a> requestParam)</code>
|
|
|
<div class="block">Queries entity(s) asynchronously based on scalar field(s) filtered by boolean expression.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i51" class="rowColor">
|
|
|
+<tr id="i52" class="altColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#releaseCollection-io.milvus.param.collection.ReleaseCollectionParam-">releaseCollection</a></span>(@NonNull <a href="../../../io/milvus/param/collection/ReleaseCollectionParam.html" title="class in io.milvus.param.collection">ReleaseCollectionParam</a> requestParam)</code>
|
|
|
<div class="block">Releases a collection from memory to reduce memory usage.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i52" class="altColor">
|
|
|
+<tr id="i53" class="rowColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#releasePartitions-io.milvus.param.partition.ReleasePartitionsParam-">releasePartitions</a></span>(@NonNull <a href="../../../io/milvus/param/partition/ReleasePartitionsParam.html" title="class in io.milvus.param.partition">ReleasePartitionsParam</a> requestParam)</code>
|
|
|
<div class="block">Releases a partition from memory.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i53" class="rowColor">
|
|
|
+<tr id="i54" class="altColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#removeUserFromRole-io.milvus.param.role.RemoveUserFromRoleParam-">removeUserFromRole</a></span>(<a href="../../../io/milvus/param/role/RemoveUserFromRoleParam.html" title="class in io.milvus.param.role">RemoveUserFromRoleParam</a> requestParam)</code>
|
|
|
<div class="block">The user will remove permissions that the role are allowed to perform operations.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i54" class="altColor">
|
|
|
+<tr id="i55" class="rowColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#revokeRolePrivilege-io.milvus.param.role.RevokeRolePrivilegeParam-">revokeRolePrivilege</a></span>(<a href="../../../io/milvus/param/role/RevokeRolePrivilegeParam.html" title="class in io.milvus.param.role">RevokeRolePrivilegeParam</a> requestParam)</code>
|
|
|
<div class="block">Revoke Role Privilege.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i55" class="rowColor">
|
|
|
+<tr id="i56" class="altColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.SearchResults></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#search-io.milvus.param.dml.SearchParam-">search</a></span>(@NonNull <a href="../../../io/milvus/param/dml/SearchParam.html" title="class in io.milvus.param.dml">SearchParam</a> requestParam)</code>
|
|
|
<div class="block">Conducts ANN search on a vector field.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i56" class="altColor">
|
|
|
+<tr id="i57" class="rowColor">
|
|
|
<td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<<a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.SearchResults>></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#searchAsync-io.milvus.param.dml.SearchParam-">searchAsync</a></span>(<a href="../../../io/milvus/param/dml/SearchParam.html" title="class in io.milvus.param.dml">SearchParam</a> requestParam)</code>
|
|
|
<div class="block">Conducts ANN search on a vector field asynchronously.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i57" class="rowColor">
|
|
|
+<tr id="i58" class="altColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.SelectGrantResponse></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#selectGrantForRole-io.milvus.param.role.SelectGrantForRoleParam-">selectGrantForRole</a></span>(<a href="../../../io/milvus/param/role/SelectGrantForRoleParam.html" title="class in io.milvus.param.role">SelectGrantForRoleParam</a> requestParam)</code>
|
|
|
<div class="block">List a grant info for the role and the specific object</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i58" class="altColor">
|
|
|
+<tr id="i59" class="rowColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.SelectGrantResponse></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#selectGrantForRoleAndObject-io.milvus.param.role.SelectGrantForRoleAndObjectParam-">selectGrantForRoleAndObject</a></span>(<a href="../../../io/milvus/param/role/SelectGrantForRoleAndObjectParam.html" title="class in io.milvus.param.role">SelectGrantForRoleAndObjectParam</a> requestParam)</code>
|
|
|
<div class="block">List a grant info for the role</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i59" class="rowColor">
|
|
|
+<tr id="i60" class="altColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.SelectRoleResponse></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#selectRole-io.milvus.param.role.SelectRoleParam-">selectRole</a></span>(<a href="../../../io/milvus/param/role/SelectRoleParam.html" title="class in io.milvus.param.role">SelectRoleParam</a> requestParam)</code>
|
|
|
<div class="block">Get all users who are added to the role.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i60" class="altColor">
|
|
|
+<tr id="i61" class="rowColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.SelectUserResponse></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#selectUser-io.milvus.param.role.SelectUserParam-">selectUser</a></span>(<a href="../../../io/milvus/param/role/SelectUserParam.html" title="class in io.milvus.param.role">SelectUserParam</a> requestParam)</code>
|
|
|
<div class="block">Get all roles the user has.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i61" class="rowColor">
|
|
|
+<tr id="i62" class="altColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ShowCollectionsResponse></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#showCollections-io.milvus.param.collection.ShowCollectionsParam-">showCollections</a></span>(@NonNull <a href="../../../io/milvus/param/collection/ShowCollectionsParam.html" title="class in io.milvus.param.collection">ShowCollectionsParam</a> requestParam)</code>
|
|
|
<div class="block">Lists all collections or gets collection loading status.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i62" class="altColor">
|
|
|
+<tr id="i63" class="rowColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ShowPartitionsResponse></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#showPartitions-io.milvus.param.partition.ShowPartitionsParam-">showPartitions</a></span>(@NonNull <a href="../../../io/milvus/param/partition/ShowPartitionsParam.html" title="class in io.milvus.param.partition">ShowPartitionsParam</a> requestParam)</code>
|
|
|
<div class="block">Shows all partitions in the specified collection.</div>
|
|
|
</td>
|
|
|
</tr>
|
|
|
-<tr id="i63" class="rowColor">
|
|
|
+<tr id="i64" class="altColor">
|
|
|
<td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
|
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/AbstractMilvusGrpcClient.html#updateCredential-io.milvus.param.credential.UpdateCredentialParam-">updateCredential</a></span>(<a href="../../../io/milvus/param/credential/UpdateCredentialParam.html" title="class in io.milvus.param.credential">UpdateCredentialParam</a> requestParam)</code>
|
|
|
<div class="block">Update credential using the given user and password.</div>
|
|
|
@@ -768,6 +774,26 @@ implements <a href="../../../io/milvus/client/MilvusClient.html" title="interfac
|
|
|
</dl>
|
|
|
</li>
|
|
|
</ul>
|
|
|
+<a name="alterCollection-io.milvus.param.collection.AlterCollectionParam-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>alterCollection</h4>
|
|
|
+<pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> alterCollection(<a href="../../../io/milvus/param/collection/AlterCollectionParam.html" title="class in io.milvus.param.collection">AlterCollectionParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#alterCollection-io.milvus.param.collection.AlterCollectionParam-">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Alter collection.
|
|
|
+ Currently, only support setting collection TTL with key `collection.ttl.seconds`</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="../../../io/milvus/client/MilvusClient.html#alterCollection-io.milvus.param.collection.AlterCollectionParam-">alterCollection</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../../../io/milvus/param/collection/AlterCollectionParam.html" title="class in io.milvus.param.collection"><code>AlterCollectionParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
<a name="flush-io.milvus.param.collection.FlushParam-">
|
|
|
<!-- -->
|
|
|
</a>
|
groot