Update doc (#700)

Signed-off-by: yhmo <[email protected]>
milvus-io · Nov 8, 2023 · c63e71d · c63e71d
1 parent f67710d
commit c63e71d
Show file tree

Hide file tree

Showing 300 changed files with 6,179 additions and 1,019 deletions.
diff --git a/doc/allclasses-index.html b/doc/allclasses-index.html
diff --git a/doc/allclasses.html b/doc/allclasses.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (11.0.18) on Fri Oct 27 18:27:49 CST 2023 -->
+<!-- Generated by javadoc (11.0.18) on Wed Nov 08 17:48:37 CST 2023 -->
 <title>All Classes</title>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2023-10-27">
+<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">
@@ -53,6 +53,8 @@ <h1 class="bar">All&nbsp;Classes</h1>
 <li><a href="io/milvus/param/index/CreateIndexParam.Builder.html" title="class in io.milvus.param.index">CreateIndexParam.Builder</a></li>
 <li><a href="io/milvus/param/partition/CreatePartitionParam.html" title="class in io.milvus.param.partition">CreatePartitionParam</a></li>
 <li><a href="io/milvus/param/partition/CreatePartitionParam.Builder.html" title="class in io.milvus.param.partition">CreatePartitionParam.Builder</a></li>
+<li><a href="io/milvus/param/resourcegroup/CreateResourceGroupParam.html" title="class in io.milvus.param.resourcegroup">CreateResourceGroupParam</a></li>
+<li><a href="io/milvus/param/resourcegroup/CreateResourceGroupParam.Builder.html" title="class in io.milvus.param.resourcegroup">CreateResourceGroupParam.Builder</a></li>
 <li><a href="io/milvus/param/role/CreateRoleParam.html" title="class in io.milvus.param.role">CreateRoleParam</a></li>
 <li><a href="io/milvus/param/role/CreateRoleParam.Builder.html" title="class in io.milvus.param.role">CreateRoleParam.Builder</a></li>
 <li><a href="io/milvus/param/highlevel/collection/CreateSimpleCollectionParam.html" title="class in io.milvus.param.highlevel.collection">CreateSimpleCollectionParam</a></li>
@@ -71,6 +73,8 @@ <h1 class="bar">All&nbsp;Classes</h1>
 <li><a href="io/milvus/param/collection/DescribeCollectionParam.Builder.html" title="class in io.milvus.param.collection">DescribeCollectionParam.Builder</a></li>
 <li><a href="io/milvus/param/index/DescribeIndexParam.html" title="class in io.milvus.param.index">DescribeIndexParam</a></li>
 <li><a href="io/milvus/param/index/DescribeIndexParam.Builder.html" title="class in io.milvus.param.index">DescribeIndexParam.Builder</a></li>
+<li><a href="io/milvus/param/resourcegroup/DescribeResourceGroupParam.html" title="class in io.milvus.param.resourcegroup">DescribeResourceGroupParam</a></li>
+<li><a href="io/milvus/param/resourcegroup/DescribeResourceGroupParam.Builder.html" title="class in io.milvus.param.resourcegroup">DescribeResourceGroupParam.Builder</a></li>
 <li><a href="io/milvus/param/alias/DropAliasParam.html" title="class in io.milvus.param.alias">DropAliasParam</a></li>
 <li><a href="io/milvus/param/alias/DropAliasParam.Builder.html" title="class in io.milvus.param.alias">DropAliasParam.Builder</a></li>
 <li><a href="io/milvus/param/collection/DropCollectionParam.html" title="class in io.milvus.param.collection">DropCollectionParam</a></li>
@@ -81,6 +85,8 @@ <h1 class="bar">All&nbsp;Classes</h1>
 <li><a href="io/milvus/param/index/DropIndexParam.Builder.html" title="class in io.milvus.param.index">DropIndexParam.Builder</a></li>
 <li><a href="io/milvus/param/partition/DropPartitionParam.html" title="class in io.milvus.param.partition">DropPartitionParam</a></li>
 <li><a href="io/milvus/param/partition/DropPartitionParam.Builder.html" title="class in io.milvus.param.partition">DropPartitionParam.Builder</a></li>
+<li><a href="io/milvus/param/resourcegroup/DropResourceGroupParam.html" title="class in io.milvus.param.resourcegroup">DropResourceGroupParam</a></li>
+<li><a href="io/milvus/param/resourcegroup/DropResourceGroupParam.Builder.html" title="class in io.milvus.param.resourcegroup">DropResourceGroupParam.Builder</a></li>
 <li><a href="io/milvus/param/role/DropRoleParam.html" title="class in io.milvus.param.role">DropRoleParam</a></li>
 <li><a href="io/milvus/param/role/DropRoleParam.Builder.html" title="class in io.milvus.param.role">DropRoleParam.Builder</a></li>
 <li><a href="io/milvus/response/FieldDataWrapper.html" title="class in io.milvus.response">FieldDataWrapper</a></li>
@@ -147,6 +153,8 @@ <h1 class="bar">All&nbsp;Classes</h1>
 <li><a href="io/milvus/param/credential/ListCredUsersParam.html" title="class in io.milvus.param.credential">ListCredUsersParam</a></li>
 <li><a href="io/milvus/param/credential/ListCredUsersParam.Builder.html" title="class in io.milvus.param.credential">ListCredUsersParam.Builder</a></li>
 <li><a href="io/milvus/connection/Listener.html" title="interface in io.milvus.connection"><span class="interfaceName">Listener</span></a></li>
+<li><a href="io/milvus/param/resourcegroup/ListResourceGroupsParam.html" title="class in io.milvus.param.resourcegroup">ListResourceGroupsParam</a></li>
+<li><a href="io/milvus/param/resourcegroup/ListResourceGroupsParam.Builder.html" title="class in io.milvus.param.resourcegroup">ListResourceGroupsParam.Builder</a></li>
 <li><a href="io/milvus/param/control/LoadBalanceParam.html" title="class in io.milvus.param.control">LoadBalanceParam</a></li>
 <li><a href="io/milvus/param/control/LoadBalanceParam.Builder.html" title="class in io.milvus.param.control">LoadBalanceParam.Builder</a></li>
 <li><a href="io/milvus/param/collection/LoadCollectionParam.html" title="class in io.milvus.param.collection">LoadCollectionParam</a></li>
@@ -222,6 +230,10 @@ <h1 class="bar">All&nbsp;Classes</h1>
 <li><a href="io/milvus/param/partition/ShowPartitionsParam.Builder.html" title="class in io.milvus.param.partition">ShowPartitionsParam.Builder</a></li>
 <li><a href="io/milvus/response/ShowPartResponseWrapper.html" title="class in io.milvus.response">ShowPartResponseWrapper</a></li>
 <li><a href="io/milvus/response/ShowPartResponseWrapper.PartitionInfo.html" title="class in io.milvus.response">ShowPartResponseWrapper.PartitionInfo</a></li>
+<li><a href="io/milvus/param/resourcegroup/TransferNodeParam.html" title="class in io.milvus.param.resourcegroup">TransferNodeParam</a></li>
+<li><a href="io/milvus/param/resourcegroup/TransferNodeParam.Builder.html" title="class in io.milvus.param.resourcegroup">TransferNodeParam.Builder</a></li>
+<li><a href="io/milvus/param/resourcegroup/TransferReplicaParam.html" title="class in io.milvus.param.resourcegroup">TransferReplicaParam</a></li>
+<li><a href="io/milvus/param/resourcegroup/TransferReplicaParam.Builder.html" title="class in io.milvus.param.resourcegroup">TransferReplicaParam.Builder</a></li>
 <li><a href="io/milvus/param/credential/UpdateCredentialParam.html" title="class in io.milvus.param.credential">UpdateCredentialParam</a></li>
 <li><a href="io/milvus/param/credential/UpdateCredentialParam.Builder.html" title="class in io.milvus.param.credential">UpdateCredentialParam.Builder</a></li>
 <li><a href="io/milvus/utils/URLParser.html" title="class in io.milvus.utils">URLParser</a></li>

diff --git a/doc/allpackages-index.html b/doc/allpackages-index.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (11.0.18) on Fri Oct 27 18:27:49 CST 2023 -->
+<!-- Generated by javadoc (11.0.18) on Wed Nov 08 17:48:37 CST 2023 -->
 <title>All Packages</title>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2023-10-27">
+<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">
@@ -183,18 +183,22 @@ <h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr class="rowColor">
-<th class="colFirst" scope="row"><a href="io/milvus/param/role/package-summary.html">io.milvus.param.role</a></th>
+<th class="colFirst" scope="row"><a href="io/milvus/param/resourcegroup/package-summary.html">io.milvus.param.resourcegroup</a></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr class="altColor">
-<th class="colFirst" scope="row"><a href="io/milvus/response/package-summary.html">io.milvus.response</a></th>
+<th class="colFirst" scope="row"><a href="io/milvus/param/role/package-summary.html">io.milvus.param.role</a></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr class="rowColor">
-<th class="colFirst" scope="row"><a href="io/milvus/response/basic/package-summary.html">io.milvus.response.basic</a></th>
+<th class="colFirst" scope="row"><a href="io/milvus/response/package-summary.html">io.milvus.response</a></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr class="altColor">
+<th class="colFirst" scope="row"><a href="io/milvus/response/basic/package-summary.html">io.milvus.response.basic</a></th>
+<td class="colLast">&nbsp;</td>
+</tr>
+<tr class="rowColor">
 <th class="colFirst" scope="row"><a href="io/milvus/utils/package-summary.html">io.milvus.utils</a></th>
 <td class="colLast">&nbsp;</td>
 </tr>

diff --git a/doc/constant-values.html b/doc/constant-values.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (11.0.18) on Fri Oct 27 18:27:49 CST 2023 -->
+<!-- Generated by javadoc (11.0.18) on Wed Nov 08 17:48:37 CST 2023 -->
 <title>Constant Field Values</title>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2023-10-27">
+<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">

diff --git a/doc/deprecated-list.html b/doc/deprecated-list.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (11.0.18) on Fri Oct 27 18:27:49 CST 2023 -->
+<!-- Generated by javadoc (11.0.18) on Wed Nov 08 17:48:37 CST 2023 -->
 <title>Deprecated List</title>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2023-10-27">
+<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">

diff --git a/doc/element-list b/doc/element-list
@@ -17,6 +17,7 @@ io.milvus.param.highlevel.dml
 io.milvus.param.highlevel.dml.response
 io.milvus.param.index
 io.milvus.param.partition
+io.milvus.param.resourcegroup
 io.milvus.param.role
 io.milvus.response
 io.milvus.response.basic

diff --git a/doc/help-doc.html b/doc/help-doc.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (11.0.18) on Fri Oct 27 18:27:49 CST 2023 -->
+<!-- Generated by javadoc (11.0.18) on Wed Nov 08 17:48:37 CST 2023 -->
 <title>API Help</title>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2023-10-27">
+<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">

diff --git a/doc/index-files/index-1.html b/doc/index-files/index-1.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (11.0.18) on Fri Oct 27 18:27:49 CST 2023 -->
+<!-- Generated by javadoc (11.0.18) on Wed Nov 08 17:48:37 CST 2023 -->
 <title>A-Index</title>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2023-10-27">
+<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">

diff --git a/doc/index-files/index-10.html b/doc/index-files/index-10.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (11.0.18) on Fri Oct 27 18:27:49 CST 2023 -->
+<!-- Generated by javadoc (11.0.18) on Wed Nov 08 17:48:37 CST 2023 -->
 <title>J-Index</title>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2023-10-27">
+<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">

diff --git a/doc/index-files/index-11.html b/doc/index-files/index-11.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (11.0.18) on Fri Oct 27 18:27:49 CST 2023 -->
+<!-- Generated by javadoc (11.0.18) on Wed Nov 08 17:48:37 CST 2023 -->
 <title>K-Index</title>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2023-10-27">
+<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">

diff --git a/doc/index-files/index-12.html b/doc/index-files/index-12.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (11.0.18) on Fri Oct 27 18:27:49 CST 2023 -->
+<!-- Generated by javadoc (11.0.18) on Wed Nov 08 17:48:37 CST 2023 -->
 <title>L-Index</title>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2023-10-27">
+<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">
@@ -176,6 +176,22 @@ <h2 class="title">L</h2>
 <dd>
 <div class="block">Interface of multi server listener.</div>
 </dd>
+<dt><span class="memberNameLink"><a href="../io/milvus/client/AbstractMilvusGrpcClient.html#listResourceGroups(io.milvus.param.resourcegroup.ListResourceGroupsParam)">listResourceGroups(ListResourceGroupsParam)</a></span> - Method in class io.milvus.client.<a href="../io/milvus/client/AbstractMilvusGrpcClient.html" title="class in io.milvus.client">AbstractMilvusGrpcClient</a></dt>
+<dd>&nbsp;</dd>
+<dt><span class="memberNameLink"><a href="../io/milvus/client/MilvusClient.html#listResourceGroups(io.milvus.param.resourcegroup.ListResourceGroupsParam)">listResourceGroups(ListResourceGroupsParam)</a></span> - Method in interface io.milvus.client.<a href="../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></dt>
+<dd>
+<div class="block">List resource groups.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="../io/milvus/client/MilvusMultiServiceClient.html#listResourceGroups(io.milvus.param.resourcegroup.ListResourceGroupsParam)">listResourceGroups(ListResourceGroupsParam)</a></span> - Method in class io.milvus.client.<a href="../io/milvus/client/MilvusMultiServiceClient.html" title="class in io.milvus.client">MilvusMultiServiceClient</a></dt>
+<dd>&nbsp;</dd>
+<dt><span class="memberNameLink"><a href="../io/milvus/client/MilvusServiceClient.html#listResourceGroups(io.milvus.param.resourcegroup.ListResourceGroupsParam)">listResourceGroups(ListResourceGroupsParam)</a></span> - Method in class io.milvus.client.<a href="../io/milvus/client/MilvusServiceClient.html" title="class in io.milvus.client">MilvusServiceClient</a></dt>
+<dd>&nbsp;</dd>
+<dt><a href="../io/milvus/param/resourcegroup/ListResourceGroupsParam.html" title="class in io.milvus.param.resourcegroup"><span class="typeNameLink">ListResourceGroupsParam</span></a> - Class in <a href="../io/milvus/param/resourcegroup/package-summary.html">io.milvus.param.resourcegroup</a></dt>
+<dd>&nbsp;</dd>
+<dt><a href="../io/milvus/param/resourcegroup/ListResourceGroupsParam.Builder.html" title="class in io.milvus.param.resourcegroup"><span class="typeNameLink">ListResourceGroupsParam.Builder</span></a> - Class in <a href="../io/milvus/param/resourcegroup/package-summary.html">io.milvus.param.resourcegroup</a></dt>
+<dd>
+<div class="block">Builder for <a href="../io/milvus/param/resourcegroup/ListResourceGroupsParam.html" title="class in io.milvus.param.resourcegroup"><code>ListResourceGroupsParam</code></a> class.</div>
+</dd>
 <dt><span class="memberNameLink"><a href="../io/milvus/client/AbstractMilvusGrpcClient.html#loadBalance(io.milvus.param.control.LoadBalanceParam)">loadBalance(LoadBalanceParam)</a></span> - Method in class io.milvus.client.<a href="../io/milvus/client/AbstractMilvusGrpcClient.html" title="class in io.milvus.client">AbstractMilvusGrpcClient</a></dt>
 <dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="../io/milvus/client/MilvusClient.html#loadBalance(io.milvus.param.control.LoadBalanceParam)">loadBalance(LoadBalanceParam)</a></span> - Method in interface io.milvus.client.<a href="../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></dt>

diff --git a/doc/index-files/index-13.html b/doc/index-files/index-13.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (11.0.18) on Fri Oct 27 18:27:49 CST 2023 -->
+<!-- Generated by javadoc (11.0.18) on Wed Nov 08 17:48:37 CST 2023 -->
 <title>M-Index</title>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2023-10-27">
+<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">