Skip to content

Commit

Permalink
Update doc (#729)
Browse files Browse the repository at this point in the history
Signed-off-by: yhmo <[email protected]>
  • Loading branch information
yhmo committed Jan 2, 2024
1 parent 1e3dc58 commit a319fd5
Show file tree
Hide file tree
Showing 304 changed files with 2,056 additions and 660 deletions.
106 changes: 62 additions & 44 deletions doc/allclasses-index.html

Large diffs are not rendered by default.

7 changes: 5 additions & 2 deletions doc/allclasses.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Wed Nov 08 12:07:04 CST 2023 -->
<!-- Generated by javadoc (11.0.18) on Tue Jan 02 10:20:52 CST 2024 -->
<title>All Classes</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-11-08">
<meta name="dc.created" content="2024-01-02">
<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">
Expand Down Expand Up @@ -199,6 +199,8 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="io/milvus/param/role/RemoveUserFromRoleParam.Builder.html" title="class in io.milvus.param.role">RemoveUserFromRoleParam.Builder</a></li>
<li><a href="io/milvus/param/collection/RenameCollectionParam.html" title="class in io.milvus.param.collection">RenameCollectionParam</a></li>
<li><a href="io/milvus/param/collection/RenameCollectionParam.Builder.html" title="class in io.milvus.param.collection">RenameCollectionParam.Builder</a></li>
<li><a href="io/milvus/param/RetryParam.html" title="class in io.milvus.param">RetryParam</a></li>
<li><a href="io/milvus/param/RetryParam.Builder.html" title="class in io.milvus.param">RetryParam.Builder</a></li>
<li><a href="io/milvus/param/role/RevokeRolePrivilegeParam.html" title="class in io.milvus.param.role">RevokeRolePrivilegeParam</a></li>
<li><a href="io/milvus/param/role/RevokeRolePrivilegeParam.Builder.html" title="class in io.milvus.param.role">RevokeRolePrivilegeParam.Builder</a></li>
<li><a href="io/milvus/response/basic/RowRecordWrapper.html" title="class in io.milvus.response.basic">RowRecordWrapper</a></li>
Expand All @@ -220,6 +222,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="io/milvus/param/role/SelectUserParam.Builder.html" title="class in io.milvus.param.role">SelectUserParam.Builder</a></li>
<li><a href="io/milvus/param/ServerAddress.html" title="class in io.milvus.param">ServerAddress</a></li>
<li><a href="io/milvus/param/ServerAddress.Builder.html" title="class in io.milvus.param">ServerAddress.Builder</a></li>
<li><a href="io/milvus/exception/ServerException.html" title="class in io.milvus.exception">ServerException</a></li>
<li><a href="io/milvus/connection/ServerMonitor.html" title="class in io.milvus.connection">ServerMonitor</a></li>
<li><a href="io/milvus/connection/ServerSetting.html" title="class in io.milvus.connection">ServerSetting</a></li>
<li><a href="io/milvus/connection/ServerSetting.Builder.html" title="class in io.milvus.connection">ServerSetting.Builder</a></li>
Expand Down
4 changes: 2 additions & 2 deletions doc/allpackages-index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Wed Nov 08 12:07:04 CST 2023 -->
<!-- Generated by javadoc (11.0.18) on Tue Jan 02 10:20:52 CST 2024 -->
<title>All Packages</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-11-08">
<meta name="dc.created" content="2024-01-02">
<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">
Expand Down
6 changes: 3 additions & 3 deletions doc/constant-values.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Wed Nov 08 12:07:04 CST 2023 -->
<!-- Generated by javadoc (11.0.18) on Tue Jan 02 10:20:52 CST 2024 -->
<title>Constant Field Values</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-11-08">
<meta name="dc.created" content="2024-01-02">
<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">
Expand Down Expand Up @@ -122,7 +122,7 @@ <h2 title="io.milvus">io.milvus.*</h2>
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<th class="colSecond" scope="row"><code><a href="io/milvus/common/constant/MilvusClientConstant.MilvusConsts.html#CLOUD_SERVERLESS_URI_REGEX">CLOUD_SERVERLESS_URI_REGEX</a></code></th>
<td class="colLast"><code>"^https://in03-.{20,}zilliz.*.com$"</code></td>
<td class="colLast"><code>"^https://in03-.{20,}zilliz.*.(com|cn)$"</code></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a id="io.milvus.common.constant.MilvusClientConstant.MilvusConsts.HOST_HTTP_PREFIX">
Expand Down
12 changes: 10 additions & 2 deletions doc/deprecated-list.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Wed Nov 08 12:07:04 CST 2023 -->
<!-- Generated by javadoc (11.0.18) on Tue Jan 02 10:20:52 CST 2024 -->
<title>Deprecated List</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-11-08">
<meta name="dc.created" content="2024-01-02">
<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">
Expand Down Expand Up @@ -142,6 +142,14 @@ <h2 title="Contents">Contents</h2>
<td class="colLast"></td>
</tr>
<tr class="altColor">
<th class="colDeprecatedItemName" scope="row"><a href="io/milvus/client/MilvusClient.html#withRetry(int)">io.milvus.client.MilvusClient.withRetry&#8203;(int)</a></th>
<td class="colLast"></td>
</tr>
<tr class="rowColor">
<th class="colDeprecatedItemName" scope="row"><a href="io/milvus/client/MilvusClient.html#withRetryInterval(long,java.util.concurrent.TimeUnit)">io.milvus.client.MilvusClient.withRetryInterval&#8203;(long, TimeUnit)</a></th>
<td class="colLast"></td>
</tr>
<tr class="altColor">
<th class="colDeprecatedItemName" scope="row"><a href="io/milvus/param/ConnectParam.Builder.html#secure(boolean)">io.milvus.param.ConnectParam.Builder.secure&#8203;(boolean)</a></th>
<td class="colLast"></td>
</tr>
Expand Down
4 changes: 2 additions & 2 deletions doc/help-doc.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Wed Nov 08 12:07:04 CST 2023 -->
<!-- Generated by javadoc (11.0.18) on Tue Jan 02 10:20:52 CST 2024 -->
<title>API Help</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-11-08">
<meta name="dc.created" content="2024-01-02">
<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">
Expand Down
4 changes: 2 additions & 2 deletions doc/index-files/index-1.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Wed Nov 08 12:07:04 CST 2023 -->
<!-- Generated by javadoc (11.0.18) on Tue Jan 02 10:20:52 CST 2024 -->
<title>A-Index</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-11-08">
<meta name="dc.created" content="2024-01-02">
<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">
Expand Down
4 changes: 2 additions & 2 deletions doc/index-files/index-10.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Wed Nov 08 12:07:04 CST 2023 -->
<!-- Generated by javadoc (11.0.18) on Tue Jan 02 10:20:52 CST 2024 -->
<title>J-Index</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-11-08">
<meta name="dc.created" content="2024-01-02">
<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">
Expand Down
4 changes: 2 additions & 2 deletions doc/index-files/index-11.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Wed Nov 08 12:07:04 CST 2023 -->
<!-- Generated by javadoc (11.0.18) on Tue Jan 02 10:20:52 CST 2024 -->
<title>K-Index</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-11-08">
<meta name="dc.created" content="2024-01-02">
<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">
Expand Down
4 changes: 2 additions & 2 deletions doc/index-files/index-12.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Wed Nov 08 12:07:04 CST 2023 -->
<!-- Generated by javadoc (11.0.18) on Tue Jan 02 10:20:52 CST 2024 -->
<title>L-Index</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-11-08">
<meta name="dc.created" content="2024-01-02">
<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">
Expand Down
4 changes: 2 additions & 2 deletions doc/index-files/index-13.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Wed Nov 08 12:07:04 CST 2023 -->
<!-- Generated by javadoc (11.0.18) on Tue Jan 02 10:20:52 CST 2024 -->
<title>M-Index</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-11-08">
<meta name="dc.created" content="2024-01-02">
<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">
Expand Down
6 changes: 4 additions & 2 deletions doc/index-files/index-14.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Wed Nov 08 12:07:04 CST 2023 -->
<!-- Generated by javadoc (11.0.18) on Tue Jan 02 10:20:52 CST 2024 -->
<title>N-Index</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-11-08">
<meta name="dc.created" content="2024-01-02">
<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">
Expand Down Expand Up @@ -240,6 +240,8 @@ <h2 class="title">N</h2>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../io/milvus/param/resourcegroup/TransferReplicaParam.html#newBuilder()">newBuilder()</a></span> - Static method in class io.milvus.param.resourcegroup.<a href="../io/milvus/param/resourcegroup/TransferReplicaParam.html" title="class in io.milvus.param.resourcegroup">TransferReplicaParam</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../io/milvus/param/RetryParam.html#newBuilder()">newBuilder()</a></span> - Static method in class io.milvus.param.<a href="../io/milvus/param/RetryParam.html" title="class in io.milvus.param">RetryParam</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../io/milvus/param/role/AddUserToRoleParam.html#newBuilder()">newBuilder()</a></span> - Static method in class io.milvus.param.role.<a href="../io/milvus/param/role/AddUserToRoleParam.html" title="class in io.milvus.param.role">AddUserToRoleParam</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../io/milvus/param/role/CreateRoleParam.html#newBuilder()">newBuilder()</a></span> - Static method in class io.milvus.param.role.<a href="../io/milvus/param/role/CreateRoleParam.html" title="class in io.milvus.param.role">CreateRoleParam</a></dt>
Expand Down
4 changes: 2 additions & 2 deletions doc/index-files/index-15.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Wed Nov 08 12:07:04 CST 2023 -->
<!-- Generated by javadoc (11.0.18) on Tue Jan 02 10:20:52 CST 2024 -->
<title>O-Index</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-11-08">
<meta name="dc.created" content="2024-01-02">
<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">
Expand Down
4 changes: 2 additions & 2 deletions doc/index-files/index-16.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Wed Nov 08 12:07:04 CST 2023 -->
<!-- Generated by javadoc (11.0.18) on Tue Jan 02 10:20:52 CST 2024 -->
<title>P-Index</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-11-08">
<meta name="dc.created" content="2024-01-02">
<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">
Expand Down
4 changes: 2 additions & 2 deletions doc/index-files/index-17.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Wed Nov 08 12:07:04 CST 2023 -->
<!-- Generated by javadoc (11.0.18) on Tue Jan 02 10:20:52 CST 2024 -->
<title>Q-Index</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-11-08">
<meta name="dc.created" content="2024-01-02">
<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">
Expand Down
14 changes: 12 additions & 2 deletions doc/index-files/index-18.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Wed Nov 08 12:07:04 CST 2023 -->
<!-- Generated by javadoc (11.0.18) on Tue Jan 02 10:20:52 CST 2024 -->
<title>R-Index</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-11-08">
<meta name="dc.created" content="2024-01-02">
<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">
Expand Down Expand Up @@ -180,6 +180,16 @@ <h2 class="title">R</h2>
<dd>
<div class="block">Builder for <a href="../io/milvus/param/collection/RenameCollectionParam.html" title="class in io.milvus.param.collection"><code>RenameCollectionParam</code></a> class.</div>
</dd>
<dt><a href="../io/milvus/param/RetryParam.html" title="class in io.milvus.param"><span class="typeNameLink">RetryParam</span></a> - Class in <a href="../io/milvus/param/package-summary.html">io.milvus.param</a></dt>
<dd>
<div class="block">Parameters for retry on failure.</div>
</dd>
<dt><span class="memberNameLink"><a href="../io/milvus/param/RetryParam.html#%3Cinit%3E(io.milvus.param.RetryParam.Builder)">RetryParam(RetryParam.Builder)</a></span> - Constructor for class io.milvus.param.<a href="../io/milvus/param/RetryParam.html" title="class in io.milvus.param">RetryParam</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../io/milvus/param/RetryParam.Builder.html" title="class in io.milvus.param"><span class="typeNameLink">RetryParam.Builder</span></a> - Class in <a href="../io/milvus/param/package-summary.html">io.milvus.param</a></dt>
<dd>
<div class="block">Builder for <a href="../io/milvus/param/ConnectParam.html" title="class in io.milvus.param"><code>ConnectParam</code></a></div>
</dd>
<dt><span class="memberNameLink"><a href="../io/milvus/client/AbstractMilvusGrpcClient.html#revokeRolePrivilege(io.milvus.param.role.RevokeRolePrivilegeParam)">revokeRolePrivilege(RevokeRolePrivilegeParam)</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#revokeRolePrivilege(io.milvus.param.role.RevokeRolePrivilegeParam)">revokeRolePrivilege(RevokeRolePrivilegeParam)</a></span> - Method in interface io.milvus.client.<a href="../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></dt>
Expand Down
10 changes: 8 additions & 2 deletions doc/index-files/index-19.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Wed Nov 08 12:07:04 CST 2023 -->
<!-- Generated by javadoc (11.0.18) on Tue Jan 02 10:20:52 CST 2024 -->
<title>S-Index</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-11-08">
<meta name="dc.created" content="2024-01-02">
<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">
Expand Down Expand Up @@ -234,6 +234,12 @@ <h2 class="title">S</h2>
<dd>&nbsp;</dd>
<dt><a href="../io/milvus/param/ServerAddress.Builder.html" title="class in io.milvus.param"><span class="typeNameLink">ServerAddress.Builder</span></a> - Class in <a href="../io/milvus/param/package-summary.html">io.milvus.param</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../io/milvus/exception/ServerException.html" title="class in io.milvus.exception"><span class="typeNameLink">ServerException</span></a> - Exception in <a href="../io/milvus/exception/package-summary.html">io.milvus.exception</a></dt>
<dd>
<div class="block">Exception for error response from server side.</div>
</dd>
<dt><span class="memberNameLink"><a href="../io/milvus/exception/ServerException.html#%3Cinit%3E(java.lang.String,java.lang.Integer,io.milvus.grpc.ErrorCode)">ServerException(String, Integer, ErrorCode)</a></span> - Constructor for exception io.milvus.exception.<a href="../io/milvus/exception/ServerException.html" title="class in io.milvus.exception">ServerException</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../io/milvus/connection/ServerMonitor.html" title="class in io.milvus.connection"><span class="typeNameLink">ServerMonitor</span></a> - Class in <a href="../io/milvus/connection/package-summary.html">io.milvus.connection</a></dt>
<dd>
<div class="block">Monitor with scheduling to check server healthy state.</div>
Expand Down

0 comments on commit a319fd5

Please sign in to comment.