Home Explore Help
Register Sign In
milvus
/
milvus-sdk-java
mirror of https://github.com/milvus-io/milvus-sdk-java.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: 10c93cad06
Branches Tags
milvus-sdk-java
/
doc
/
io
/
milvus
/
client
/
MilvusClient.html

MilvusClient.html 66 KB
History Raw

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144 
  1. <!DOCTYPE HTML>
    2. 

  2. <!-- NewPage -->
    3. 

  3. <html lang="en">
    4. 

  4. <head>
    5. 

  5. <!-- Generated by javadoc (11.0.13) on Mon Jan 24 16:25:44 CST 2022 -->
    6. 

  6. <title>MilvusClient</title>
    7. 

  7. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    8. 

  8. <meta name="dc.created" content="2022-01-24">
    9. 

  9. <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
    10. 

  10. <link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
    11. 

  11. <script type="text/javascript" src="../../../script.js"></script>
    12. 

  12. <script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
    13. 

  13. <script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
    14. 

  14. <!--[if IE]>
    15. 

  15. <script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
    16. 

  16. <![endif]-->
    17. 

  17. <script type="text/javascript" src="../../../jquery/jquery-3.5.1.js"></script>
    18. 

  18. <script type="text/javascript" src="../../../jquery/jquery-ui.js"></script>
    19. 

  19. </head>
    20. 

  20. <body>
    21. 

  21. <script type="text/javascript"><!--
    22. 

  22.     try {
    23. 

  23.         if (location.href.indexOf('is-external=true') == -1) {
    24. 

  24.             parent.document.title="MilvusClient";
    25. 

  25.         }
    26. 

  26.     }
    27. 

  27.     catch(err) {
    28. 

  28.     }
    29. 

  29. //-->
    30. 

  30. var data = {"i0":6,"i1":6,"i2":18,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6,"i33":6,"i34":6,"i35":6,"i36":6,"i37":6,"i38":6};
    31. 

  31. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]};
    32. 

  32. var altColor = "altColor";
    33. 

  33. var rowColor = "rowColor";
    34. 

  34. var tableTab = "tableTab";
    35. 

  35. var activeTableTab = "activeTableTab";
    36. 

  36. var pathtoroot = "../../../";
    37. 

  37. var useModuleDirectories = true;
    38. 

  38. loadScripts(document, 'script');</script>
    39. 

  39. <noscript>
    40. 

  40. <div>JavaScript is disabled on your browser.</div>
    41. 

  41. </noscript>
    42. 

  42. <header role="banner">
    43. 

  43. <nav role="navigation">
    44. 

  44. <div class="fixedNav">
    45. 

  45. <!-- ========= START OF TOP NAVBAR ======= -->
    46. 

  46. <div class="topNav"><a id="navbar.top">
    47. 

  47. <!--   -->
    48. 

  48. </a>
    49. 

  49. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
    50. 

  50. <a id="navbar.top.firstrow">
    51. 

  51. <!--   -->
    52. 

  52. </a>
    53. 

  53. <ul class="navList" title="Navigation">
    54. 

  54. <li><a href="../../../index.html">Overview</a></li>
    55. 

  55. <li><a href="package-summary.html">Package</a></li>
    56. 

  56. <li class="navBarCell1Rev">Class</li>
    57. 

  57. <li><a href="package-tree.html">Tree</a></li>
    58. 

  58. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
    59. 

  59. <li><a href="../../../index-files/index-1.html">Index</a></li>
    60. 

  60. <li><a href="../../../help-doc.html">Help</a></li>
    61. 

  61. </ul>
    62. 

  62. </div>
    63. 

  63. <div class="subNav">
    64. 

  64. <ul class="navList" id="allclasses_navbar_top">
    65. 

  65. <li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
    66. 

  66. </ul>
    67. 

  67. <ul class="navListSearch">
    68. 

  68. <li><label for="search">SEARCH:</label>
    69. 

  69. <input type="text" id="search" value="search" disabled="disabled">
    70. 

  70. <input type="reset" id="reset" value="reset" disabled="disabled">
    71. 

  71. </li>
    72. 

  72. </ul>
    73. 

  73. <div>
    74. 

  74. <script type="text/javascript"><!--
    75. 

  75.   allClassesLink = document.getElementById("allclasses_navbar_top");
    76. 

  76.   if(window==top) {
    77. 

  77.     allClassesLink.style.display = "block";
    78. 

  78.   }
    79. 

  79.   else {
    80. 

  80.     allClassesLink.style.display = "none";
    81. 

  81.   }
    82. 

  82.   //-->
    83. 

  83. </script>
    84. 

  84. <noscript>
    85. 

  85. <div>JavaScript is disabled on your browser.</div>
    86. 

  86. </noscript>
    87. 

  87. </div>
    88. 

  88. <div>
    89. 

  89. <ul class="subNavList">
    90. 

  90. <li>Summary:&nbsp;</li>
    91. 

  91. <li>Nested&nbsp;|&nbsp;</li>
    92. 

  92. <li>Field&nbsp;|&nbsp;</li>
    93. 

  93. <li>Constr&nbsp;|&nbsp;</li>
    94. 

  94. <li><a href="#method.summary">Method</a></li>
    95. 

  95. </ul>
    96. 

  96. <ul class="subNavList">
    97. 

  97. <li>Detail:&nbsp;</li>
    98. 

  98. <li>Field&nbsp;|&nbsp;</li>
    99. 

  99. <li>Constr&nbsp;|&nbsp;</li>
    100. 

  100. <li><a href="#method.detail">Method</a></li>
    101. 

  101. </ul>
    102. 

  102. </div>
    103. 

  103. <a id="skip.navbar.top">
    104. 

  104. <!--   -->
    105. 

  105. </a></div>
    106. 

  106. <!-- ========= END OF TOP NAVBAR ========= -->
    107. 

  107. </div>
    108. 

  108. <div class="navPadding">&nbsp;</div>
    109. 

  109. <script type="text/javascript"><!--
    110. 

  110. $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
    111. 

  111. //-->
    112. 

  112. </script>
    113. 

  113. </nav>
    114. 

  114. </header>
    115. 

  115. <!-- ======== START OF CLASS DATA ======== -->
    116. 

  116. <main role="main">
    117. 

  117. <div class="header">
    118. 

  118. <div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">io.milvus.client</a></div>
    119. 

  119. <h2 title="Interface MilvusClient" class="title">Interface MilvusClient</h2>
    120. 

  120. </div>
    121. 

  121. <div class="contentContainer">
    122. 

  122. <div class="description">
    123. 

  123. <ul class="blockList">
    124. 

  124. <li class="blockList">
    125. 

  125. <dl>
    126. 

  126. <dt>All Known Implementing Classes:</dt>
    127. 

  127. <dd><code><a href="AbstractMilvusGrpcClient.html" title="class in io.milvus.client">AbstractMilvusGrpcClient</a></code>, <code><a href="MilvusServiceClient.html" title="class in io.milvus.client">MilvusServiceClient</a></code></dd>
    128. 

  128. </dl>
    129. 

  129. <hr>
    130. 

  130. <pre>public interface <span class="typeNameLabel">MilvusClient</span></pre>
    131. 

  131. <div class="block">The Milvus Client Interface</div>
    132. 

  132. </li>
    133. 

  133. </ul>
    134. 

  134. </div>
    135. 

  135. <div class="summary">
    136. 

  136. <ul class="blockList">
    137. 

  137. <li class="blockList">
    138. 

  138. <!-- ========== METHOD SUMMARY =========== -->
    139. 

  139. <section role="region">
    140. 

  140. <ul class="blockList">
    141. 

  141. <li class="blockList"><a id="method.summary">
    142. 

  142. <!--   -->
    143. 

  143. </a>
    144. 

  144. <h3>Method Summary</h3>
    145. 

  145. <table class="memberSummary">
    146. 

  146. <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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
    147. 

  147. <tr>
    148. 

  148. <th class="colFirst" scope="col">Modifier and Type</th>
    149. 

  149. <th class="colSecond" scope="col">Method</th>
    150. 

  150. <th class="colLast" scope="col">Description</th>
    151. 

  151. </tr>
    152. 

  152. <tr id="i0" class="altColor">
    153. 

  153. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
    154. 

  154. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#alterAlias(io.milvus.param.alias.AlterAliasParam)">alterAlias</a></span>&#8203;(<a href="../param/alias/AlterAliasParam.html" title="class in io.milvus.param.alias">AlterAliasParam</a>&nbsp;requestParam)</code></th>
    155. 

  155. <td class="colLast">
    156. 

  156. <div class="block">Alters alias from a collection to another.</div>
    157. 

  157. </td>
    158. 

  158. </tr>
    159. 

  159. <tr id="i1" class="rowColor">
    160. 

  160. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.CalcDistanceResults&gt;</code></td>
    161. 

  161. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#calcDistance(io.milvus.param.dml.CalcDistanceParam)">calcDistance</a></span>&#8203;(<a href="../param/dml/CalcDistanceParam.html" title="class in io.milvus.param.dml">CalcDistanceParam</a>&nbsp;requestParam)</code></th>
    162. 

  162. <td class="colLast">
    163. 

  163. <div class="block">Calculates the distance between the specified vectors.</div>
    164. 

  164. </td>
    165. 

  165. </tr>
    166. 

  166. <tr id="i2" class="altColor">
    167. 

  167. <td class="colFirst"><code>default void</code></td>
    168. 

  168. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close()">close</a></span>()</code></th>
    169. 

  169. <td class="colLast">
    170. 

  170. <div class="block">Disconnects from a Milvus server with timeout of 1 minute</div>
    171. 

  171. </td>
    172. 

  172. </tr>
    173. 

  173. <tr id="i3" class="rowColor">
    174. 

  174. <td class="colFirst"><code>void</code></td>
    175. 

  175. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close(long)">close</a></span>&#8203;(long&nbsp;maxWaitSeconds)</code></th>
    176. 

  176. <td class="colLast">
    177. 

  177. <div class="block">Disconnects from a Milvus server with configurable timeout.</div>
    178. 

  178. </td>
    179. 

  179. </tr>
    180. 

  180. <tr id="i4" class="altColor">
    181. 

  181. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
    182. 

  182. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createAlias(io.milvus.param.alias.CreateAliasParam)">createAlias</a></span>&#8203;(<a href="../param/alias/CreateAliasParam.html" title="class in io.milvus.param.alias">CreateAliasParam</a>&nbsp;requestParam)</code></th>
    183. 

  183. <td class="colLast">
    184. 

  184. <div class="block">Creates an alias for a collection.</div>
    185. 

  185. </td>
    186. 

  186. </tr>
    187. 

  187. <tr id="i5" class="rowColor">
    188. 

  188. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
    189. 

  189. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createCollection(io.milvus.param.collection.CreateCollectionParam)">createCollection</a></span>&#8203;(<a href="../param/collection/CreateCollectionParam.html" title="class in io.milvus.param.collection">CreateCollectionParam</a>&nbsp;requestParam)</code></th>
    190. 

  190. <td class="colLast">
    191. 

  191. <div class="block">Creates a collection in Milvus.</div>
    192. 

  192. </td>
    193. 

  193. </tr>
    194. 

  194. <tr id="i6" class="altColor">
    195. 

  195. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
    196. 

  196. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createIndex(io.milvus.param.index.CreateIndexParam)">createIndex</a></span>&#8203;(<a href="../param/index/CreateIndexParam.html" title="class in io.milvus.param.index">CreateIndexParam</a>&nbsp;requestParam)</code></th>
    197. 

  197. <td class="colLast">
    198. 

  198. <div class="block">Creates an index on a vector field in the specified collection.</div>
    199. 

  199. </td>
    200. 

  200. </tr>
    201. 

  201. <tr id="i7" class="rowColor">
    202. 

  202. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
    203. 

  203. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createPartition(io.milvus.param.partition.CreatePartitionParam)">createPartition</a></span>&#8203;(<a href="../param/partition/CreatePartitionParam.html" title="class in io.milvus.param.partition">CreatePartitionParam</a>&nbsp;requestParam)</code></th>
    204. 

  204. <td class="colLast">
    205. 

  205. <div class="block">Creates a partition in the specified collection.</div>
    206. 

  206. </td>
    207. 

  207. </tr>
    208. 

  208. <tr id="i8" class="altColor">
    209. 

  209. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.MutationResult&gt;</code></td>
    210. 

  210. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#delete(io.milvus.param.dml.DeleteParam)">delete</a></span>&#8203;(<a href="../param/dml/DeleteParam.html" title="class in io.milvus.param.dml">DeleteParam</a>&nbsp;requestParam)</code></th>
    211. 

  211. <td class="colLast">
    212. 

  212. <div class="block">Deletes entity(s) based on primary key(s) filtered by boolean expression.</div>
    213. 

  213. </td>
    214. 

  214. </tr>
    215. 

  215. <tr id="i9" class="rowColor">
    216. 

  216. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.DescribeCollectionResponse&gt;</code></td>
    217. 

  217. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#describeCollection(io.milvus.param.collection.DescribeCollectionParam)">describeCollection</a></span>&#8203;(<a href="../param/collection/DescribeCollectionParam.html" title="class in io.milvus.param.collection">DescribeCollectionParam</a>&nbsp;requestParam)</code></th>
    218. 

  218. <td class="colLast">
    219. 

  219. <div class="block">Shows the details of a collection, e.g.</div>
    220. 

  220. </td>
    221. 

  221. </tr>
    222. 

  222. <tr id="i10" class="altColor">
    223. 

  223. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.DescribeIndexResponse&gt;</code></td>
    224. 

  224. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#describeIndex(io.milvus.param.index.DescribeIndexParam)">describeIndex</a></span>&#8203;(<a href="../param/index/DescribeIndexParam.html" title="class in io.milvus.param.index">DescribeIndexParam</a>&nbsp;requestParam)</code></th>
    225. 

  225. <td class="colLast">
    226. 

  226. <div class="block">Shows the information of the specified index.</div>
    227. 

  227. </td>
    228. 

  228. </tr>
    229. 

  229. <tr id="i11" class="rowColor">
    230. 

  230. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
    231. 

  231. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropAlias(io.milvus.param.alias.DropAliasParam)">dropAlias</a></span>&#8203;(<a href="../param/alias/DropAliasParam.html" title="class in io.milvus.param.alias">DropAliasParam</a>&nbsp;requestParam)</code></th>
    232. 

  232. <td class="colLast">
    233. 

  233. <div class="block">Drops an alias for the specified collection.</div>
    234. 

  234. </td>
    235. 

  235. </tr>
    236. 

  236. <tr id="i12" class="altColor">
    237. 

  237. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
    238. 

  238. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropCollection(io.milvus.param.collection.DropCollectionParam)">dropCollection</a></span>&#8203;(<a href="../param/collection/DropCollectionParam.html" title="class in io.milvus.param.collection">DropCollectionParam</a>&nbsp;requestParam)</code></th>
    239. 

  239. <td class="colLast">
    240. 

  240. <div class="block">Drops a collection.</div>
    241. 

  241. </td>
    242. 

  242. </tr>
    243. 

  243. <tr id="i13" class="rowColor">
    244. 

  244. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
    245. 

  245. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropIndex(io.milvus.param.index.DropIndexParam)">dropIndex</a></span>&#8203;(<a href="../param/index/DropIndexParam.html" title="class in io.milvus.param.index">DropIndexParam</a>&nbsp;requestParam)</code></th>
    246. 

  246. <td class="colLast">
    247. 

  247. <div class="block">Drops the index on a vector field in the specified collection.</div>
    248. 

  248. </td>
    249. 

  249. </tr>
    250. 

  250. <tr id="i14" class="altColor">
    251. 

  251. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
    252. 

  252. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropPartition(io.milvus.param.partition.DropPartitionParam)">dropPartition</a></span>&#8203;(<a href="../param/partition/DropPartitionParam.html" title="class in io.milvus.param.partition">DropPartitionParam</a>&nbsp;requestParam)</code></th>
    253. 

  253. <td class="colLast">
    254. 

  254. <div class="block">Drops a partition.</div>
    255. 

  255. </td>
    256. 

  256. </tr>
    257. 

  257. <tr id="i15" class="rowColor">
    258. 

  258. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetCollectionStatisticsResponse&gt;</code></td>
    259. 

  259. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCollectionStatistics(io.milvus.param.collection.GetCollectionStatisticsParam)">getCollectionStatistics</a></span>&#8203;(<a href="../param/collection/GetCollectionStatisticsParam.html" title="class in io.milvus.param.collection">GetCollectionStatisticsParam</a>&nbsp;requestParam)</code></th>
    260. 

  260. <td class="colLast">
    261. 

  261. <div class="block">Shows the statistics information of a collection.</div>
    262. 

  262. </td>
    263. 

  263. </tr>
    264. 

  264. <tr id="i16" class="altColor">
    265. 

  265. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetCompactionStateResponse&gt;</code></td>
    266. 

  266. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCompactionState(io.milvus.param.control.GetCompactionStateParam)">getCompactionState</a></span>&#8203;(<a href="../param/control/GetCompactionStateParam.html" title="class in io.milvus.param.control">GetCompactionStateParam</a>&nbsp;requestParam)</code></th>
    267. 

  267. <td class="colLast">
    268. 

  268. <div class="block">Gets the compaction state by id.</div>
    269. 

  269. </td>
    270. 

  270. </tr>
    271. 

  271. <tr id="i17" class="rowColor">
    272. 

  272. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetCompactionPlansResponse&gt;</code></td>
    273. 

  273. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCompactionStateWithPlans(io.milvus.param.control.GetCompactionPlansParam)">getCompactionStateWithPlans</a></span>&#8203;(<a href="../param/control/GetCompactionPlansParam.html" title="class in io.milvus.param.control">GetCompactionPlansParam</a>&nbsp;requestParam)</code></th>
    274. 

  274. <td class="colLast">
    275. 

  275. <div class="block">Gets compaction state with its plan.</div>
    276. 

  276. </td>
    277. 

  277. </tr>
    278. 

  278. <tr id="i18" class="altColor">
    279. 

  279. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetFlushStateResponse&gt;</code></td>
    280. 

  280. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFlushState(io.milvus.param.control.GetFlushStateParam)">getFlushState</a></span>&#8203;(<a href="../param/control/GetFlushStateParam.html" title="class in io.milvus.param.control">GetFlushStateParam</a>&nbsp;requestParam)</code></th>
    281. 

  281. <td class="colLast">
    282. 

  282. <div class="block">Get flush state of specified segments.</div>
    283. 

  283. </td>
    284. 

  284. </tr>
    285. 

  285. <tr id="i19" class="rowColor">
    286. 

  286. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetIndexBuildProgressResponse&gt;</code></td>
    287. 

  287. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIndexBuildProgress(io.milvus.param.index.GetIndexBuildProgressParam)">getIndexBuildProgress</a></span>&#8203;(<a href="../param/index/GetIndexBuildProgressParam.html" title="class in io.milvus.param.index">GetIndexBuildProgressParam</a>&nbsp;requestParam)</code></th>
    288. 

  288. <td class="colLast">
    289. 

  289. <div class="block">Shows the index building progress, such as how many rows are indexed.</div>
    290. 

  290. </td>
    291. 

  291. </tr>
    292. 

  292. <tr id="i20" class="altColor">
    293. 

  293. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetIndexStateResponse&gt;</code></td>
    294. 

  294. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIndexState(io.milvus.param.index.GetIndexStateParam)">getIndexState</a></span>&#8203;(<a href="../param/index/GetIndexStateParam.html" title="class in io.milvus.param.index">GetIndexStateParam</a>&nbsp;requestParam)</code></th>
    295. 

  295. <td class="colLast">
    296. 

  296. <div class="block">Shows the index building state(in-progress/finished/failed), and the reason for failure (if any).</div>
    297. 

  297. </td>
    298. 

  298. </tr>
    299. 

  299. <tr id="i21" class="rowColor">
    300. 

  300. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetMetricsResponse&gt;</code></td>
    301. 

  301. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMetrics(io.milvus.param.control.GetMetricsParam)">getMetrics</a></span>&#8203;(<a href="../param/control/GetMetricsParam.html" title="class in io.milvus.param.control">GetMetricsParam</a>&nbsp;requestParam)</code></th>
    302. 

  302. <td class="colLast">
    303. 

  303. <div class="block">Gets the runtime metrics information of Milvus, returns the result in .json format.</div>
    304. 

  304. </td>
    305. 

  305. </tr>
    306. 

  306. <tr id="i22" class="altColor">
    307. 

  307. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetPartitionStatisticsResponse&gt;</code></td>
    308. 

  308. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPartitionStatistics(io.milvus.param.partition.GetPartitionStatisticsParam)">getPartitionStatistics</a></span>&#8203;(<a href="../param/partition/GetPartitionStatisticsParam.html" title="class in io.milvus.param.partition">GetPartitionStatisticsParam</a>&nbsp;requestParam)</code></th>
    309. 

  309. <td class="colLast">
    310. 

  310. <div class="block">Shows the statistics information of a partition.</div>
    311. 

  311. </td>
    312. 

  312. </tr>
    313. 

  313. <tr id="i23" class="rowColor">
    314. 

  314. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetPersistentSegmentInfoResponse&gt;</code></td>
    315. 

  315. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPersistentSegmentInfo(io.milvus.param.control.GetPersistentSegmentInfoParam)">getPersistentSegmentInfo</a></span>&#8203;(<a href="../param/control/GetPersistentSegmentInfoParam.html" title="class in io.milvus.param.control">GetPersistentSegmentInfoParam</a>&nbsp;requestParam)</code></th>
    316. 

  316. <td class="colLast">
    317. 

  317. <div class="block">Gets the information of persistent segments from data node, including row count,
    318. 

  318.  persistence state(growing or flushed), etc.</div>
    319. 

  319. </td>
    320. 

  320. </tr>
    321. 

  321. <tr id="i24" class="altColor">
    322. 

  322. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetQuerySegmentInfoResponse&gt;</code></td>
    323. 

  323. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getQuerySegmentInfo(io.milvus.param.control.GetQuerySegmentInfoParam)">getQuerySegmentInfo</a></span>&#8203;(<a href="../param/control/GetQuerySegmentInfoParam.html" title="class in io.milvus.param.control">GetQuerySegmentInfoParam</a>&nbsp;requestParam)</code></th>
    324. 

  324. <td class="colLast">
    325. 

  325. <div class="block">Gets the query information of segments in a collection from query node, including row count,
    326. 

  326.  memory usage size, index name, etc.</div>
    327. 

  327. </td>
    328. 

  328. </tr>
    329. 

  329. <tr id="i25" class="rowColor">
    330. 

  330. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;java.lang.Boolean&gt;</code></td>
    331. 

  331. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasCollection(io.milvus.param.collection.HasCollectionParam)">hasCollection</a></span>&#8203;(<a href="../param/collection/HasCollectionParam.html" title="class in io.milvus.param.collection">HasCollectionParam</a>&nbsp;requestParam)</code></th>
    332. 

  332. <td class="colLast">
    333. 

  333. <div class="block">Checks if a collection exists.</div>
    334. 

  334. </td>
    335. 

  335. </tr>
    336. 

  336. <tr id="i26" class="altColor">
    337. 

  337. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;java.lang.Boolean&gt;</code></td>
    338. 

  338. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasPartition(io.milvus.param.partition.HasPartitionParam)">hasPartition</a></span>&#8203;(<a href="../param/partition/HasPartitionParam.html" title="class in io.milvus.param.partition">HasPartitionParam</a>&nbsp;requestParam)</code></th>
    339. 

  339. <td class="colLast">
    340. 

  340. <div class="block">Checks if a partition exists in the specified collection.</div>
    341. 

  341. </td>
    342. 

  342. </tr>
    343. 

  343. <tr id="i27" class="rowColor">
    344. 

  344. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.MutationResult&gt;</code></td>
    345. 

  345. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#insert(io.milvus.param.dml.InsertParam)">insert</a></span>&#8203;(<a href="../param/dml/InsertParam.html" title="class in io.milvus.param.dml">InsertParam</a>&nbsp;requestParam)</code></th>
    346. 

  346. <td class="colLast">
    347. 

  347. <div class="block">Inserts entities into a specified collection.</div>
    348. 

  348. </td>
    349. 

  349. </tr>
    350. 

  350. <tr id="i28" class="altColor">
    351. 

  351. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
    352. 

  352. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#loadBalance(io.milvus.param.control.LoadBalanceParam)">loadBalance</a></span>&#8203;(<a href="../param/control/LoadBalanceParam.html" title="class in io.milvus.param.control">LoadBalanceParam</a>&nbsp;requestParam)</code></th>
    353. 

  353. <td class="colLast">
    354. 

  354. <div class="block">Moves segment from a query node to another to keep the load balanced.</div>
    355. 

  355. </td>
    356. 

  356. </tr>
    357. 

  357. <tr id="i29" class="rowColor">
    358. 

  358. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
    359. 

  359. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#loadCollection(io.milvus.param.collection.LoadCollectionParam)">loadCollection</a></span>&#8203;(<a href="../param/collection/LoadCollectionParam.html" title="class in io.milvus.param.collection">LoadCollectionParam</a>&nbsp;requestParam)</code></th>
    360. 

  360. <td class="colLast">
    361. 

  361. <div class="block">Loads a collection to memory before search or query.</div>
    362. 

  362. </td>
    363. 

  363. </tr>
    364. 

  364. <tr id="i30" class="altColor">
    365. 

  365. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
    366. 

  366. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#loadPartitions(io.milvus.param.partition.LoadPartitionsParam)">loadPartitions</a></span>&#8203;(<a href="../param/partition/LoadPartitionsParam.html" title="class in io.milvus.param.partition">LoadPartitionsParam</a>&nbsp;requestParam)</code></th>
    367. 

  367. <td class="colLast">
    368. 

  368. <div class="block">Loads a partition into memory.</div>
    369. 

  369. </td>
    370. 

  370. </tr>
    371. 

  371. <tr id="i31" class="rowColor">
    372. 

  372. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.ManualCompactionResponse&gt;</code></td>
    373. 

  373. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#manualCompaction(io.milvus.param.control.ManualCompactionParam)">manualCompaction</a></span>&#8203;(<a href="../param/control/ManualCompactionParam.html" title="class in io.milvus.param.control">ManualCompactionParam</a>&nbsp;requestParam)</code></th>
    374. 

  374. <td class="colLast">
    375. 

  375. <div class="block">Performs a manual compaction.</div>
    376. 

  376. </td>
    377. 

  377. </tr>
    378. 

  378. <tr id="i32" class="altColor">
    379. 

  379. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.QueryResults&gt;</code></td>
    380. 

  380. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#query(io.milvus.param.dml.QueryParam)">query</a></span>&#8203;(<a href="../param/dml/QueryParam.html" title="class in io.milvus.param.dml">QueryParam</a>&nbsp;requestParam)</code></th>
    381. 

  381. <td class="colLast">
    382. 

  382. <div class="block">Queries entity(s) based on scalar field(s) filtered by boolean expression.</div>
    383. 

  383. </td>
    384. 

  384. </tr>
    385. 

  385. <tr id="i33" class="rowColor">
    386. 

  386. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
    387. 

  387. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#releaseCollection(io.milvus.param.collection.ReleaseCollectionParam)">releaseCollection</a></span>&#8203;(<a href="../param/collection/ReleaseCollectionParam.html" title="class in io.milvus.param.collection">ReleaseCollectionParam</a>&nbsp;requestParam)</code></th>
    388. 

  388. <td class="colLast">
    389. 

  389. <div class="block">Releases a collection from memory to reduce memory usage.</div>
    390. 

  390. </td>
    391. 

  391. </tr>
    392. 

  392. <tr id="i34" class="altColor">
    393. 

  393. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
    394. 

  394. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#releasePartitions(io.milvus.param.partition.ReleasePartitionsParam)">releasePartitions</a></span>&#8203;(<a href="../param/partition/ReleasePartitionsParam.html" title="class in io.milvus.param.partition">ReleasePartitionsParam</a>&nbsp;requestParam)</code></th>
    395. 

  395. <td class="colLast">
    396. 

  396. <div class="block">Releases a partition from memory.</div>
    397. 

  397. </td>
    398. 

  398. </tr>
    399. 

  399. <tr id="i35" class="rowColor">
    400. 

  400. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.SearchResults&gt;</code></td>
    401. 

  401. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#search(io.milvus.param.dml.SearchParam)">search</a></span>&#8203;(<a href="../param/dml/SearchParam.html" title="class in io.milvus.param.dml">SearchParam</a>&nbsp;requestParam)</code></th>
    402. 

  402. <td class="colLast">
    403. 

  403. <div class="block">Conducts ANN search on a vector field.</div>
    404. 

  404. </td>
    405. 

  405. </tr>
    406. 

  406. <tr id="i36" class="altColor">
    407. 

  407. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.ShowCollectionsResponse&gt;</code></td>
    408. 

  408. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#showCollections(io.milvus.param.collection.ShowCollectionsParam)">showCollections</a></span>&#8203;(<a href="../param/collection/ShowCollectionsParam.html" title="class in io.milvus.param.collection">ShowCollectionsParam</a>&nbsp;requestParam)</code></th>
    409. 

  409. <td class="colLast">
    410. 

  410. <div class="block">Lists all collections or gets collection loading status.</div>
    411. 

  411. </td>
    412. 

  412. </tr>
    413. 

  413. <tr id="i37" class="rowColor">
    414. 

  414. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.ShowPartitionsResponse&gt;</code></td>
    415. 

  415. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#showPartitions(io.milvus.param.partition.ShowPartitionsParam)">showPartitions</a></span>&#8203;(<a href="../param/partition/ShowPartitionsParam.html" title="class in io.milvus.param.partition">ShowPartitionsParam</a>&nbsp;requestParam)</code></th>
    416. 

  416. <td class="colLast">
    417. 

  417. <div class="block">Shows all partitions in the specified collection.</div>
    418. 

  418. </td>
    419. 

  419. </tr>
    420. 

  420. <tr id="i38" class="altColor">
    421. 

  421. <td class="colFirst"><code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></td>
    422. 

  422. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withTimeout(long,java.util.concurrent.TimeUnit)">withTimeout</a></span>&#8203;(long&nbsp;timeout,
    423. 

  423.            java.util.concurrent.TimeUnit&nbsp;timeoutUnit)</code></th>
    424. 

  424. <td class="colLast">
    425. 

  425. <div class="block">Timeout setting for rpc call.</div>
    426. 

  426. </td>
    427. 

  427. </tr>
    428. 

  428. </table>
    429. 

  429. </li>
    430. 

  430. </ul>
    431. 

  431. </section>
    432. 

  432. </li>
    433. 

  433. </ul>
    434. 

  434. </div>
    435. 

  435. <div class="details">
    436. 

  436. <ul class="blockList">
    437. 

  437. <li class="blockList">
    438. 

  438. <!-- ============ METHOD DETAIL ========== -->
    439. 

  439. <section role="region">
    440. 

  440. <ul class="blockList">
    441. 

  441. <li class="blockList"><a id="method.detail">
    442. 

  442. <!--   -->
    443. 

  443. </a>
    444. 

  444. <h3>Method Detail</h3>
    445. 

  445. <a id="withTimeout(long,java.util.concurrent.TimeUnit)">
    446. 

  446. <!--   -->
    447. 

  447. </a>
    448. 

  448. <ul class="blockList">
    449. 

  449. <li class="blockList">
    450. 

  450. <h4>withTimeout</h4>
    451. 

  451. <pre class="methodSignature"><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a>&nbsp;withTimeout&#8203;(long&nbsp;timeout,
    452. 

  452.                          java.util.concurrent.TimeUnit&nbsp;timeoutUnit)</pre>
    453. 

  453. <div class="block">Timeout setting for rpc call.</div>
    454. 

  454. <dl>
    455. 

  455. <dt><span class="paramLabel">Parameters:</span></dt>
    456. 

  456. <dd><code>timeout</code> - set time waiting for a rpc call.</dd>
    457. 

  457. <dd><code>timeoutUnit</code> - time unit</dd>
    458. 

  458. </dl>
    459. 

  459. </li>
    460. 

  460. </ul>
    461. 

  461. <a id="close()">
    462. 

  462. <!--   -->
    463. 

  463. </a>
    464. 

  464. <ul class="blockList">
    465. 

  465. <li class="blockList">
    466. 

  466. <h4>close</h4>
    467. 

  467. <pre class="methodSignature">default&nbsp;void&nbsp;close()</pre>
    468. 

  468. <div class="block">Disconnects from a Milvus server with timeout of 1 minute</div>
    469. 

  469. </li>
    470. 

  470. </ul>
    471. 

  471. <a id="close(long)">
    472. 

  472. <!--   -->
    473. 

  473. </a>
    474. 

  474. <ul class="blockList">
    475. 

  475. <li class="blockList">
    476. 

  476. <h4>close</h4>
    477. 

  477. <pre class="methodSignature">void&nbsp;close&#8203;(long&nbsp;maxWaitSeconds)
    478. 

  478.     throws java.lang.InterruptedException</pre>
    479. 

  479. <div class="block">Disconnects from a Milvus server with configurable timeout.</div>
    480. 

  480. <dl>
    481. 

  481. <dt><span class="paramLabel">Parameters:</span></dt>
    482. 

  482. <dd><code>maxWaitSeconds</code> - timeout unit: second</dd>
    483. 

  483. <dt><span class="throwsLabel">Throws:</span></dt>
    484. 

  484. <dd><code>java.lang.InterruptedException</code></dd>
    485. 

  485. </dl>
    486. 

  486. </li>
    487. 

  487. </ul>
    488. 

  488. <a id="hasCollection(io.milvus.param.collection.HasCollectionParam)">
    489. 

  489. <!--   -->
    490. 

  490. </a>
    491. 

  491. <ul class="blockList">
    492. 

  492. <li class="blockList">
    493. 

  493. <h4>hasCollection</h4>
    494. 

  494. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;java.lang.Boolean&gt;&nbsp;hasCollection&#8203;(<a href="../param/collection/HasCollectionParam.html" title="class in io.milvus.param.collection">HasCollectionParam</a>&nbsp;requestParam)</pre>
    495. 

  495. <div class="block">Checks if a collection exists.</div>
    496. 

  496. <dl>
    497. 

  497. <dt><span class="paramLabel">Parameters:</span></dt>
    498. 

  498. <dd><code>requestParam</code> - <a href="../param/collection/HasCollectionParam.html" title="class in io.milvus.param.collection"><code>HasCollectionParam</code></a></dd>
    499. 

  499. <dt><span class="returnLabel">Returns:</span></dt>
    500. 

  500. <dd>{status:result code, data: boolean, whether if has collection or not}</dd>
    501. 

  501. </dl>
    502. 

  502. </li>
    503. 

  503. </ul>
    504. 

  504. <a id="createCollection(io.milvus.param.collection.CreateCollectionParam)">
    505. 

  505. <!--   -->
    506. 

  506. </a>
    507. 

  507. <ul class="blockList">
    508. 

  508. <li class="blockList">
    509. 

  509. <h4>createCollection</h4>
    510. 

  510. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;createCollection&#8203;(<a href="../param/collection/CreateCollectionParam.html" title="class in io.milvus.param.collection">CreateCollectionParam</a>&nbsp;requestParam)</pre>
    511. 

  511. <div class="block">Creates a collection in Milvus.</div>
    512. 

  512. <dl>
    513. 

  513. <dt><span class="paramLabel">Parameters:</span></dt>
    514. 

  514. <dd><code>requestParam</code> - <a href="../param/collection/CreateCollectionParam.html" title="class in io.milvus.param.collection"><code>CreateCollectionParam</code></a></dd>
    515. 

  515. <dt><span class="returnLabel">Returns:</span></dt>
    516. 

  516. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
    517. 

  517. </dl>
    518. 

  518. </li>
    519. 

  519. </ul>
    520. 

  520. <a id="dropCollection(io.milvus.param.collection.DropCollectionParam)">
    521. 

  521. <!--   -->
    522. 

  522. </a>
    523. 

  523. <ul class="blockList">
    524. 

  524. <li class="blockList">
    525. 

  525. <h4>dropCollection</h4>
    526. 

  526. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;dropCollection&#8203;(<a href="../param/collection/DropCollectionParam.html" title="class in io.milvus.param.collection">DropCollectionParam</a>&nbsp;requestParam)</pre>
    527. 

  527. <div class="block">Drops a collection. Note that this method drops all data in the collection.</div>
    528. 

  528. <dl>
    529. 

  529. <dt><span class="paramLabel">Parameters:</span></dt>
    530. 

  530. <dd><code>requestParam</code> - <a href="../param/collection/DropCollectionParam.html" title="class in io.milvus.param.collection"><code>DropCollectionParam</code></a></dd>
    531. 

  531. <dt><span class="returnLabel">Returns:</span></dt>
    532. 

  532. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
    533. 

  533. </dl>
    534. 

  534. </li>
    535. 

  535. </ul>
    536. 

  536. <a id="loadCollection(io.milvus.param.collection.LoadCollectionParam)">
    537. 

  537. <!--   -->
    538. 

  538. </a>
    539. 

  539. <ul class="blockList">
    540. 

  540. <li class="blockList">
    541. 

  541. <h4>loadCollection</h4>
    542. 

  542. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;loadCollection&#8203;(<a href="../param/collection/LoadCollectionParam.html" title="class in io.milvus.param.collection">LoadCollectionParam</a>&nbsp;requestParam)</pre>
    543. 

  543. <div class="block">Loads a collection to memory before search or query.</div>
    544. 

  544. <dl>
    545. 

  545. <dt><span class="paramLabel">Parameters:</span></dt>
    546. 

  546. <dd><code>requestParam</code> - <a href="../param/collection/LoadCollectionParam.html" title="class in io.milvus.param.collection"><code>LoadCollectionParam</code></a></dd>
    547. 

  547. <dt><span class="returnLabel">Returns:</span></dt>
    548. 

  548. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
    549. 

  549. </dl>
    550. 

  550. </li>
    551. 

  551. </ul>
    552. 

  552. <a id="releaseCollection(io.milvus.param.collection.ReleaseCollectionParam)">
    553. 

  553. <!--   -->
    554. 

  554. </a>
    555. 

  555. <ul class="blockList">
    556. 

  556. <li class="blockList">
    557. 

  557. <h4>releaseCollection</h4>
    558. 

  558. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;releaseCollection&#8203;(<a href="../param/collection/ReleaseCollectionParam.html" title="class in io.milvus.param.collection">ReleaseCollectionParam</a>&nbsp;requestParam)</pre>
    559. 

  559. <div class="block">Releases a collection from memory to reduce memory usage. Note that you 
    560. 

  560.  cannot search while the corresponding collection is released from memory.</div>
    561. 

  561. <dl>
    562. 

  562. <dt><span class="paramLabel">Parameters:</span></dt>
    563. 

  563. <dd><code>requestParam</code> - <a href="../param/collection/ReleaseCollectionParam.html" title="class in io.milvus.param.collection"><code>ReleaseCollectionParam</code></a></dd>
    564. 

  564. <dt><span class="returnLabel">Returns:</span></dt>
    565. 

  565. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
    566. 

  566. </dl>
    567. 

  567. </li>
    568. 

  568. </ul>
    569. 

  569. <a id="describeCollection(io.milvus.param.collection.DescribeCollectionParam)">
    570. 

  570. <!--   -->
    571. 

  571. </a>
    572. 

  572. <ul class="blockList">
    573. 

  573. <li class="blockList">
    574. 

  574. <h4>describeCollection</h4>
    575. 

  575. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.DescribeCollectionResponse&gt;&nbsp;describeCollection&#8203;(<a href="../param/collection/DescribeCollectionParam.html" title="class in io.milvus.param.collection">DescribeCollectionParam</a>&nbsp;requestParam)</pre>
    576. 

  576. <div class="block">Shows the details of a collection, e.g. name, schema.</div>
    577. 

  577. <dl>
    578. 

  578. <dt><span class="paramLabel">Parameters:</span></dt>
    579. 

  579. <dd><code>requestParam</code> - <a href="../param/collection/DescribeCollectionParam.html" title="class in io.milvus.param.collection"><code>DescribeCollectionParam</code></a></dd>
    580. 

  580. <dt><span class="returnLabel">Returns:</span></dt>
    581. 

  581. <dd>{status:result code, data:DescribeCollectionResponse{schema,collectionID}}</dd>
    582. 

  582. </dl>
    583. 

  583. </li>
    584. 

  584. </ul>
    585. 

  585. <a id="getCollectionStatistics(io.milvus.param.collection.GetCollectionStatisticsParam)">
    586. 

  586. <!--   -->
    587. 

  587. </a>
    588. 

  588. <ul class="blockList">
    589. 

  589. <li class="blockList">
    590. 

  590. <h4>getCollectionStatistics</h4>
    591. 

  591. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetCollectionStatisticsResponse&gt;&nbsp;getCollectionStatistics&#8203;(<a href="../param/collection/GetCollectionStatisticsParam.html" title="class in io.milvus.param.collection">GetCollectionStatisticsParam</a>&nbsp;requestParam)</pre>
    592. 

  592. <div class="block">Shows the statistics information of a collection.</div>
    593. 

  593. <dl>
    594. 

  594. <dt><span class="paramLabel">Parameters:</span></dt>
    595. 

  595. <dd><code>requestParam</code> - <a href="../param/collection/GetCollectionStatisticsParam.html" title="class in io.milvus.param.collection"><code>GetCollectionStatisticsParam</code></a></dd>
    596. 

  596. <dt><span class="returnLabel">Returns:</span></dt>
    597. 

  597. <dd>{status:result code, data: GetCollectionStatisticsResponse{status,stats}}</dd>
    598. 

  598. </dl>
    599. 

  599. </li>
    600. 

  600. </ul>
    601. 

  601. <a id="showCollections(io.milvus.param.collection.ShowCollectionsParam)">
    602. 

  602. <!--   -->
    603. 

  603. </a>
    604. 

  604. <ul class="blockList">
    605. 

  605. <li class="blockList">
    606. 

  606. <h4>showCollections</h4>
    607. 

  607. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.ShowCollectionsResponse&gt;&nbsp;showCollections&#8203;(<a href="../param/collection/ShowCollectionsParam.html" title="class in io.milvus.param.collection">ShowCollectionsParam</a>&nbsp;requestParam)</pre>
    608. 

  608. <div class="block">Lists all collections or gets collection loading status.</div>
    609. 

  609. <dl>
    610. 

  610. <dt><span class="paramLabel">Parameters:</span></dt>
    611. 

  611. <dd><code>requestParam</code> - <a href="../param/collection/ShowCollectionsParam.html" title="class in io.milvus.param.collection"><code>ShowCollectionsParam</code></a></dd>
    612. 

  612. <dt><span class="returnLabel">Returns:</span></dt>
    613. 

  613. <dd>{status:result code, data: ShowCollectionsResponse{status,collection_names,collection_ids,created_timestamps,created_utc_timestamps}}</dd>
    614. 

  614. </dl>
    615. 

  615. </li>
    616. 

  616. </ul>
    617. 

  617. <a id="createPartition(io.milvus.param.partition.CreatePartitionParam)">
    618. 

  618. <!--   -->
    619. 

  619. </a>
    620. 

  620. <ul class="blockList">
    621. 

  621. <li class="blockList">
    622. 

  622. <h4>createPartition</h4>
    623. 

  623. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;createPartition&#8203;(<a href="../param/partition/CreatePartitionParam.html" title="class in io.milvus.param.partition">CreatePartitionParam</a>&nbsp;requestParam)</pre>
    624. 

  624. <div class="block">Creates a partition in the specified collection.</div>
    625. 

  625. <dl>
    626. 

  626. <dt><span class="paramLabel">Parameters:</span></dt>
    627. 

  627. <dd><code>requestParam</code> - <a href="../param/partition/CreatePartitionParam.html" title="class in io.milvus.param.partition"><code>CreatePartitionParam</code></a></dd>
    628. 

  628. <dt><span class="returnLabel">Returns:</span></dt>
    629. 

  629. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
    630. 

  630. </dl>
    631. 

  631. </li>
    632. 

  632. </ul>
    633. 

  633. <a id="dropPartition(io.milvus.param.partition.DropPartitionParam)">
    634. 

  634. <!--   -->
    635. 

  635. </a>
    636. 

  636. <ul class="blockList">
    637. 

  637. <li class="blockList">
    638. 

  638. <h4>dropPartition</h4>
    639. 

  639. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;dropPartition&#8203;(<a href="../param/partition/DropPartitionParam.html" title="class in io.milvus.param.partition">DropPartitionParam</a>&nbsp;requestParam)</pre>
    640. 

  640. <div class="block">Drops a partition. Note that this method drops all data in this partition 
    641. 

  641.  and the _default partition cannot be dropped.</div>
    642. 

  642. <dl>
    643. 

  643. <dt><span class="paramLabel">Parameters:</span></dt>
    644. 

  644. <dd><code>requestParam</code> - <a href="../param/partition/DropPartitionParam.html" title="class in io.milvus.param.partition"><code>DropPartitionParam</code></a></dd>
    645. 

  645. <dt><span class="returnLabel">Returns:</span></dt>
    646. 

  646. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
    647. 

  647. </dl>
    648. 

  648. </li>
    649. 

  649. </ul>
    650. 

  650. <a id="hasPartition(io.milvus.param.partition.HasPartitionParam)">
    651. 

  651. <!--   -->
    652. 

  652. </a>
    653. 

  653. <ul class="blockList">
    654. 

  654. <li class="blockList">
    655. 

  655. <h4>hasPartition</h4>
    656. 

  656. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;java.lang.Boolean&gt;&nbsp;hasPartition&#8203;(<a href="../param/partition/HasPartitionParam.html" title="class in io.milvus.param.partition">HasPartitionParam</a>&nbsp;requestParam)</pre>
    657. 

  657. <div class="block">Checks if a partition exists in the specified collection.</div>
    658. 

  658. <dl>
    659. 

  659. <dt><span class="paramLabel">Parameters:</span></dt>
    660. 

  660. <dd><code>requestParam</code> - <a href="../param/partition/HasPartitionParam.html" title="class in io.milvus.param.partition"><code>HasPartitionParam</code></a></dd>
    661. 

  661. <dt><span class="returnLabel">Returns:</span></dt>
    662. 

  662. <dd>{status:result code, data: boolean, whether if has collection or not}</dd>
    663. 

  663. </dl>
    664. 

  664. </li>
    665. 

  665. </ul>
    666. 

  666. <a id="loadPartitions(io.milvus.param.partition.LoadPartitionsParam)">
    667. 

  667. <!--   -->
    668. 

  668. </a>
    669. 

  669. <ul class="blockList">
    670. 

  670. <li class="blockList">
    671. 

  671. <h4>loadPartitions</h4>
    672. 

  672. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;loadPartitions&#8203;(<a href="../param/partition/LoadPartitionsParam.html" title="class in io.milvus.param.partition">LoadPartitionsParam</a>&nbsp;requestParam)</pre>
    673. 

  673. <div class="block">Loads a partition into memory.</div>
    674. 

  674. <dl>
    675. 

  675. <dt><span class="paramLabel">Parameters:</span></dt>
    676. 

  676. <dd><code>requestParam</code> - <a href="../param/partition/LoadPartitionsParam.html" title="class in io.milvus.param.partition"><code>LoadPartitionsParam</code></a></dd>
    677. 

  677. <dt><span class="returnLabel">Returns:</span></dt>
    678. 

  678. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
    679. 

  679. </dl>
    680. 

  680. </li>
    681. 

  681. </ul>
    682. 

  682. <a id="releasePartitions(io.milvus.param.partition.ReleasePartitionsParam)">
    683. 

  683. <!--   -->
    684. 

  684. </a>
    685. 

  685. <ul class="blockList">
    686. 

  686. <li class="blockList">
    687. 

  687. <h4>releasePartitions</h4>
    688. 

  688. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;releasePartitions&#8203;(<a href="../param/partition/ReleasePartitionsParam.html" title="class in io.milvus.param.partition">ReleasePartitionsParam</a>&nbsp;requestParam)</pre>
    689. 

  689. <div class="block">Releases a partition from memory.</div>
    690. 

  690. <dl>
    691. 

  691. <dt><span class="paramLabel">Parameters:</span></dt>
    692. 

  692. <dd><code>requestParam</code> - <a href="../param/partition/ReleasePartitionsParam.html" title="class in io.milvus.param.partition"><code>ReleasePartitionsParam</code></a></dd>
    693. 

  693. <dt><span class="returnLabel">Returns:</span></dt>
    694. 

  694. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
    695. 

  695. </dl>
    696. 

  696. </li>
    697. 

  697. </ul>
    698. 

  698. <a id="getPartitionStatistics(io.milvus.param.partition.GetPartitionStatisticsParam)">
    699. 

  699. <!--   -->
    700. 

  700. </a>
    701. 

  701. <ul class="blockList">
    702. 

  702. <li class="blockList">
    703. 

  703. <h4>getPartitionStatistics</h4>
    704. 

  704. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetPartitionStatisticsResponse&gt;&nbsp;getPartitionStatistics&#8203;(<a href="../param/partition/GetPartitionStatisticsParam.html" title="class in io.milvus.param.partition">GetPartitionStatisticsParam</a>&nbsp;requestParam)</pre>
    705. 

  705. <div class="block">Shows the statistics information of a partition.</div>
    706. 

  706. <dl>
    707. 

  707. <dt><span class="paramLabel">Parameters:</span></dt>
    708. 

  708. <dd><code>requestParam</code> - <a href="../param/partition/GetPartitionStatisticsParam.html" title="class in io.milvus.param.partition"><code>GetPartitionStatisticsParam</code></a></dd>
    709. 

  709. <dt><span class="returnLabel">Returns:</span></dt>
    710. 

  710. <dd>{status:result code,data:GetPartitionStatisticsResponse{status,stats}}</dd>
    711. 

  711. </dl>
    712. 

  712. </li>
    713. 

  713. </ul>
    714. 

  714. <a id="showPartitions(io.milvus.param.partition.ShowPartitionsParam)">
    715. 

  715. <!--   -->
    716. 

  716. </a>
    717. 

  717. <ul class="blockList">
    718. 

  718. <li class="blockList">
    719. 

  719. <h4>showPartitions</h4>
    720. 

  720. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.ShowPartitionsResponse&gt;&nbsp;showPartitions&#8203;(<a href="../param/partition/ShowPartitionsParam.html" title="class in io.milvus.param.partition">ShowPartitionsParam</a>&nbsp;requestParam)</pre>
    721. 

  721. <div class="block">Shows all partitions in the specified collection.</div>
    722. 

  722. <dl>
    723. 

  723. <dt><span class="paramLabel">Parameters:</span></dt>
    724. 

  724. <dd><code>requestParam</code> - <a href="../param/partition/ShowPartitionsParam.html" title="class in io.milvus.param.partition"><code>ShowPartitionsParam</code></a></dd>
    725. 

  725. <dt><span class="returnLabel">Returns:</span></dt>
    726. 

  726. <dd>{status:result code, data:ShowPartitionsResponse{partition_names,partitionIDs,created_timestamps,created_utc_timestamps}}</dd>
    727. 

  727. </dl>
    728. 

  728. </li>
    729. 

  729. </ul>
    730. 

  730. <a id="createAlias(io.milvus.param.alias.CreateAliasParam)">
    731. 

  731. <!--   -->
    732. 

  732. </a>
    733. 

  733. <ul class="blockList">
    734. 

  734. <li class="blockList">
    735. 

  735. <h4>createAlias</h4>
    736. 

  736. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;createAlias&#8203;(<a href="../param/alias/CreateAliasParam.html" title="class in io.milvus.param.alias">CreateAliasParam</a>&nbsp;requestParam)</pre>
    737. 

  737. <div class="block">Creates an alias for a collection.
    738. 

  738.  Alias can be used in search or query to replace the collection name</div>
    739. 

  739. <dl>
    740. 

  740. <dt><span class="paramLabel">Parameters:</span></dt>
    741. 

  741. <dd><code>requestParam</code> - <a href="../param/alias/CreateAliasParam.html" title="class in io.milvus.param.alias"><code>CreateAliasParam</code></a></dd>
    742. 

  742. <dt><span class="returnLabel">Returns:</span></dt>
    743. 

  743. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
    744. 

  744. </dl>
    745. 

  745. </li>
    746. 

  746. </ul>
    747. 

  747. <a id="dropAlias(io.milvus.param.alias.DropAliasParam)">
    748. 

  748. <!--   -->
    749. 

  749. </a>
    750. 

  750. <ul class="blockList">
    751. 

  751. <li class="blockList">
    752. 

  752. <h4>dropAlias</h4>
    753. 

  753. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;dropAlias&#8203;(<a href="../param/alias/DropAliasParam.html" title="class in io.milvus.param.alias">DropAliasParam</a>&nbsp;requestParam)</pre>
    754. 

  754. <div class="block">Drops an alias for the specified collection.</div>
    755. 

  755. <dl>
    756. 

  756. <dt><span class="paramLabel">Parameters:</span></dt>
    757. 

  757. <dd><code>requestParam</code> - <a href="../param/alias/DropAliasParam.html" title="class in io.milvus.param.alias"><code>DropAliasParam</code></a></dd>
    758. 

  758. <dt><span class="returnLabel">Returns:</span></dt>
    759. 

  759. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
    760. 

  760. </dl>
    761. 

  761. </li>
    762. 

  762. </ul>
    763. 

  763. <a id="alterAlias(io.milvus.param.alias.AlterAliasParam)">
    764. 

  764. <!--   -->
    765. 

  765. </a>
    766. 

  766. <ul class="blockList">
    767. 

  767. <li class="blockList">
    768. 

  768. <h4>alterAlias</h4>
    769. 

  769. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;alterAlias&#8203;(<a href="../param/alias/AlterAliasParam.html" title="class in io.milvus.param.alias">AlterAliasParam</a>&nbsp;requestParam)</pre>
    770. 

  770. <div class="block">Alters alias from a collection to another.</div>
    771. 

  771. <dl>
    772. 

  772. <dt><span class="paramLabel">Parameters:</span></dt>
    773. 

  773. <dd><code>requestParam</code> - <a href="../param/alias/AlterAliasParam.html" title="class in io.milvus.param.alias"><code>AlterAliasParam</code></a></dd>
    774. 

  774. <dt><span class="returnLabel">Returns:</span></dt>
    775. 

  775. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
    776. 

  776. </dl>
    777. 

  777. </li>
    778. 

  778. </ul>
    779. 

  779. <a id="createIndex(io.milvus.param.index.CreateIndexParam)">
    780. 

  780. <!--   -->
    781. 

  781. </a>
    782. 

  782. <ul class="blockList">
    783. 

  783. <li class="blockList">
    784. 

  784. <h4>createIndex</h4>
    785. 

  785. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;createIndex&#8203;(<a href="../param/index/CreateIndexParam.html" title="class in io.milvus.param.index">CreateIndexParam</a>&nbsp;requestParam)</pre>
    786. 

  786. <div class="block">Creates an index on a vector field in the specified collection.
    787. 

  787.  Note that index building is an async progress.</div>
    788. 

  788. <dl>
    789. 

  789. <dt><span class="paramLabel">Parameters:</span></dt>
    790. 

  790. <dd><code>requestParam</code> - <a href="../param/index/CreateIndexParam.html" title="class in io.milvus.param.index"><code>CreateIndexParam</code></a></dd>
    791. 

  791. <dt><span class="returnLabel">Returns:</span></dt>
    792. 

  792. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
    793. 

  793. </dl>
    794. 

  794. </li>
    795. 

  795. </ul>
    796. 

  796. <a id="dropIndex(io.milvus.param.index.DropIndexParam)">
    797. 

  797. <!--   -->
    798. 

  798. </a>
    799. 

  799. <ul class="blockList">
    800. 

  800. <li class="blockList">
    801. 

  801. <h4>dropIndex</h4>
    802. 

  802. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;dropIndex&#8203;(<a href="../param/index/DropIndexParam.html" title="class in io.milvus.param.index">DropIndexParam</a>&nbsp;requestParam)</pre>
    803. 

  803. <div class="block">Drops the index on a vector field in the specified collection.</div>
    804. 

  804. <dl>
    805. 

  805. <dt><span class="paramLabel">Parameters:</span></dt>
    806. 

  806. <dd><code>requestParam</code> - <a href="../param/index/DropIndexParam.html" title="class in io.milvus.param.index"><code>DropIndexParam</code></a></dd>
    807. 

  807. <dt><span class="returnLabel">Returns:</span></dt>
    808. 

  808. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
    809. 

  809. </dl>
    810. 

  810. </li>
    811. 

  811. </ul>
    812. 

  812. <a id="describeIndex(io.milvus.param.index.DescribeIndexParam)">
    813. 

  813. <!--   -->
    814. 

  814. </a>
    815. 

  815. <ul class="blockList">
    816. 

  816. <li class="blockList">
    817. 

  817. <h4>describeIndex</h4>
    818. 

  818. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.DescribeIndexResponse&gt;&nbsp;describeIndex&#8203;(<a href="../param/index/DescribeIndexParam.html" title="class in io.milvus.param.index">DescribeIndexParam</a>&nbsp;requestParam)</pre>
    819. 

  819. <div class="block">Shows the information of the specified index. Current release of Milvus 
    820. 

  820.  only supports showing latest built index.</div>
    821. 

  821. <dl>
    822. 

  822. <dt><span class="paramLabel">Parameters:</span></dt>
    823. 

  823. <dd><code>requestParam</code> - <a href="../param/index/DescribeIndexParam.html" title="class in io.milvus.param.index"><code>DescribeIndexParam</code></a></dd>
    824. 

  824. <dt><span class="returnLabel">Returns:</span></dt>
    825. 

  825. <dd>{status:result code, data:DescribeIndexResponse{status,index_descriptions}}</dd>
    826. 

  826. </dl>
    827. 

  827. </li>
    828. 

  828. </ul>
    829. 

  829. <a id="getIndexState(io.milvus.param.index.GetIndexStateParam)">
    830. 

  830. <!--   -->
    831. 

  831. </a>
    832. 

  832. <ul class="blockList">
    833. 

  833. <li class="blockList">
    834. 

  834. <h4>getIndexState</h4>
    835. 

  835. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetIndexStateResponse&gt;&nbsp;getIndexState&#8203;(<a href="../param/index/GetIndexStateParam.html" title="class in io.milvus.param.index">GetIndexStateParam</a>&nbsp;requestParam)</pre>
    836. 

  836. <div class="block">Shows the index building state(in-progress/finished/failed), and the reason for failure (if any).</div>
    837. 

  837. <dl>
    838. 

  838. <dt><span class="paramLabel">Parameters:</span></dt>
    839. 

  839. <dd><code>requestParam</code> - <a href="../param/index/GetIndexStateParam.html" title="class in io.milvus.param.index"><code>GetIndexStateParam</code></a></dd>
    840. 

  840. <dt><span class="returnLabel">Returns:</span></dt>
    841. 

  841. <dd>{status:result code, data:GetIndexStateResponse{status,state}}</dd>
    842. 

  842. </dl>
    843. 

  843. </li>
    844. 

  844. </ul>
    845. 

  845. <a id="getIndexBuildProgress(io.milvus.param.index.GetIndexBuildProgressParam)">
    846. 

  846. <!--   -->
    847. 

  847. </a>
    848. 

  848. <ul class="blockList">
    849. 

  849. <li class="blockList">
    850. 

  850. <h4>getIndexBuildProgress</h4>
    851. 

  851. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetIndexBuildProgressResponse&gt;&nbsp;getIndexBuildProgress&#8203;(<a href="../param/index/GetIndexBuildProgressParam.html" title="class in io.milvus.param.index">GetIndexBuildProgressParam</a>&nbsp;requestParam)</pre>
    852. 

  852. <div class="block">Shows the index building progress, such as how many rows are indexed.</div>
    853. 

  853. <dl>
    854. 

  854. <dt><span class="paramLabel">Parameters:</span></dt>
    855. 

  855. <dd><code>requestParam</code> - <a href="../param/index/GetIndexBuildProgressParam.html" title="class in io.milvus.param.index"><code>GetIndexBuildProgressParam</code></a></dd>
    856. 

  856. <dt><span class="returnLabel">Returns:</span></dt>
    857. 

  857. <dd>{status:result code, data:GetIndexBuildProgressResponse{status,indexed_rows}}</dd>
    858. 

  858. </dl>
    859. 

  859. </li>
    860. 

  860. </ul>
    861. 

  861. <a id="insert(io.milvus.param.dml.InsertParam)">
    862. 

  862. <!--   -->
    863. 

  863. </a>
    864. 

  864. <ul class="blockList">
    865. 

  865. <li class="blockList">
    866. 

  866. <h4>insert</h4>
    867. 

  867. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.MutationResult&gt;&nbsp;insert&#8203;(<a href="../param/dml/InsertParam.html" title="class in io.milvus.param.dml">InsertParam</a>&nbsp;requestParam)</pre>
    868. 

  868. <div class="block">Inserts entities into a specified collection. Note that you don't need to 
    869. 

  869.  input primary key field if auto_id is enabled.</div>
    870. 

  870. <dl>
    871. 

  871. <dt><span class="paramLabel">Parameters:</span></dt>
    872. 

  872. <dd><code>requestParam</code> - <a href="../param/dml/InsertParam.html" title="class in io.milvus.param.dml"><code>InsertParam</code></a></dd>
    873. 

  873. <dt><span class="returnLabel">Returns:</span></dt>
    874. 

  874. <dd>{status:result code, data: MutationResult{insert results}}</dd>
    875. 

  875. </dl>
    876. 

  876. </li>
    877. 

  877. </ul>
    878. 

  878. <a id="delete(io.milvus.param.dml.DeleteParam)">
    879. 

  879. <!--   -->
    880. 

  880. </a>
    881. 

  881. <ul class="blockList">
    882. 

  882. <li class="blockList">
    883. 

  883. <h4>delete</h4>
    884. 

  884. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.MutationResult&gt;&nbsp;delete&#8203;(<a href="../param/dml/DeleteParam.html" title="class in io.milvus.param.dml">DeleteParam</a>&nbsp;requestParam)</pre>
    885. 

  885. <div class="block">Deletes entity(s) based on primary key(s) filtered by boolean expression. Current release 
    886. 

  886.  of Milvus only supports expression in the format "pk_field in [1, 2, ...]"</div>
    887. 

  887. <dl>
    888. 

  888. <dt><span class="paramLabel">Parameters:</span></dt>
    889. 

  889. <dd><code>requestParam</code> - <a href="../param/dml/DeleteParam.html" title="class in io.milvus.param.dml"><code>DeleteParam</code></a></dd>
    890. 

  890. <dt><span class="returnLabel">Returns:</span></dt>
    891. 

  891. <dd>{status:result code, data: MutationResult{delete results}}</dd>
    892. 

  892. </dl>
    893. 

  893. </li>
    894. 

  894. </ul>
    895. 

  895. <a id="search(io.milvus.param.dml.SearchParam)">
    896. 

  896. <!--   -->
    897. 

  897. </a>
    898. 

  898. <ul class="blockList">
    899. 

  899. <li class="blockList">
    900. 

  900. <h4>search</h4>
    901. 

  901. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.SearchResults&gt;&nbsp;search&#8203;(<a href="../param/dml/SearchParam.html" title="class in io.milvus.param.dml">SearchParam</a>&nbsp;requestParam)</pre>
    902. 

  902. <div class="block">Conducts ANN search on a vector field. Use expression to do filtering before search.</div>
    903. 

  903. <dl>
    904. 

  904. <dt><span class="paramLabel">Parameters:</span></dt>
    905. 

  905. <dd><code>requestParam</code> - <a href="../param/dml/SearchParam.html" title="class in io.milvus.param.dml"><code>SearchParam</code></a></dd>
    906. 

  906. <dt><span class="returnLabel">Returns:</span></dt>
    907. 

  907. <dd>{status:result code, data: SearchResults{topK results}}</dd>
    908. 

  908. </dl>
    909. 

  909. </li>
    910. 

  910. </ul>
    911. 

  911. <a id="query(io.milvus.param.dml.QueryParam)">
    912. 

  912. <!--   -->
    913. 

  913. </a>
    914. 

  914. <ul class="blockList">
    915. 

  915. <li class="blockList">
    916. 

  916. <h4>query</h4>
    917. 

  917. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.QueryResults&gt;&nbsp;query&#8203;(<a href="../param/dml/QueryParam.html" title="class in io.milvus.param.dml">QueryParam</a>&nbsp;requestParam)</pre>
    918. 

  918. <div class="block">Queries entity(s) based on scalar field(s) filtered by boolean expression. 
    919. 

  919.  Note that the order of the returned entities cannot be guaranteed.</div>
    920. 

  920. <dl>
    921. 

  921. <dt><span class="paramLabel">Parameters:</span></dt>
    922. 

  922. <dd><code>requestParam</code> - <a href="../param/dml/QueryParam.html" title="class in io.milvus.param.dml"><code>QueryParam</code></a></dd>
    923. 

  923. <dt><span class="returnLabel">Returns:</span></dt>
    924. 

  924. <dd>{status:result code,data: QueryResults{filter results}}</dd>
    925. 

  925. </dl>
    926. 

  926. </li>
    927. 

  927. </ul>
    928. 

  928. <a id="calcDistance(io.milvus.param.dml.CalcDistanceParam)">
    929. 

  929. <!--   -->
    930. 

  930. </a>
    931. 

  931. <ul class="blockList">
    932. 

  932. <li class="blockList">
    933. 

  933. <h4>calcDistance</h4>
    934. 

  934. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.CalcDistanceResults&gt;&nbsp;calcDistance&#8203;(<a href="../param/dml/CalcDistanceParam.html" title="class in io.milvus.param.dml">CalcDistanceParam</a>&nbsp;requestParam)</pre>
    935. 

  935. <div class="block">Calculates the distance between the specified vectors.</div>
    936. 

  936. <dl>
    937. 

  937. <dt><span class="paramLabel">Parameters:</span></dt>
    938. 

  938. <dd><code>requestParam</code> - <a href="../param/dml/CalcDistanceParam.html" title="class in io.milvus.param.dml"><code>CalcDistanceParam</code></a></dd>
    939. 

  939. <dt><span class="returnLabel">Returns:</span></dt>
    940. 

  940. <dd>{status:result code, data: CalcDistanceResults{distances}}</dd>
    941. 

  941. </dl>
    942. 

  942. </li>
    943. 

  943. </ul>
    944. 

  944. <a id="getMetrics(io.milvus.param.control.GetMetricsParam)">
    945. 

  945. <!--   -->
    946. 

  946. </a>
    947. 

  947. <ul class="blockList">
    948. 

  948. <li class="blockList">
    949. 

  949. <h4>getMetrics</h4>
    950. 

  950. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetMetricsResponse&gt;&nbsp;getMetrics&#8203;(<a href="../param/control/GetMetricsParam.html" title="class in io.milvus.param.control">GetMetricsParam</a>&nbsp;requestParam)</pre>
    951. 

  951. <div class="block">Gets the runtime metrics information of Milvus, returns the result in .json format.</div>
    952. 

  952. <dl>
    953. 

  953. <dt><span class="paramLabel">Parameters:</span></dt>
    954. 

  954. <dd><code>requestParam</code> - <a href="../param/control/GetMetricsParam.html" title="class in io.milvus.param.control"><code>GetMetricsParam</code></a></dd>
    955. 

  955. <dt><span class="returnLabel">Returns:</span></dt>
    956. 

  956. <dd>{status:result code, data:GetMetricsResponse{status,metrics}}</dd>
    957. 

  957. </dl>
    958. 

  958. </li>
    959. 

  959. </ul>
    960. 

  960. <a id="getFlushState(io.milvus.param.control.GetFlushStateParam)">
    961. 

  961. <!--   -->
    962. 

  962. </a>
    963. 

  963. <ul class="blockList">
    964. 

  964. <li class="blockList">
    965. 

  965. <h4>getFlushState</h4>
    966. 

  966. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetFlushStateResponse&gt;&nbsp;getFlushState&#8203;(<a href="../param/control/GetFlushStateParam.html" title="class in io.milvus.param.control">GetFlushStateParam</a>&nbsp;requestParam)</pre>
    967. 

  967. <div class="block">Get flush state of specified segments.</div>
    968. 

  968. <dl>
    969. 

  969. <dt><span class="paramLabel">Parameters:</span></dt>
    970. 

  970. <dd><code>requestParam</code> - <a href="../param/control/GetFlushStateParam.html" title="class in io.milvus.param.control"><code>GetFlushStateParam</code></a></dd>
    971. 

  971. <dt><span class="returnLabel">Returns:</span></dt>
    972. 

  972. <dd>{status:result code, data:GetMetricsResponse{status,metrics}}</dd>
    973. 

  973. </dl>
    974. 

  974. </li>
    975. 

  975. </ul>
    976. 

  976. <a id="getPersistentSegmentInfo(io.milvus.param.control.GetPersistentSegmentInfoParam)">
    977. 

  977. <!--   -->
    978. 

  978. </a>
    979. 

  979. <ul class="blockList">
    980. 

  980. <li class="blockList">
    981. 

  981. <h4>getPersistentSegmentInfo</h4>
    982. 

  982. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetPersistentSegmentInfoResponse&gt;&nbsp;getPersistentSegmentInfo&#8203;(<a href="../param/control/GetPersistentSegmentInfoParam.html" title="class in io.milvus.param.control">GetPersistentSegmentInfoParam</a>&nbsp;requestParam)</pre>
    983. 

  983. <div class="block">Gets the information of persistent segments from data node, including row count,
    984. 

  984.  persistence state(growing or flushed), etc.</div>
    985. 

  985. <dl>
    986. 

  986. <dt><span class="paramLabel">Parameters:</span></dt>
    987. 

  987. <dd><code>requestParam</code> - <a href="../param/control/GetPersistentSegmentInfoParam.html" title="class in io.milvus.param.control"><code>GetPersistentSegmentInfoParam</code></a></dd>
    988. 

  988. <dt><span class="returnLabel">Returns:</span></dt>
    989. 

  989. <dd>{status:result code, data:GetPersistentSegmentInfoResponse{status,info}}</dd>
    990. 

  990. </dl>
    991. 

  991. </li>
    992. 

  992. </ul>
    993. 

  993. <a id="getQuerySegmentInfo(io.milvus.param.control.GetQuerySegmentInfoParam)">
    994. 

  994. <!--   -->
    995. 

  995. </a>
    996. 

  996. <ul class="blockList">
    997. 

  997. <li class="blockList">
    998. 

  998. <h4>getQuerySegmentInfo</h4>
    999. 

  999. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetQuerySegmentInfoResponse&gt;&nbsp;getQuerySegmentInfo&#8203;(<a href="../param/control/GetQuerySegmentInfoParam.html" title="class in io.milvus.param.control">GetQuerySegmentInfoParam</a>&nbsp;requestParam)</pre>
    1000. 

  1000. <div class="block">Gets the query information of segments in a collection from query node, including row count,
    1001. 

  1001.  memory usage size, index name, etc.</div>
    1002. 

  1002. <dl>
    1003. 

  1003. <dt><span class="paramLabel">Parameters:</span></dt>
    1004. 

  1004. <dd><code>requestParam</code> - <a href="../param/control/GetQuerySegmentInfoParam.html" title="class in io.milvus.param.control"><code>GetQuerySegmentInfoParam</code></a></dd>
    1005. 

  1005. <dt><span class="returnLabel">Returns:</span></dt>
    1006. 

  1006. <dd>{status:result code, data:GetQuerySegmentInfoResponse{status,info}}</dd>
    1007. 

  1007. </dl>
    1008. 

  1008. </li>
    1009. 

  1009. </ul>
    1010. 

  1010. <a id="loadBalance(io.milvus.param.control.LoadBalanceParam)">
    1011. 

  1011. <!--   -->
    1012. 

  1012. </a>
    1013. 

  1013. <ul class="blockList">
    1014. 

  1014. <li class="blockList">
    1015. 

  1015. <h4>loadBalance</h4>
    1016. 

  1016. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;loadBalance&#8203;(<a href="../param/control/LoadBalanceParam.html" title="class in io.milvus.param.control">LoadBalanceParam</a>&nbsp;requestParam)</pre>
    1017. 

  1017. <div class="block">Moves segment from a query node to another to keep the load balanced.</div>
    1018. 

  1018. <dl>
    1019. 

  1019. <dt><span class="paramLabel">Parameters:</span></dt>
    1020. 

  1020. <dd><code>requestParam</code> - <a href="../param/control/LoadBalanceParam.html" title="class in io.milvus.param.control"><code>LoadBalanceParam</code></a></dd>
    1021. 

  1021. <dt><span class="returnLabel">Returns:</span></dt>
    1022. 

  1022. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
    1023. 

  1023. </dl>
    1024. 

  1024. </li>
    1025. 

  1025. </ul>
    1026. 

  1026. <a id="getCompactionState(io.milvus.param.control.GetCompactionStateParam)">
    1027. 

  1027. <!--   -->
    1028. 

  1028. </a>
    1029. 

  1029. <ul class="blockList">
    1030. 

  1030. <li class="blockList">
    1031. 

  1031. <h4>getCompactionState</h4>
    1032. 

  1032. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetCompactionStateResponse&gt;&nbsp;getCompactionState&#8203;(<a href="../param/control/GetCompactionStateParam.html" title="class in io.milvus.param.control">GetCompactionStateParam</a>&nbsp;requestParam)</pre>
    1033. 

  1033. <div class="block">Gets the compaction state by id.</div>
    1034. 

  1034. <dl>
    1035. 

  1035. <dt><span class="paramLabel">Parameters:</span></dt>
    1036. 

  1036. <dd><code>requestParam</code> - <a href="../param/control/GetCompactionStateParam.html" title="class in io.milvus.param.control"><code>GetCompactionStateParam</code></a></dd>
    1037. 

  1037. <dt><span class="returnLabel">Returns:</span></dt>
    1038. 

  1038. <dd>{status:result code, data:GetCompactionStateResponse{status,info}}</dd>
    1039. 

  1039. </dl>
    1040. 

  1040. </li>
    1041. 

  1041. </ul>
    1042. 

  1042. <a id="manualCompaction(io.milvus.param.control.ManualCompactionParam)">
    1043. 

  1043. <!--   -->
    1044. 

  1044. </a>
    1045. 

  1045. <ul class="blockList">
    1046. 

  1046. <li class="blockList">
    1047. 

  1047. <h4>manualCompaction</h4>
    1048. 

  1048. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.ManualCompactionResponse&gt;&nbsp;manualCompaction&#8203;(<a href="../param/control/ManualCompactionParam.html" title="class in io.milvus.param.control">ManualCompactionParam</a>&nbsp;requestParam)</pre>
    1049. 

  1049. <div class="block">Performs a manual compaction.</div>
    1050. 

  1050. <dl>
    1051. 

  1051. <dt><span class="paramLabel">Parameters:</span></dt>
    1052. 

  1052. <dd><code>requestParam</code> - <a href="../param/control/ManualCompactionParam.html" title="class in io.milvus.param.control"><code>ManualCompactionParam</code></a></dd>
    1053. 

  1053. <dt><span class="returnLabel">Returns:</span></dt>
    1054. 

  1054. <dd>{status:result code, data:ManualCompactionResponse{status,info}}</dd>
    1055. 

  1055. </dl>
    1056. 

  1056. </li>
    1057. 

  1057. </ul>
    1058. 

  1058. <a id="getCompactionStateWithPlans(io.milvus.param.control.GetCompactionPlansParam)">
    1059. 

  1059. <!--   -->
    1060. 

  1060. </a>
    1061. 

  1061. <ul class="blockListLast">
    1062. 

  1062. <li class="blockList">
    1063. 

  1063. <h4>getCompactionStateWithPlans</h4>
    1064. 

  1064. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetCompactionPlansResponse&gt;&nbsp;getCompactionStateWithPlans&#8203;(<a href="../param/control/GetCompactionPlansParam.html" title="class in io.milvus.param.control">GetCompactionPlansParam</a>&nbsp;requestParam)</pre>
    1065. 

  1065. <div class="block">Gets compaction state with its plan.</div>
    1066. 

  1066. <dl>
    1067. 

  1067. <dt><span class="paramLabel">Parameters:</span></dt>
    1068. 

  1068. <dd><code>requestParam</code> - <a href="../param/control/GetCompactionPlansParam.html" title="class in io.milvus.param.control"><code>GetCompactionPlansParam</code></a></dd>
    1069. 

  1069. <dt><span class="returnLabel">Returns:</span></dt>
    1070. 

  1070. <dd>{status:result code, data:GetCompactionPlansResponse{status,info}}</dd>
    1071. 

  1071. </dl>
    1072. 

  1072. </li>
    1073. 

  1073. </ul>
    1074. 

  1074. </li>
    1075. 

  1075. </ul>
    1076. 

  1076. </section>
    1077. 

  1077. </li>
    1078. 

  1078. </ul>
    1079. 

  1079. </div>
    1080. 

  1080. </div>
    1081. 

  1081. </main>
    1082. 

  1082. <!-- ========= END OF CLASS DATA ========= -->
    1083. 

  1083. <footer role="contentinfo">
    1084. 

  1084. <nav role="navigation">
    1085. 

  1085. <!-- ======= START OF BOTTOM NAVBAR ====== -->
    1086. 

  1086. <div class="bottomNav"><a id="navbar.bottom">
    1087. 

  1087. <!--   -->
    1088. 

  1088. </a>
    1089. 

  1089. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
    1090. 

  1090. <a id="navbar.bottom.firstrow">
    1091. 

  1091. <!--   -->
    1092. 

  1092. </a>
    1093. 

  1093. <ul class="navList" title="Navigation">
    1094. 

  1094. <li><a href="../../../index.html">Overview</a></li>
    1095. 

  1095. <li><a href="package-summary.html">Package</a></li>
    1096. 

  1096. <li class="navBarCell1Rev">Class</li>
    1097. 

  1097. <li><a href="package-tree.html">Tree</a></li>
    1098. 

  1098. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
    1099. 

  1099. <li><a href="../../../index-files/index-1.html">Index</a></li>
    1100. 

  1100. <li><a href="../../../help-doc.html">Help</a></li>
    1101. 

  1101. </ul>
    1102. 

  1102. </div>
    1103. 

  1103. <div class="subNav">
    1104. 

  1104. <ul class="navList" id="allclasses_navbar_bottom">
    1105. 

  1105. <li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
    1106. 

  1106. </ul>
    1107. 

  1107. <div>
    1108. 

  1108. <script type="text/javascript"><!--
    1109. 

  1109.   allClassesLink = document.getElementById("allclasses_navbar_bottom");
    1110. 

  1110.   if(window==top) {
    1111. 

  1111.     allClassesLink.style.display = "block";
    1112. 

  1112.   }
    1113. 

  1113.   else {
    1114. 

  1114.     allClassesLink.style.display = "none";
    1115. 

  1115.   }
    1116. 

  1116.   //-->
    1117. 

  1117. </script>
    1118. 

  1118. <noscript>
    1119. 

  1119. <div>JavaScript is disabled on your browser.</div>
    1120. 

  1120. </noscript>
    1121. 

  1121. </div>
    1122. 

  1122. <div>
    1123. 

  1123. <ul class="subNavList">
    1124. 

  1124. <li>Summary:&nbsp;</li>
    1125. 

  1125. <li>Nested&nbsp;|&nbsp;</li>
    1126. 

  1126. <li>Field&nbsp;|&nbsp;</li>
    1127. 

  1127. <li>Constr&nbsp;|&nbsp;</li>
    1128. 

  1128. <li><a href="#method.summary">Method</a></li>
    1129. 

  1129. </ul>
    1130. 

  1130. <ul class="subNavList">
    1131. 

  1131. <li>Detail:&nbsp;</li>
    1132. 

  1132. <li>Field&nbsp;|&nbsp;</li>
    1133. 

  1133. <li>Constr&nbsp;|&nbsp;</li>
    1134. 

  1134. <li><a href="#method.detail">Method</a></li>
    1135. 

  1135. </ul>
    1136. 

  1136. </div>
    1137. 

  1137. <a id="skip.navbar.bottom">
    1138. 

  1138. <!--   -->
    1139. 

  1139. </a></div>
    1140. 

  1140. <!-- ======== END OF BOTTOM NAVBAR ======= -->
    1141. 

  1141. </nav>
    1142. 

  1142. </footer>
    1143. 

  1143. </body>
    1144. 

  1144. </html>
    1145.