AbstractMilvusGrpcClient.html 196 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676
  1. <!DOCTYPE HTML>
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (11.0.18) on Fri Apr 19 17:14:02 CST 2024 -->
  6. <title>AbstractMilvusGrpcClient</title>
  7. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  8. <meta name="dc.created" content="2024-04-19">
  9. <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
  10. <link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.min.css" title="Style">
  11. <link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style">
  12. <script type="text/javascript" src="../../../script.js"></script>
  13. <script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
  14. <script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
  15. <!--[if IE]>
  16. <script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
  17. <![endif]-->
  18. <script type="text/javascript" src="../../../jquery/jquery-3.6.0.min.js"></script>
  19. <script type="text/javascript" src="../../../jquery/jquery-ui.min.js"></script>
  20. </head>
  21. <body>
  22. <script type="text/javascript"><!--
  23. try {
  24. if (location.href.indexOf('is-external=true') == -1) {
  25. parent.document.title="AbstractMilvusGrpcClient";
  26. }
  27. }
  28. catch(err) {
  29. }
  30. //-->
  31. var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":42,"i38":42,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10,"i57":10,"i58":10,"i59":10,"i60":10,"i61":10,"i62":10,"i63":10,"i64":10,"i65":10,"i66":10,"i67":10,"i68":10,"i69":10,"i70":10,"i71":10,"i72":10,"i73":10,"i74":10,"i75":10,"i76":10,"i77":10,"i78":10,"i79":10,"i80":10,"i81":10,"i82":10,"i83":10,"i84":10,"i85":10,"i86":10,"i87":10,"i88":10};
  32. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
  33. var altColor = "altColor";
  34. var rowColor = "rowColor";
  35. var tableTab = "tableTab";
  36. var activeTableTab = "activeTableTab";
  37. var pathtoroot = "../../../";
  38. var useModuleDirectories = true;
  39. loadScripts(document, 'script');</script>
  40. <noscript>
  41. <div>JavaScript is disabled on your browser.</div>
  42. </noscript>
  43. <header role="banner">
  44. <nav role="navigation">
  45. <div class="fixedNav">
  46. <!-- ========= START OF TOP NAVBAR ======= -->
  47. <div class="topNav"><a id="navbar.top">
  48. <!-- -->
  49. </a>
  50. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  51. <a id="navbar.top.firstrow">
  52. <!-- -->
  53. </a>
  54. <ul class="navList" title="Navigation">
  55. <li><a href="../../../index.html">Overview</a></li>
  56. <li><a href="package-summary.html">Package</a></li>
  57. <li class="navBarCell1Rev">Class</li>
  58. <li><a href="package-tree.html">Tree</a></li>
  59. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  60. <li><a href="../../../index-files/index-1.html">Index</a></li>
  61. <li><a href="../../../help-doc.html">Help</a></li>
  62. </ul>
  63. </div>
  64. <div class="subNav">
  65. <ul class="navList" id="allclasses_navbar_top">
  66. <li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
  67. </ul>
  68. <ul class="navListSearch">
  69. <li><label for="search">SEARCH:</label>
  70. <input type="text" id="search" value="search" disabled="disabled">
  71. <input type="reset" id="reset" value="reset" disabled="disabled">
  72. </li>
  73. </ul>
  74. <div>
  75. <script type="text/javascript"><!--
  76. allClassesLink = document.getElementById("allclasses_navbar_top");
  77. if(window==top) {
  78. allClassesLink.style.display = "block";
  79. }
  80. else {
  81. allClassesLink.style.display = "none";
  82. }
  83. //-->
  84. </script>
  85. <noscript>
  86. <div>JavaScript is disabled on your browser.</div>
  87. </noscript>
  88. </div>
  89. <div>
  90. <ul class="subNavList">
  91. <li>Summary:&nbsp;</li>
  92. <li>Nested&nbsp;|&nbsp;</li>
  93. <li>Field&nbsp;|&nbsp;</li>
  94. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  95. <li><a href="#method.summary">Method</a></li>
  96. </ul>
  97. <ul class="subNavList">
  98. <li>Detail:&nbsp;</li>
  99. <li>Field&nbsp;|&nbsp;</li>
  100. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  101. <li><a href="#method.detail">Method</a></li>
  102. </ul>
  103. </div>
  104. <a id="skip.navbar.top">
  105. <!-- -->
  106. </a></div>
  107. <!-- ========= END OF TOP NAVBAR ========= -->
  108. </div>
  109. <div class="navPadding">&nbsp;</div>
  110. <script type="text/javascript"><!--
  111. $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
  112. //-->
  113. </script>
  114. </nav>
  115. </header>
  116. <!-- ======== START OF CLASS DATA ======== -->
  117. <main role="main">
  118. <div class="header">
  119. <div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">io.milvus.client</a></div>
  120. <h2 title="Class AbstractMilvusGrpcClient" class="title">Class AbstractMilvusGrpcClient</h2>
  121. </div>
  122. <div class="contentContainer">
  123. <ul class="inheritance">
  124. <li>java.lang.Object</li>
  125. <li>
  126. <ul class="inheritance">
  127. <li>io.milvus.client.AbstractMilvusGrpcClient</li>
  128. </ul>
  129. </li>
  130. </ul>
  131. <div class="description">
  132. <ul class="blockList">
  133. <li class="blockList">
  134. <dl>
  135. <dt>All Implemented Interfaces:</dt>
  136. <dd><code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  137. </dl>
  138. <dl>
  139. <dt>Direct Known Subclasses:</dt>
  140. <dd><code><a href="MilvusServiceClient.html" title="class in io.milvus.client">MilvusServiceClient</a></code></dd>
  141. </dl>
  142. <hr>
  143. <pre>public abstract class <span class="typeNameLabel">AbstractMilvusGrpcClient</span>
  144. extends java.lang.Object
  145. implements <a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></pre>
  146. </li>
  147. </ul>
  148. </div>
  149. <div class="summary">
  150. <ul class="blockList">
  151. <li class="blockList">
  152. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  153. <section>
  154. <ul class="blockList">
  155. <li class="blockList"><a id="constructor.summary">
  156. <!-- -->
  157. </a>
  158. <h3>Constructor Summary</h3>
  159. <table class="memberSummary">
  160. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  161. <tr>
  162. <th class="colFirst" scope="col">Constructor</th>
  163. <th class="colLast" scope="col">Description</th>
  164. </tr>
  165. <tr class="altColor">
  166. <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">AbstractMilvusGrpcClient</a></span>()</code></th>
  167. <td class="colLast">&nbsp;</td>
  168. </tr>
  169. </table>
  170. </li>
  171. </ul>
  172. </section>
  173. <!-- ========== METHOD SUMMARY =========== -->
  174. <section>
  175. <ul class="blockList">
  176. <li class="blockList"><a id="method.summary">
  177. <!-- -->
  178. </a>
  179. <h3>Method Summary</h3>
  180. <table class="memberSummary">
  181. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  182. <tr>
  183. <th class="colFirst" scope="col">Modifier and Type</th>
  184. <th class="colSecond" scope="col">Method</th>
  185. <th class="colLast" scope="col">Description</th>
  186. </tr>
  187. <tr id="i0" class="altColor">
  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. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addUserToRole(io.milvus.param.role.AddUserToRoleParam)">addUserToRole</a></span>&#8203;(<a href="../param/role/AddUserToRoleParam.html" title="class in io.milvus.param.role">AddUserToRoleParam</a>&nbsp;requestParam)</code></th>
  190. <td class="colLast">
  191. <div class="block">The user will get permissions that the role are allowed to perform operations.</div>
  192. </td>
  193. </tr>
  194. <tr id="i1" class="rowColor">
  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. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#alterAlias(io.milvus.param.alias.AlterAliasParam)">alterAlias</a></span>&#8203;(@NonNull <a href="../param/alias/AlterAliasParam.html" title="class in io.milvus.param.alias">AlterAliasParam</a>&nbsp;requestParam)</code></th>
  197. <td class="colLast">
  198. <div class="block">Alters alias from a collection to another.</div>
  199. </td>
  200. </tr>
  201. <tr id="i2" class="altColor">
  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. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#alterCollection(io.milvus.param.collection.AlterCollectionParam)">alterCollection</a></span>&#8203;(<a href="../param/collection/AlterCollectionParam.html" title="class in io.milvus.param.collection">AlterCollectionParam</a>&nbsp;requestParam)</code></th>
  204. <td class="colLast">
  205. <div class="block">Alter collection with key-value properties.</div>
  206. </td>
  207. </tr>
  208. <tr id="i3" class="rowColor">
  209. <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>
  210. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#alterIndex(io.milvus.param.index.AlterIndexParam)">alterIndex</a></span>&#8203;(<a href="../param/index/AlterIndexParam.html" title="class in io.milvus.param.index">AlterIndexParam</a>&nbsp;requestParam)</code></th>
  211. <td class="colLast">
  212. <div class="block">Alter index with key value properties.</div>
  213. </td>
  214. </tr>
  215. <tr id="i4" class="altColor">
  216. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.ImportResponse&gt;</code></td>
  217. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#bulkInsert(io.milvus.param.bulkinsert.BulkInsertParam)">bulkInsert</a></span>&#8203;(<a href="../param/bulkinsert/BulkInsertParam.html" title="class in io.milvus.param.bulkinsert">BulkInsertParam</a>&nbsp;requestParam)</code></th>
  218. <td class="colLast">
  219. <div class="block">Import data from external files, currently support JSON format</div>
  220. </td>
  221. </tr>
  222. <tr id="i5" class="rowColor">
  223. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.CheckHealthResponse&gt;</code></td>
  224. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkHealth()">checkHealth</a></span>()</code></th>
  225. <td class="colLast">
  226. <div class="block">Check server health</div>
  227. </td>
  228. </tr>
  229. <tr id="i6" class="altColor">
  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. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createAlias(io.milvus.param.alias.CreateAliasParam)">createAlias</a></span>&#8203;(@NonNull <a href="../param/alias/CreateAliasParam.html" title="class in io.milvus.param.alias">CreateAliasParam</a>&nbsp;requestParam)</code></th>
  232. <td class="colLast">
  233. <div class="block">Creates an alias for a collection.</div>
  234. </td>
  235. </tr>
  236. <tr id="i7" class="rowColor">
  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. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createCollection(io.milvus.param.collection.CreateCollectionParam)">createCollection</a></span>&#8203;(@NonNull <a href="../param/collection/CreateCollectionParam.html" title="class in io.milvus.param.collection">CreateCollectionParam</a>&nbsp;requestParam)</code></th>
  239. <td class="colLast">
  240. <div class="block">Creates a collection in Milvus.</div>
  241. </td>
  242. </tr>
  243. <tr id="i8" class="altColor">
  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. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createCollection(io.milvus.param.highlevel.collection.CreateSimpleCollectionParam)">createCollection</a></span>&#8203;(<a href="../param/highlevel/collection/CreateSimpleCollectionParam.html" title="class in io.milvus.param.highlevel.collection">CreateSimpleCollectionParam</a>&nbsp;requestParam)</code></th>
  246. <td class="colLast">
  247. <div class="block">Creates a collection in Milvus.</div>
  248. </td>
  249. </tr>
  250. <tr id="i9" class="rowColor">
  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. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createCredential(io.milvus.param.credential.CreateCredentialParam)">createCredential</a></span>&#8203;(<a href="../param/credential/CreateCredentialParam.html" title="class in io.milvus.param.credential">CreateCredentialParam</a>&nbsp;requestParam)</code></th>
  253. <td class="colLast">
  254. <div class="block">Create credential using the given user and password.</div>
  255. </td>
  256. </tr>
  257. <tr id="i10" class="altColor">
  258. <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>
  259. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createDatabase(io.milvus.param.collection.CreateDatabaseParam)">createDatabase</a></span>&#8203;(<a href="../param/collection/CreateDatabaseParam.html" title="class in io.milvus.param.collection">CreateDatabaseParam</a>&nbsp;requestParam)</code></th>
  260. <td class="colLast">
  261. <div class="block">Creates a database in Milvus.</div>
  262. </td>
  263. </tr>
  264. <tr id="i11" class="rowColor">
  265. <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>
  266. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createIndex(io.milvus.param.index.CreateIndexParam)">createIndex</a></span>&#8203;(@NonNull <a href="../param/index/CreateIndexParam.html" title="class in io.milvus.param.index">CreateIndexParam</a>&nbsp;requestParam)</code></th>
  267. <td class="colLast">
  268. <div class="block">Creates an index on a vector field in the specified collection.</div>
  269. </td>
  270. </tr>
  271. <tr id="i12" class="altColor">
  272. <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>
  273. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createPartition(io.milvus.param.partition.CreatePartitionParam)">createPartition</a></span>&#8203;(@NonNull <a href="../param/partition/CreatePartitionParam.html" title="class in io.milvus.param.partition">CreatePartitionParam</a>&nbsp;requestParam)</code></th>
  274. <td class="colLast">
  275. <div class="block">Creates a partition in the specified collection.</div>
  276. </td>
  277. </tr>
  278. <tr id="i13" class="rowColor">
  279. <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>
  280. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createResourceGroup(io.milvus.param.resourcegroup.CreateResourceGroupParam)">createResourceGroup</a></span>&#8203;(<a href="../param/resourcegroup/CreateResourceGroupParam.html" title="class in io.milvus.param.resourcegroup">CreateResourceGroupParam</a>&nbsp;requestParam)</code></th>
  281. <td class="colLast">
  282. <div class="block">Create a resource group.</div>
  283. </td>
  284. </tr>
  285. <tr id="i14" class="altColor">
  286. <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>
  287. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createRole(io.milvus.param.role.CreateRoleParam)">createRole</a></span>&#8203;(<a href="../param/role/CreateRoleParam.html" title="class in io.milvus.param.role">CreateRoleParam</a>&nbsp;requestParam)</code></th>
  288. <td class="colLast">
  289. <div class="block">It will success if the role isn't existed, otherwise fail.</div>
  290. </td>
  291. </tr>
  292. <tr id="i15" class="rowColor">
  293. <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>
  294. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#delete(io.milvus.param.dml.DeleteParam)">delete</a></span>&#8203;(@NonNull <a href="../param/dml/DeleteParam.html" title="class in io.milvus.param.dml">DeleteParam</a>&nbsp;requestParam)</code></th>
  295. <td class="colLast">
  296. <div class="block">Deletes entity(s) based on primary key(s) filtered by boolean expression.</div>
  297. </td>
  298. </tr>
  299. <tr id="i16" class="altColor">
  300. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/highlevel/dml/response/DeleteResponse.html" title="class in io.milvus.param.highlevel.dml.response">DeleteResponse</a>&gt;</code></td>
  301. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#delete(io.milvus.param.highlevel.dml.DeleteIdsParam)">delete</a></span>&#8203;(<a href="../param/highlevel/dml/DeleteIdsParam.html" title="class in io.milvus.param.highlevel.dml">DeleteIdsParam</a>&nbsp;requestParam)</code></th>
  302. <td class="colLast">
  303. <div class="block">Deletes entity(s) based on the value of primary key.</div>
  304. </td>
  305. </tr>
  306. <tr id="i17" class="rowColor">
  307. <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>
  308. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deleteCredential(io.milvus.param.credential.DeleteCredentialParam)">deleteCredential</a></span>&#8203;(<a href="../param/credential/DeleteCredentialParam.html" title="class in io.milvus.param.credential">DeleteCredentialParam</a>&nbsp;requestParam)</code></th>
  309. <td class="colLast">
  310. <div class="block">Delete credential corresponding to the user.</div>
  311. </td>
  312. </tr>
  313. <tr id="i18" class="altColor">
  314. <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>
  315. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#describeCollection(io.milvus.param.collection.DescribeCollectionParam)">describeCollection</a></span>&#8203;(@NonNull <a href="../param/collection/DescribeCollectionParam.html" title="class in io.milvus.param.collection">DescribeCollectionParam</a>&nbsp;requestParam)</code></th>
  316. <td class="colLast">
  317. <div class="block">Shows the details of a collection, e.g.</div>
  318. </td>
  319. </tr>
  320. <tr id="i19" class="rowColor">
  321. <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>
  322. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#describeIndex(io.milvus.param.index.DescribeIndexParam)">describeIndex</a></span>&#8203;(@NonNull <a href="../param/index/DescribeIndexParam.html" title="class in io.milvus.param.index">DescribeIndexParam</a>&nbsp;requestParam)</code></th>
  323. <td class="colLast">
  324. <div class="block">Shows the information of the specified index.</div>
  325. </td>
  326. </tr>
  327. <tr id="i20" class="altColor">
  328. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.DescribeResourceGroupResponse&gt;</code></td>
  329. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#describeResourceGroup(io.milvus.param.resourcegroup.DescribeResourceGroupParam)">describeResourceGroup</a></span>&#8203;(<a href="../param/resourcegroup/DescribeResourceGroupParam.html" title="class in io.milvus.param.resourcegroup">DescribeResourceGroupParam</a>&nbsp;requestParam)</code></th>
  330. <td class="colLast">
  331. <div class="block">Describe a resource group.</div>
  332. </td>
  333. </tr>
  334. <tr id="i21" class="rowColor">
  335. <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>
  336. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropAlias(io.milvus.param.alias.DropAliasParam)">dropAlias</a></span>&#8203;(@NonNull <a href="../param/alias/DropAliasParam.html" title="class in io.milvus.param.alias">DropAliasParam</a>&nbsp;requestParam)</code></th>
  337. <td class="colLast">
  338. <div class="block">Drops an alias for the specified collection.</div>
  339. </td>
  340. </tr>
  341. <tr id="i22" class="altColor">
  342. <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>
  343. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropCollection(io.milvus.param.collection.DropCollectionParam)">dropCollection</a></span>&#8203;(@NonNull <a href="../param/collection/DropCollectionParam.html" title="class in io.milvus.param.collection">DropCollectionParam</a>&nbsp;requestParam)</code></th>
  344. <td class="colLast">
  345. <div class="block">Drops a collection.</div>
  346. </td>
  347. </tr>
  348. <tr id="i23" class="rowColor">
  349. <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>
  350. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropDatabase(io.milvus.param.collection.DropDatabaseParam)">dropDatabase</a></span>&#8203;(<a href="../param/collection/DropDatabaseParam.html" title="class in io.milvus.param.collection">DropDatabaseParam</a>&nbsp;requestParam)</code></th>
  351. <td class="colLast">
  352. <div class="block">Drops a database.</div>
  353. </td>
  354. </tr>
  355. <tr id="i24" class="altColor">
  356. <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>
  357. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropIndex(io.milvus.param.index.DropIndexParam)">dropIndex</a></span>&#8203;(@NonNull <a href="../param/index/DropIndexParam.html" title="class in io.milvus.param.index">DropIndexParam</a>&nbsp;requestParam)</code></th>
  358. <td class="colLast">
  359. <div class="block">Drops the index on a vector field in the specified collection.</div>
  360. </td>
  361. </tr>
  362. <tr id="i25" class="rowColor">
  363. <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>
  364. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropPartition(io.milvus.param.partition.DropPartitionParam)">dropPartition</a></span>&#8203;(@NonNull <a href="../param/partition/DropPartitionParam.html" title="class in io.milvus.param.partition">DropPartitionParam</a>&nbsp;requestParam)</code></th>
  365. <td class="colLast">
  366. <div class="block">Drops a partition.</div>
  367. </td>
  368. </tr>
  369. <tr id="i26" class="altColor">
  370. <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>
  371. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropResourceGroup(io.milvus.param.resourcegroup.DropResourceGroupParam)">dropResourceGroup</a></span>&#8203;(<a href="../param/resourcegroup/DropResourceGroupParam.html" title="class in io.milvus.param.resourcegroup">DropResourceGroupParam</a>&nbsp;requestParam)</code></th>
  372. <td class="colLast">
  373. <div class="block">Drop a resource group.</div>
  374. </td>
  375. </tr>
  376. <tr id="i27" class="rowColor">
  377. <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>
  378. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropRole(io.milvus.param.role.DropRoleParam)">dropRole</a></span>&#8203;(<a href="../param/role/DropRoleParam.html" title="class in io.milvus.param.role">DropRoleParam</a>&nbsp;requestParam)</code></th>
  379. <td class="colLast">
  380. <div class="block">It will success if the role is existed, otherwise fail.</div>
  381. </td>
  382. </tr>
  383. <tr id="i28" class="altColor">
  384. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.FlushResponse&gt;</code></td>
  385. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#flush(io.milvus.param.collection.FlushParam)">flush</a></span>&#8203;(@NonNull <a href="../param/collection/FlushParam.html" title="class in io.milvus.param.collection">FlushParam</a>&nbsp;requestParam)</code></th>
  386. <td class="colLast">
  387. <div class="block">Flush insert buffer into storage.</div>
  388. </td>
  389. </tr>
  390. <tr id="i29" class="rowColor">
  391. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.FlushAllResponse&gt;</code></td>
  392. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#flushAll(boolean,long,long)">flushAll</a></span>&#8203;(boolean&nbsp;syncFlushAll,
  393. long&nbsp;syncFlushAllWaitingInterval,
  394. long&nbsp;syncFlushAllTimeout)</code></th>
  395. <td class="colLast">
  396. <div class="block">Flush all collections.</div>
  397. </td>
  398. </tr>
  399. <tr id="i30" class="altColor">
  400. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/highlevel/dml/response/GetResponse.html" title="class in io.milvus.param.highlevel.dml.response">GetResponse</a>&gt;</code></td>
  401. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#get(io.milvus.param.highlevel.dml.GetIdsParam)">get</a></span>&#8203;(<a href="../param/highlevel/dml/GetIdsParam.html" title="class in io.milvus.param.highlevel.dml">GetIdsParam</a>&nbsp;requestParam)</code></th>
  402. <td class="colLast">
  403. <div class="block">Get entity(s) based on the value of primary key.</div>
  404. </td>
  405. </tr>
  406. <tr id="i31" class="rowColor">
  407. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetImportStateResponse&gt;</code></td>
  408. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBulkInsertState(io.milvus.param.bulkinsert.GetBulkInsertStateParam)">getBulkInsertState</a></span>&#8203;(<a href="../param/bulkinsert/GetBulkInsertStateParam.html" title="class in io.milvus.param.bulkinsert">GetBulkInsertStateParam</a>&nbsp;requestParam)</code></th>
  409. <td class="colLast">
  410. <div class="block">Get state of bulk insert task</div>
  411. </td>
  412. </tr>
  413. <tr id="i32" class="altColor">
  414. <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>
  415. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCollectionStatistics(io.milvus.param.collection.GetCollectionStatisticsParam)">getCollectionStatistics</a></span>&#8203;(@NonNull <a href="../param/collection/GetCollectionStatisticsParam.html" title="class in io.milvus.param.collection">GetCollectionStatisticsParam</a>&nbsp;requestParam)</code></th>
  416. <td class="colLast">
  417. <div class="block">Shows the statistics information of a collection.</div>
  418. </td>
  419. </tr>
  420. <tr id="i33" class="rowColor">
  421. <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>
  422. <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>
  423. <td class="colLast">
  424. <div class="block">Gets the compaction state by id.</div>
  425. </td>
  426. </tr>
  427. <tr id="i34" class="altColor">
  428. <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>
  429. <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>
  430. <td class="colLast">
  431. <div class="block">Gets compaction state with its plan.</div>
  432. </td>
  433. </tr>
  434. <tr id="i35" class="rowColor">
  435. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetFlushAllStateResponse&gt;</code></td>
  436. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFlushAllState(io.milvus.param.control.GetFlushAllStateParam)">getFlushAllState</a></span>&#8203;(<a href="../param/control/GetFlushAllStateParam.html" title="class in io.milvus.param.control">GetFlushAllStateParam</a>&nbsp;requestParam)</code></th>
  437. <td class="colLast">
  438. <div class="block">Get flush state of all segments.</div>
  439. </td>
  440. </tr>
  441. <tr id="i36" class="altColor">
  442. <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>
  443. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFlushState(io.milvus.param.control.GetFlushStateParam)">getFlushState</a></span>&#8203;(@NonNull <a href="../param/control/GetFlushStateParam.html" title="class in io.milvus.param.control">GetFlushStateParam</a>&nbsp;requestParam)</code></th>
  444. <td class="colLast">
  445. <div class="block">Get flush state of specified collection.</div>
  446. </td>
  447. </tr>
  448. <tr id="i37" class="rowColor">
  449. <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>
  450. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIndexBuildProgress(io.milvus.param.index.GetIndexBuildProgressParam)">getIndexBuildProgress</a></span>&#8203;(@NonNull <a href="../param/index/GetIndexBuildProgressParam.html" title="class in io.milvus.param.index">GetIndexBuildProgressParam</a>&nbsp;requestParam)</code></th>
  451. <td class="colLast">
  452. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  453. </td>
  454. </tr>
  455. <tr id="i38" class="altColor">
  456. <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>
  457. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIndexState(io.milvus.param.index.GetIndexStateParam)">getIndexState</a></span>&#8203;(@NonNull <a href="../param/index/GetIndexStateParam.html" title="class in io.milvus.param.index">GetIndexStateParam</a>&nbsp;requestParam)</code></th>
  458. <td class="colLast">
  459. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  460. </td>
  461. </tr>
  462. <tr id="i39" class="rowColor">
  463. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetLoadingProgressResponse&gt;</code></td>
  464. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLoadingProgress(io.milvus.param.collection.GetLoadingProgressParam)">getLoadingProgress</a></span>&#8203;(<a href="../param/collection/GetLoadingProgressParam.html" title="class in io.milvus.param.collection">GetLoadingProgressParam</a>&nbsp;requestParam)</code></th>
  465. <td class="colLast">
  466. <div class="block">Get collection loading progress</div>
  467. </td>
  468. </tr>
  469. <tr id="i40" class="altColor">
  470. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetLoadStateResponse&gt;</code></td>
  471. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLoadState(io.milvus.param.collection.GetLoadStateParam)">getLoadState</a></span>&#8203;(<a href="../param/collection/GetLoadStateParam.html" title="class in io.milvus.param.collection">GetLoadStateParam</a>&nbsp;requestParam)</code></th>
  472. <td class="colLast">
  473. <div class="block">Get collection loading state</div>
  474. </td>
  475. </tr>
  476. <tr id="i41" class="rowColor">
  477. <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>
  478. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMetrics(io.milvus.param.control.GetMetricsParam)">getMetrics</a></span>&#8203;(@NonNull <a href="../param/control/GetMetricsParam.html" title="class in io.milvus.param.control">GetMetricsParam</a>&nbsp;requestParam)</code></th>
  479. <td class="colLast">
  480. <div class="block">Gets the runtime metrics information of Milvus, returns the result in .json format.</div>
  481. </td>
  482. </tr>
  483. <tr id="i42" class="altColor">
  484. <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>
  485. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPartitionStatistics(io.milvus.param.partition.GetPartitionStatisticsParam)">getPartitionStatistics</a></span>&#8203;(@NonNull <a href="../param/partition/GetPartitionStatisticsParam.html" title="class in io.milvus.param.partition">GetPartitionStatisticsParam</a>&nbsp;requestParam)</code></th>
  486. <td class="colLast">
  487. <div class="block">Shows the statistics information of a partition.</div>
  488. </td>
  489. </tr>
  490. <tr id="i43" class="rowColor">
  491. <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>
  492. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPersistentSegmentInfo(io.milvus.param.control.GetPersistentSegmentInfoParam)">getPersistentSegmentInfo</a></span>&#8203;(@NonNull <a href="../param/control/GetPersistentSegmentInfoParam.html" title="class in io.milvus.param.control">GetPersistentSegmentInfoParam</a>&nbsp;requestParam)</code></th>
  493. <td class="colLast">
  494. <div class="block">Gets the information of persistent segments from data node, including row count,
  495. persistence state(growing or flushed), etc.</div>
  496. </td>
  497. </tr>
  498. <tr id="i44" class="altColor">
  499. <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>
  500. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getQuerySegmentInfo(io.milvus.param.control.GetQuerySegmentInfoParam)">getQuerySegmentInfo</a></span>&#8203;(@NonNull <a href="../param/control/GetQuerySegmentInfoParam.html" title="class in io.milvus.param.control">GetQuerySegmentInfoParam</a>&nbsp;requestParam)</code></th>
  501. <td class="colLast">
  502. <div class="block">Gets the query information of segments in a collection from query node, including row count,
  503. memory usage size, index name, etc.</div>
  504. </td>
  505. </tr>
  506. <tr id="i45" class="rowColor">
  507. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetReplicasResponse&gt;</code></td>
  508. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReplicas(io.milvus.param.control.GetReplicasParam)">getReplicas</a></span>&#8203;(<a href="../param/control/GetReplicasParam.html" title="class in io.milvus.param.control">GetReplicasParam</a>&nbsp;requestParam)</code></th>
  509. <td class="colLast">
  510. <div class="block">Returns the collection's replica information</div>
  511. </td>
  512. </tr>
  513. <tr id="i46" class="altColor">
  514. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetVersionResponse&gt;</code></td>
  515. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getVersion()">getVersion</a></span>()</code></th>
  516. <td class="colLast">
  517. <div class="block">Get server version</div>
  518. </td>
  519. </tr>
  520. <tr id="i47" class="rowColor">
  521. <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>
  522. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#grantRolePrivilege(io.milvus.param.role.GrantRolePrivilegeParam)">grantRolePrivilege</a></span>&#8203;(<a href="../param/role/GrantRolePrivilegeParam.html" title="class in io.milvus.param.role">GrantRolePrivilegeParam</a>&nbsp;requestParam)</code></th>
  523. <td class="colLast">
  524. <div class="block">Grant Role Privilege.</div>
  525. </td>
  526. </tr>
  527. <tr id="i48" class="altColor">
  528. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;java.lang.Boolean&gt;</code></td>
  529. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasCollection(io.milvus.param.collection.HasCollectionParam)">hasCollection</a></span>&#8203;(@NonNull <a href="../param/collection/HasCollectionParam.html" title="class in io.milvus.param.collection">HasCollectionParam</a>&nbsp;requestParam)</code></th>
  530. <td class="colLast">
  531. <div class="block">Checks if a collection exists.</div>
  532. </td>
  533. </tr>
  534. <tr id="i49" class="rowColor">
  535. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;java.lang.Boolean&gt;</code></td>
  536. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasPartition(io.milvus.param.partition.HasPartitionParam)">hasPartition</a></span>&#8203;(@NonNull <a href="../param/partition/HasPartitionParam.html" title="class in io.milvus.param.partition">HasPartitionParam</a>&nbsp;requestParam)</code></th>
  537. <td class="colLast">
  538. <div class="block">Checks if a partition exists in the specified collection.</div>
  539. </td>
  540. </tr>
  541. <tr id="i50" class="altColor">
  542. <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>
  543. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hybridSearch(io.milvus.param.dml.HybridSearchParam)">hybridSearch</a></span>&#8203;(<a href="../param/dml/HybridSearchParam.html" title="class in io.milvus.param.dml">HybridSearchParam</a>&nbsp;requestParam)</code></th>
  544. <td class="colLast">
  545. <div class="block">Conducts multi vector similarity search with a ranker for rearrangement.</div>
  546. </td>
  547. </tr>
  548. <tr id="i51" class="rowColor">
  549. <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture&lt;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.SearchResults&gt;&gt;</code></td>
  550. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hybridSearchAsync(io.milvus.param.dml.HybridSearchParam)">hybridSearchAsync</a></span>&#8203;(<a href="../param/dml/HybridSearchParam.html" title="class in io.milvus.param.dml">HybridSearchParam</a>&nbsp;requestParam)</code></th>
  551. <td class="colLast">
  552. <div class="block">Conducts multi vector similarity search asynchronously with a ranker for rearrangement.</div>
  553. </td>
  554. </tr>
  555. <tr id="i52" class="altColor">
  556. <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>
  557. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#insert(io.milvus.param.dml.InsertParam)">insert</a></span>&#8203;(@NonNull <a href="../param/dml/InsertParam.html" title="class in io.milvus.param.dml">InsertParam</a>&nbsp;requestParam)</code></th>
  558. <td class="colLast">
  559. <div class="block">Inserts entities into a specified collection .</div>
  560. </td>
  561. </tr>
  562. <tr id="i53" class="rowColor">
  563. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/highlevel/dml/response/InsertResponse.html" title="class in io.milvus.param.highlevel.dml.response">InsertResponse</a>&gt;</code></td>
  564. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#insert(io.milvus.param.highlevel.dml.InsertRowsParam)">insert</a></span>&#8203;(<a href="../param/highlevel/dml/InsertRowsParam.html" title="class in io.milvus.param.highlevel.dml">InsertRowsParam</a>&nbsp;requestParam)</code></th>
  565. <td class="colLast">
  566. <div class="block">Inserts rows data into a specified collection .</div>
  567. </td>
  568. </tr>
  569. <tr id="i54" class="altColor">
  570. <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture&lt;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.MutationResult&gt;&gt;</code></td>
  571. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#insertAsync(io.milvus.param.dml.InsertParam)">insertAsync</a></span>&#8203;(<a href="../param/dml/InsertParam.html" title="class in io.milvus.param.dml">InsertParam</a>&nbsp;requestParam)</code></th>
  572. <td class="colLast">
  573. <div class="block">Inserts entities into a specified collection asynchronously.</div>
  574. </td>
  575. </tr>
  576. <tr id="i55" class="rowColor">
  577. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.ListAliasesResponse&gt;</code></td>
  578. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listAliases(io.milvus.param.alias.ListAliasesParam)">listAliases</a></span>&#8203;(<a href="../param/alias/ListAliasesParam.html" title="class in io.milvus.param.alias">ListAliasesParam</a>&nbsp;requestParam)</code></th>
  579. <td class="colLast">
  580. <div class="block">List all alias for a collection.</div>
  581. </td>
  582. </tr>
  583. <tr id="i56" class="altColor">
  584. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.ListImportTasksResponse&gt;</code></td>
  585. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listBulkInsertTasks(io.milvus.param.bulkinsert.ListBulkInsertTasksParam)">listBulkInsertTasks</a></span>&#8203;(<a href="../param/bulkinsert/ListBulkInsertTasksParam.html" title="class in io.milvus.param.bulkinsert">ListBulkInsertTasksParam</a>&nbsp;requestParam)</code></th>
  586. <td class="colLast">
  587. <div class="block">List bulk insert tasks</div>
  588. </td>
  589. </tr>
  590. <tr id="i57" class="rowColor">
  591. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/highlevel/collection/response/ListCollectionsResponse.html" title="class in io.milvus.param.highlevel.collection.response">ListCollectionsResponse</a>&gt;</code></td>
  592. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listCollections(io.milvus.param.highlevel.collection.ListCollectionsParam)">listCollections</a></span>&#8203;(<a href="../param/highlevel/collection/ListCollectionsParam.html" title="class in io.milvus.param.highlevel.collection">ListCollectionsParam</a>&nbsp;requestParam)</code></th>
  593. <td class="colLast">
  594. <div class="block">Lists all collections</div>
  595. </td>
  596. </tr>
  597. <tr id="i58" class="altColor">
  598. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.ListCredUsersResponse&gt;</code></td>
  599. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listCredUsers(io.milvus.param.credential.ListCredUsersParam)">listCredUsers</a></span>&#8203;(<a href="../param/credential/ListCredUsersParam.html" title="class in io.milvus.param.credential">ListCredUsersParam</a>&nbsp;requestParam)</code></th>
  600. <td class="colLast">
  601. <div class="block">List all user names.</div>
  602. </td>
  603. </tr>
  604. <tr id="i59" class="rowColor">
  605. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.ListDatabasesResponse&gt;</code></td>
  606. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listDatabases()">listDatabases</a></span>()</code></th>
  607. <td class="colLast">
  608. <div class="block">List databases.</div>
  609. </td>
  610. </tr>
  611. <tr id="i60" class="altColor">
  612. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.ListResourceGroupsResponse&gt;</code></td>
  613. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listResourceGroups(io.milvus.param.resourcegroup.ListResourceGroupsParam)">listResourceGroups</a></span>&#8203;(<a href="../param/resourcegroup/ListResourceGroupsParam.html" title="class in io.milvus.param.resourcegroup">ListResourceGroupsParam</a>&nbsp;requestParam)</code></th>
  614. <td class="colLast">
  615. <div class="block">List resource groups.</div>
  616. </td>
  617. </tr>
  618. <tr id="i61" class="rowColor">
  619. <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>
  620. <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>
  621. <td class="colLast">
  622. <div class="block">Moves segment from a query node to another to keep the load balanced.</div>
  623. </td>
  624. </tr>
  625. <tr id="i62" class="altColor">
  626. <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>
  627. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#loadCollection(io.milvus.param.collection.LoadCollectionParam)">loadCollection</a></span>&#8203;(@NonNull <a href="../param/collection/LoadCollectionParam.html" title="class in io.milvus.param.collection">LoadCollectionParam</a>&nbsp;requestParam)</code></th>
  628. <td class="colLast">
  629. <div class="block">Loads a collection to memory before search or query.</div>
  630. </td>
  631. </tr>
  632. <tr id="i63" class="rowColor">
  633. <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>
  634. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#loadPartitions(io.milvus.param.partition.LoadPartitionsParam)">loadPartitions</a></span>&#8203;(@NonNull <a href="../param/partition/LoadPartitionsParam.html" title="class in io.milvus.param.partition">LoadPartitionsParam</a>&nbsp;requestParam)</code></th>
  635. <td class="colLast">
  636. <div class="block">Loads a partition into memory.</div>
  637. </td>
  638. </tr>
  639. <tr id="i64" class="altColor">
  640. <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>
  641. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#manualCompact(io.milvus.param.control.ManualCompactParam)">manualCompact</a></span>&#8203;(<a href="../param/control/ManualCompactParam.html" title="class in io.milvus.param.control">ManualCompactParam</a>&nbsp;requestParam)</code></th>
  642. <td class="colLast">
  643. <div class="block">Performs a manual compaction.</div>
  644. </td>
  645. </tr>
  646. <tr id="i65" class="rowColor">
  647. <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>
  648. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#query(io.milvus.param.dml.QueryParam)">query</a></span>&#8203;(@NonNull <a href="../param/dml/QueryParam.html" title="class in io.milvus.param.dml">QueryParam</a>&nbsp;requestParam)</code></th>
  649. <td class="colLast">
  650. <div class="block">Queries entity(s) based on scalar field(s) filtered by boolean expression.</div>
  651. </td>
  652. </tr>
  653. <tr id="i66" class="altColor">
  654. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/highlevel/dml/response/QueryResponse.html" title="class in io.milvus.param.highlevel.dml.response">QueryResponse</a>&gt;</code></td>
  655. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#query(io.milvus.param.highlevel.dml.QuerySimpleParam)">query</a></span>&#8203;(<a href="../param/highlevel/dml/QuerySimpleParam.html" title="class in io.milvus.param.highlevel.dml">QuerySimpleParam</a>&nbsp;requestParam)</code></th>
  656. <td class="colLast">
  657. <div class="block">Queries entity(s) based on scalar field(s) filtered by boolean expression.</div>
  658. </td>
  659. </tr>
  660. <tr id="i67" class="rowColor">
  661. <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture&lt;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.QueryResults&gt;&gt;</code></td>
  662. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#queryAsync(io.milvus.param.dml.QueryParam)">queryAsync</a></span>&#8203;(<a href="../param/dml/QueryParam.html" title="class in io.milvus.param.dml">QueryParam</a>&nbsp;requestParam)</code></th>
  663. <td class="colLast">
  664. <div class="block">Queries entity(s) asynchronously based on scalar field(s) filtered by boolean expression.</div>
  665. </td>
  666. </tr>
  667. <tr id="i68" class="altColor">
  668. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../orm/iterator/QueryIterator.html" title="class in io.milvus.orm.iterator">QueryIterator</a>&gt;</code></td>
  669. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#queryIterator(io.milvus.param.dml.QueryIteratorParam)">queryIterator</a></span>&#8203;(<a href="../param/dml/QueryIteratorParam.html" title="class in io.milvus.param.dml">QueryIteratorParam</a>&nbsp;requestParam)</code></th>
  670. <td class="colLast">
  671. <div class="block">Get queryIterator based on scalar field(s) filtered by boolean expression.</div>
  672. </td>
  673. </tr>
  674. <tr id="i69" class="rowColor">
  675. <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>
  676. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#releaseCollection(io.milvus.param.collection.ReleaseCollectionParam)">releaseCollection</a></span>&#8203;(@NonNull <a href="../param/collection/ReleaseCollectionParam.html" title="class in io.milvus.param.collection">ReleaseCollectionParam</a>&nbsp;requestParam)</code></th>
  677. <td class="colLast">
  678. <div class="block">Releases a collection from memory to reduce memory usage.</div>
  679. </td>
  680. </tr>
  681. <tr id="i70" class="altColor">
  682. <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>
  683. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#releasePartitions(io.milvus.param.partition.ReleasePartitionsParam)">releasePartitions</a></span>&#8203;(@NonNull <a href="../param/partition/ReleasePartitionsParam.html" title="class in io.milvus.param.partition">ReleasePartitionsParam</a>&nbsp;requestParam)</code></th>
  684. <td class="colLast">
  685. <div class="block">Releases a partition from memory.</div>
  686. </td>
  687. </tr>
  688. <tr id="i71" class="rowColor">
  689. <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>
  690. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeUserFromRole(io.milvus.param.role.RemoveUserFromRoleParam)">removeUserFromRole</a></span>&#8203;(<a href="../param/role/RemoveUserFromRoleParam.html" title="class in io.milvus.param.role">RemoveUserFromRoleParam</a>&nbsp;requestParam)</code></th>
  691. <td class="colLast">
  692. <div class="block">The user will remove permissions that the role are allowed to perform operations.</div>
  693. </td>
  694. </tr>
  695. <tr id="i72" class="altColor">
  696. <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>
  697. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#renameCollection(io.milvus.param.collection.RenameCollectionParam)">renameCollection</a></span>&#8203;(<a href="../param/collection/RenameCollectionParam.html" title="class in io.milvus.param.collection">RenameCollectionParam</a>&nbsp;requestParam)</code></th>
  698. <td class="colLast">
  699. <div class="block">rename a collection</div>
  700. </td>
  701. </tr>
  702. <tr id="i73" class="rowColor">
  703. <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>
  704. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#revokeRolePrivilege(io.milvus.param.role.RevokeRolePrivilegeParam)">revokeRolePrivilege</a></span>&#8203;(<a href="../param/role/RevokeRolePrivilegeParam.html" title="class in io.milvus.param.role">RevokeRolePrivilegeParam</a>&nbsp;requestParam)</code></th>
  705. <td class="colLast">
  706. <div class="block">Revoke Role Privilege.</div>
  707. </td>
  708. </tr>
  709. <tr id="i74" class="altColor">
  710. <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>
  711. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#search(io.milvus.param.dml.SearchParam)">search</a></span>&#8203;(@NonNull <a href="../param/dml/SearchParam.html" title="class in io.milvus.param.dml">SearchParam</a>&nbsp;requestParam)</code></th>
  712. <td class="colLast">
  713. <div class="block">Conducts ANN search on a vector field.</div>
  714. </td>
  715. </tr>
  716. <tr id="i75" class="rowColor">
  717. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/highlevel/dml/response/SearchResponse.html" title="class in io.milvus.param.highlevel.dml.response">SearchResponse</a>&gt;</code></td>
  718. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#search(io.milvus.param.highlevel.dml.SearchSimpleParam)">search</a></span>&#8203;(<a href="../param/highlevel/dml/SearchSimpleParam.html" title="class in io.milvus.param.highlevel.dml">SearchSimpleParam</a>&nbsp;requestParam)</code></th>
  719. <td class="colLast">
  720. <div class="block">Conducts ANN search on a vector field.</div>
  721. </td>
  722. </tr>
  723. <tr id="i76" class="altColor">
  724. <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture&lt;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.SearchResults&gt;&gt;</code></td>
  725. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#searchAsync(io.milvus.param.dml.SearchParam)">searchAsync</a></span>&#8203;(<a href="../param/dml/SearchParam.html" title="class in io.milvus.param.dml">SearchParam</a>&nbsp;requestParam)</code></th>
  726. <td class="colLast">
  727. <div class="block">Conducts ANN search on a vector field asynchronously.</div>
  728. </td>
  729. </tr>
  730. <tr id="i77" class="rowColor">
  731. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../orm/iterator/SearchIterator.html" title="class in io.milvus.orm.iterator">SearchIterator</a>&gt;</code></td>
  732. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#searchIterator(io.milvus.param.dml.SearchIteratorParam)">searchIterator</a></span>&#8203;(<a href="../param/dml/SearchIteratorParam.html" title="class in io.milvus.param.dml">SearchIteratorParam</a>&nbsp;requestParam)</code></th>
  733. <td class="colLast">
  734. <div class="block">Get searchIterator based on a vector field.</div>
  735. </td>
  736. </tr>
  737. <tr id="i78" class="altColor">
  738. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.SelectGrantResponse&gt;</code></td>
  739. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#selectGrantForRole(io.milvus.param.role.SelectGrantForRoleParam)">selectGrantForRole</a></span>&#8203;(<a href="../param/role/SelectGrantForRoleParam.html" title="class in io.milvus.param.role">SelectGrantForRoleParam</a>&nbsp;requestParam)</code></th>
  740. <td class="colLast">
  741. <div class="block">List a grant info for the role and the specific object</div>
  742. </td>
  743. </tr>
  744. <tr id="i79" class="rowColor">
  745. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.SelectGrantResponse&gt;</code></td>
  746. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#selectGrantForRoleAndObject(io.milvus.param.role.SelectGrantForRoleAndObjectParam)">selectGrantForRoleAndObject</a></span>&#8203;(<a href="../param/role/SelectGrantForRoleAndObjectParam.html" title="class in io.milvus.param.role">SelectGrantForRoleAndObjectParam</a>&nbsp;requestParam)</code></th>
  747. <td class="colLast">
  748. <div class="block">List a grant info for the role</div>
  749. </td>
  750. </tr>
  751. <tr id="i80" class="altColor">
  752. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.SelectRoleResponse&gt;</code></td>
  753. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#selectRole(io.milvus.param.role.SelectRoleParam)">selectRole</a></span>&#8203;(<a href="../param/role/SelectRoleParam.html" title="class in io.milvus.param.role">SelectRoleParam</a>&nbsp;requestParam)</code></th>
  754. <td class="colLast">
  755. <div class="block">Get all users who are added to the role.</div>
  756. </td>
  757. </tr>
  758. <tr id="i81" class="rowColor">
  759. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.SelectUserResponse&gt;</code></td>
  760. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#selectUser(io.milvus.param.role.SelectUserParam)">selectUser</a></span>&#8203;(<a href="../param/role/SelectUserParam.html" title="class in io.milvus.param.role">SelectUserParam</a>&nbsp;requestParam)</code></th>
  761. <td class="colLast">
  762. <div class="block">Get all roles the user has.</div>
  763. </td>
  764. </tr>
  765. <tr id="i82" class="altColor">
  766. <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>
  767. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#showCollections(io.milvus.param.collection.ShowCollectionsParam)">showCollections</a></span>&#8203;(@NonNull <a href="../param/collection/ShowCollectionsParam.html" title="class in io.milvus.param.collection">ShowCollectionsParam</a>&nbsp;requestParam)</code></th>
  768. <td class="colLast">
  769. <div class="block">Lists all collections or gets collection loading status.</div>
  770. </td>
  771. </tr>
  772. <tr id="i83" class="rowColor">
  773. <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>
  774. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#showPartitions(io.milvus.param.partition.ShowPartitionsParam)">showPartitions</a></span>&#8203;(@NonNull <a href="../param/partition/ShowPartitionsParam.html" title="class in io.milvus.param.partition">ShowPartitionsParam</a>&nbsp;requestParam)</code></th>
  775. <td class="colLast">
  776. <div class="block">Shows all partitions in the specified collection.</div>
  777. </td>
  778. </tr>
  779. <tr id="i84" class="altColor">
  780. <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>
  781. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#transferNode(io.milvus.param.resourcegroup.TransferNodeParam)">transferNode</a></span>&#8203;(<a href="../param/resourcegroup/TransferNodeParam.html" title="class in io.milvus.param.resourcegroup">TransferNodeParam</a>&nbsp;requestParam)</code></th>
  782. <td class="colLast">
  783. <div class="block">Transfer a query node from source resource group to target resource_group.</div>
  784. </td>
  785. </tr>
  786. <tr id="i85" class="rowColor">
  787. <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>
  788. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#transferReplica(io.milvus.param.resourcegroup.TransferReplicaParam)">transferReplica</a></span>&#8203;(<a href="../param/resourcegroup/TransferReplicaParam.html" title="class in io.milvus.param.resourcegroup">TransferReplicaParam</a>&nbsp;requestParam)</code></th>
  789. <td class="colLast">
  790. <div class="block">Transfer a replica from source resource group to target resource_group.</div>
  791. </td>
  792. </tr>
  793. <tr id="i86" class="altColor">
  794. <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>
  795. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updateCredential(io.milvus.param.credential.UpdateCredentialParam)">updateCredential</a></span>&#8203;(<a href="../param/credential/UpdateCredentialParam.html" title="class in io.milvus.param.credential">UpdateCredentialParam</a>&nbsp;requestParam)</code></th>
  796. <td class="colLast">
  797. <div class="block">Update credential using the given user and password.</div>
  798. </td>
  799. </tr>
  800. <tr id="i87" class="rowColor">
  801. <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>
  802. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#upsert(io.milvus.param.dml.UpsertParam)">upsert</a></span>&#8203;(<a href="../param/dml/UpsertParam.html" title="class in io.milvus.param.dml">UpsertParam</a>&nbsp;requestParam)</code></th>
  803. <td class="colLast">
  804. <div class="block">Insert new entities into a specified collection, replace them if the entities already exist.</div>
  805. </td>
  806. </tr>
  807. <tr id="i88" class="altColor">
  808. <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture&lt;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.MutationResult&gt;&gt;</code></td>
  809. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#upsertAsync(io.milvus.param.dml.UpsertParam)">upsertAsync</a></span>&#8203;(<a href="../param/dml/UpsertParam.html" title="class in io.milvus.param.dml">UpsertParam</a>&nbsp;requestParam)</code></th>
  810. <td class="colLast">
  811. <div class="block">Insert new entities into a specified collection asynchronously, replace them if the entities already exist.</div>
  812. </td>
  813. </tr>
  814. </table>
  815. <ul class="blockList">
  816. <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
  817. <!-- -->
  818. </a>
  819. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  820. <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  821. </ul>
  822. <ul class="blockList">
  823. <li class="blockList"><a id="methods.inherited.from.class.io.milvus.client.MilvusClient">
  824. <!-- -->
  825. </a>
  826. <h3>Methods inherited from interface&nbsp;io.milvus.client.<a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></h3>
  827. <code><a href="MilvusClient.html#close()">close</a>, <a href="MilvusClient.html#close(long)">close</a>, <a href="MilvusClient.html#setLogLevel(io.milvus.param.LogLevel)">setLogLevel</a>, <a href="MilvusClient.html#withRetry(int)">withRetry</a>, <a href="MilvusClient.html#withRetry(io.milvus.param.RetryParam)">withRetry</a>, <a href="MilvusClient.html#withRetryInterval(long,java.util.concurrent.TimeUnit)">withRetryInterval</a>, <a href="MilvusClient.html#withTimeout(long,java.util.concurrent.TimeUnit)">withTimeout</a></code></li>
  828. </ul>
  829. </li>
  830. </ul>
  831. </section>
  832. </li>
  833. </ul>
  834. </div>
  835. <div class="details">
  836. <ul class="blockList">
  837. <li class="blockList">
  838. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  839. <section>
  840. <ul class="blockList">
  841. <li class="blockList"><a id="constructor.detail">
  842. <!-- -->
  843. </a>
  844. <h3>Constructor Detail</h3>
  845. <a id="&lt;init&gt;()">
  846. <!-- -->
  847. </a>
  848. <ul class="blockListLast">
  849. <li class="blockList">
  850. <h4>AbstractMilvusGrpcClient</h4>
  851. <pre>public&nbsp;AbstractMilvusGrpcClient()</pre>
  852. </li>
  853. </ul>
  854. </li>
  855. </ul>
  856. </section>
  857. <!-- ============ METHOD DETAIL ========== -->
  858. <section>
  859. <ul class="blockList">
  860. <li class="blockList"><a id="method.detail">
  861. <!-- -->
  862. </a>
  863. <h3>Method Detail</h3>
  864. <a id="hasCollection(io.milvus.param.collection.HasCollectionParam)">
  865. <!-- -->
  866. </a>
  867. <ul class="blockList">
  868. <li class="blockList">
  869. <h4>hasCollection</h4>
  870. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;java.lang.Boolean&gt;&nbsp;hasCollection&#8203;(@NonNull
  871. @NonNull <a href="../param/collection/HasCollectionParam.html" title="class in io.milvus.param.collection">HasCollectionParam</a>&nbsp;requestParam)</pre>
  872. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#hasCollection(io.milvus.param.collection.HasCollectionParam)">MilvusClient</a></code></span></div>
  873. <div class="block">Checks if a collection exists.</div>
  874. <dl>
  875. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  876. <dd><code><a href="MilvusClient.html#hasCollection(io.milvus.param.collection.HasCollectionParam)">hasCollection</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  877. <dt><span class="paramLabel">Parameters:</span></dt>
  878. <dd><code>requestParam</code> - <a href="../param/collection/HasCollectionParam.html" title="class in io.milvus.param.collection"><code>HasCollectionParam</code></a></dd>
  879. <dt><span class="returnLabel">Returns:</span></dt>
  880. <dd>{status:result code, data: boolean, whether if has collection or not}</dd>
  881. </dl>
  882. </li>
  883. </ul>
  884. <a id="createDatabase(io.milvus.param.collection.CreateDatabaseParam)">
  885. <!-- -->
  886. </a>
  887. <ul class="blockList">
  888. <li class="blockList">
  889. <h4>createDatabase</h4>
  890. <pre class="methodSignature">public&nbsp;<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;createDatabase&#8203;(<a href="../param/collection/CreateDatabaseParam.html" title="class in io.milvus.param.collection">CreateDatabaseParam</a>&nbsp;requestParam)</pre>
  891. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#createDatabase(io.milvus.param.collection.CreateDatabaseParam)">MilvusClient</a></code></span></div>
  892. <div class="block">Creates a database in Milvus.</div>
  893. <dl>
  894. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  895. <dd><code><a href="MilvusClient.html#createDatabase(io.milvus.param.collection.CreateDatabaseParam)">createDatabase</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  896. <dt><span class="paramLabel">Parameters:</span></dt>
  897. <dd><code>requestParam</code> - <a href="../param/collection/CreateDatabaseParam.html" title="class in io.milvus.param.collection"><code>CreateDatabaseParam</code></a></dd>
  898. <dt><span class="returnLabel">Returns:</span></dt>
  899. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  900. </dl>
  901. </li>
  902. </ul>
  903. <a id="listDatabases()">
  904. <!-- -->
  905. </a>
  906. <ul class="blockList">
  907. <li class="blockList">
  908. <h4>listDatabases</h4>
  909. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.ListDatabasesResponse&gt;&nbsp;listDatabases()</pre>
  910. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#listDatabases()">MilvusClient</a></code></span></div>
  911. <div class="block">List databases. Note that this method list all database in the cluster.</div>
  912. <dl>
  913. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  914. <dd><code><a href="MilvusClient.html#listDatabases()">listDatabases</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  915. <dt><span class="returnLabel">Returns:</span></dt>
  916. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  917. </dl>
  918. </li>
  919. </ul>
  920. <a id="dropDatabase(io.milvus.param.collection.DropDatabaseParam)">
  921. <!-- -->
  922. </a>
  923. <ul class="blockList">
  924. <li class="blockList">
  925. <h4>dropDatabase</h4>
  926. <pre class="methodSignature">public&nbsp;<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;dropDatabase&#8203;(<a href="../param/collection/DropDatabaseParam.html" title="class in io.milvus.param.collection">DropDatabaseParam</a>&nbsp;requestParam)</pre>
  927. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#dropDatabase(io.milvus.param.collection.DropDatabaseParam)">MilvusClient</a></code></span></div>
  928. <div class="block">Drops a database. Note that this method drops all data in the database.</div>
  929. <dl>
  930. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  931. <dd><code><a href="MilvusClient.html#dropDatabase(io.milvus.param.collection.DropDatabaseParam)">dropDatabase</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  932. <dt><span class="paramLabel">Parameters:</span></dt>
  933. <dd><code>requestParam</code> - <a href="../param/collection/DropDatabaseParam.html" title="class in io.milvus.param.collection"><code>DropDatabaseParam</code></a></dd>
  934. <dt><span class="returnLabel">Returns:</span></dt>
  935. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  936. </dl>
  937. </li>
  938. </ul>
  939. <a id="createCollection(io.milvus.param.collection.CreateCollectionParam)">
  940. <!-- -->
  941. </a>
  942. <ul class="blockList">
  943. <li class="blockList">
  944. <h4>createCollection</h4>
  945. <pre class="methodSignature">public&nbsp;<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;(@NonNull
  946. @NonNull <a href="../param/collection/CreateCollectionParam.html" title="class in io.milvus.param.collection">CreateCollectionParam</a>&nbsp;requestParam)</pre>
  947. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#createCollection(io.milvus.param.collection.CreateCollectionParam)">MilvusClient</a></code></span></div>
  948. <div class="block">Creates a collection in Milvus.</div>
  949. <dl>
  950. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  951. <dd><code><a href="MilvusClient.html#createCollection(io.milvus.param.collection.CreateCollectionParam)">createCollection</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  952. <dt><span class="paramLabel">Parameters:</span></dt>
  953. <dd><code>requestParam</code> - <a href="../param/collection/CreateCollectionParam.html" title="class in io.milvus.param.collection"><code>CreateCollectionParam</code></a></dd>
  954. <dt><span class="returnLabel">Returns:</span></dt>
  955. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  956. </dl>
  957. </li>
  958. </ul>
  959. <a id="dropCollection(io.milvus.param.collection.DropCollectionParam)">
  960. <!-- -->
  961. </a>
  962. <ul class="blockList">
  963. <li class="blockList">
  964. <h4>dropCollection</h4>
  965. <pre class="methodSignature">public&nbsp;<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;(@NonNull
  966. @NonNull <a href="../param/collection/DropCollectionParam.html" title="class in io.milvus.param.collection">DropCollectionParam</a>&nbsp;requestParam)</pre>
  967. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#dropCollection(io.milvus.param.collection.DropCollectionParam)">MilvusClient</a></code></span></div>
  968. <div class="block">Drops a collection. Note that this method drops all data in the collection.</div>
  969. <dl>
  970. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  971. <dd><code><a href="MilvusClient.html#dropCollection(io.milvus.param.collection.DropCollectionParam)">dropCollection</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  972. <dt><span class="paramLabel">Parameters:</span></dt>
  973. <dd><code>requestParam</code> - <a href="../param/collection/DropCollectionParam.html" title="class in io.milvus.param.collection"><code>DropCollectionParam</code></a></dd>
  974. <dt><span class="returnLabel">Returns:</span></dt>
  975. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  976. </dl>
  977. </li>
  978. </ul>
  979. <a id="loadCollection(io.milvus.param.collection.LoadCollectionParam)">
  980. <!-- -->
  981. </a>
  982. <ul class="blockList">
  983. <li class="blockList">
  984. <h4>loadCollection</h4>
  985. <pre class="methodSignature">public&nbsp;<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;(@NonNull
  986. @NonNull <a href="../param/collection/LoadCollectionParam.html" title="class in io.milvus.param.collection">LoadCollectionParam</a>&nbsp;requestParam)</pre>
  987. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#loadCollection(io.milvus.param.collection.LoadCollectionParam)">MilvusClient</a></code></span></div>
  988. <div class="block">Loads a collection to memory before search or query.</div>
  989. <dl>
  990. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  991. <dd><code><a href="MilvusClient.html#loadCollection(io.milvus.param.collection.LoadCollectionParam)">loadCollection</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  992. <dt><span class="paramLabel">Parameters:</span></dt>
  993. <dd><code>requestParam</code> - <a href="../param/collection/LoadCollectionParam.html" title="class in io.milvus.param.collection"><code>LoadCollectionParam</code></a></dd>
  994. <dt><span class="returnLabel">Returns:</span></dt>
  995. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  996. </dl>
  997. </li>
  998. </ul>
  999. <a id="releaseCollection(io.milvus.param.collection.ReleaseCollectionParam)">
  1000. <!-- -->
  1001. </a>
  1002. <ul class="blockList">
  1003. <li class="blockList">
  1004. <h4>releaseCollection</h4>
  1005. <pre class="methodSignature">public&nbsp;<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;(@NonNull
  1006. @NonNull <a href="../param/collection/ReleaseCollectionParam.html" title="class in io.milvus.param.collection">ReleaseCollectionParam</a>&nbsp;requestParam)</pre>
  1007. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#releaseCollection(io.milvus.param.collection.ReleaseCollectionParam)">MilvusClient</a></code></span></div>
  1008. <div class="block">Releases a collection from memory to reduce memory usage. Note that you
  1009. cannot search while the corresponding collection is released from memory.</div>
  1010. <dl>
  1011. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1012. <dd><code><a href="MilvusClient.html#releaseCollection(io.milvus.param.collection.ReleaseCollectionParam)">releaseCollection</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1013. <dt><span class="paramLabel">Parameters:</span></dt>
  1014. <dd><code>requestParam</code> - <a href="../param/collection/ReleaseCollectionParam.html" title="class in io.milvus.param.collection"><code>ReleaseCollectionParam</code></a></dd>
  1015. <dt><span class="returnLabel">Returns:</span></dt>
  1016. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1017. </dl>
  1018. </li>
  1019. </ul>
  1020. <a id="renameCollection(io.milvus.param.collection.RenameCollectionParam)">
  1021. <!-- -->
  1022. </a>
  1023. <ul class="blockList">
  1024. <li class="blockList">
  1025. <h4>renameCollection</h4>
  1026. <pre class="methodSignature">public&nbsp;<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;renameCollection&#8203;(<a href="../param/collection/RenameCollectionParam.html" title="class in io.milvus.param.collection">RenameCollectionParam</a>&nbsp;requestParam)</pre>
  1027. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#renameCollection(io.milvus.param.collection.RenameCollectionParam)">MilvusClient</a></code></span></div>
  1028. <div class="block">rename a collection</div>
  1029. <dl>
  1030. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1031. <dd><code><a href="MilvusClient.html#renameCollection(io.milvus.param.collection.RenameCollectionParam)">renameCollection</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1032. <dt><span class="paramLabel">Parameters:</span></dt>
  1033. <dd><code>requestParam</code> - <a href="../param/collection/RenameCollectionParam.html" title="class in io.milvus.param.collection"><code>RenameCollectionParam</code></a></dd>
  1034. <dt><span class="returnLabel">Returns:</span></dt>
  1035. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1036. </dl>
  1037. </li>
  1038. </ul>
  1039. <a id="describeCollection(io.milvus.param.collection.DescribeCollectionParam)">
  1040. <!-- -->
  1041. </a>
  1042. <ul class="blockList">
  1043. <li class="blockList">
  1044. <h4>describeCollection</h4>
  1045. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.DescribeCollectionResponse&gt;&nbsp;describeCollection&#8203;(@NonNull
  1046. @NonNull <a href="../param/collection/DescribeCollectionParam.html" title="class in io.milvus.param.collection">DescribeCollectionParam</a>&nbsp;requestParam)</pre>
  1047. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#describeCollection(io.milvus.param.collection.DescribeCollectionParam)">MilvusClient</a></code></span></div>
  1048. <div class="block">Shows the details of a collection, e.g. name, schema.</div>
  1049. <dl>
  1050. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1051. <dd><code><a href="MilvusClient.html#describeCollection(io.milvus.param.collection.DescribeCollectionParam)">describeCollection</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1052. <dt><span class="paramLabel">Parameters:</span></dt>
  1053. <dd><code>requestParam</code> - <a href="../param/collection/DescribeCollectionParam.html" title="class in io.milvus.param.collection"><code>DescribeCollectionParam</code></a></dd>
  1054. <dt><span class="returnLabel">Returns:</span></dt>
  1055. <dd>{status:result code, data:DescribeCollectionResponse{schema,collectionID}}</dd>
  1056. </dl>
  1057. </li>
  1058. </ul>
  1059. <a id="getCollectionStatistics(io.milvus.param.collection.GetCollectionStatisticsParam)">
  1060. <!-- -->
  1061. </a>
  1062. <ul class="blockList">
  1063. <li class="blockList">
  1064. <h4>getCollectionStatistics</h4>
  1065. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetCollectionStatisticsResponse&gt;&nbsp;getCollectionStatistics&#8203;(@NonNull
  1066. @NonNull <a href="../param/collection/GetCollectionStatisticsParam.html" title="class in io.milvus.param.collection">GetCollectionStatisticsParam</a>&nbsp;requestParam)</pre>
  1067. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#getCollectionStatistics(io.milvus.param.collection.GetCollectionStatisticsParam)">MilvusClient</a></code></span></div>
  1068. <div class="block">Shows the statistics information of a collection.</div>
  1069. <dl>
  1070. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1071. <dd><code><a href="MilvusClient.html#getCollectionStatistics(io.milvus.param.collection.GetCollectionStatisticsParam)">getCollectionStatistics</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1072. <dt><span class="paramLabel">Parameters:</span></dt>
  1073. <dd><code>requestParam</code> - <a href="../param/collection/GetCollectionStatisticsParam.html" title="class in io.milvus.param.collection"><code>GetCollectionStatisticsParam</code></a></dd>
  1074. <dt><span class="returnLabel">Returns:</span></dt>
  1075. <dd>{status:result code, data: GetCollectionStatisticsResponse{status,stats}}</dd>
  1076. </dl>
  1077. </li>
  1078. </ul>
  1079. <a id="showCollections(io.milvus.param.collection.ShowCollectionsParam)">
  1080. <!-- -->
  1081. </a>
  1082. <ul class="blockList">
  1083. <li class="blockList">
  1084. <h4>showCollections</h4>
  1085. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.ShowCollectionsResponse&gt;&nbsp;showCollections&#8203;(@NonNull
  1086. @NonNull <a href="../param/collection/ShowCollectionsParam.html" title="class in io.milvus.param.collection">ShowCollectionsParam</a>&nbsp;requestParam)</pre>
  1087. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#showCollections(io.milvus.param.collection.ShowCollectionsParam)">MilvusClient</a></code></span></div>
  1088. <div class="block">Lists all collections or gets collection loading status.</div>
  1089. <dl>
  1090. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1091. <dd><code><a href="MilvusClient.html#showCollections(io.milvus.param.collection.ShowCollectionsParam)">showCollections</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1092. <dt><span class="paramLabel">Parameters:</span></dt>
  1093. <dd><code>requestParam</code> - <a href="../param/collection/ShowCollectionsParam.html" title="class in io.milvus.param.collection"><code>ShowCollectionsParam</code></a></dd>
  1094. <dt><span class="returnLabel">Returns:</span></dt>
  1095. <dd>{status:result code, data: ShowCollectionsResponse{status,collection_names,collection_ids,created_timestamps,created_utc_timestamps}}</dd>
  1096. </dl>
  1097. </li>
  1098. </ul>
  1099. <a id="alterCollection(io.milvus.param.collection.AlterCollectionParam)">
  1100. <!-- -->
  1101. </a>
  1102. <ul class="blockList">
  1103. <li class="blockList">
  1104. <h4>alterCollection</h4>
  1105. <pre class="methodSignature">public&nbsp;<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;alterCollection&#8203;(<a href="../param/collection/AlterCollectionParam.html" title="class in io.milvus.param.collection">AlterCollectionParam</a>&nbsp;requestParam)</pre>
  1106. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#alterCollection(io.milvus.param.collection.AlterCollectionParam)">MilvusClient</a></code></span></div>
  1107. <div class="block">Alter collection with key-value properties.</div>
  1108. <dl>
  1109. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1110. <dd><code><a href="MilvusClient.html#alterCollection(io.milvus.param.collection.AlterCollectionParam)">alterCollection</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1111. <dt><span class="paramLabel">Parameters:</span></dt>
  1112. <dd><code>requestParam</code> - <a href="../param/collection/AlterCollectionParam.html" title="class in io.milvus.param.collection"><code>AlterCollectionParam</code></a></dd>
  1113. <dt><span class="returnLabel">Returns:</span></dt>
  1114. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1115. </dl>
  1116. </li>
  1117. </ul>
  1118. <a id="flush(io.milvus.param.collection.FlushParam)">
  1119. <!-- -->
  1120. </a>
  1121. <ul class="blockList">
  1122. <li class="blockList">
  1123. <h4>flush</h4>
  1124. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.FlushResponse&gt;&nbsp;flush&#8203;(@NonNull
  1125. @NonNull <a href="../param/collection/FlushParam.html" title="class in io.milvus.param.collection">FlushParam</a>&nbsp;requestParam)</pre>
  1126. <div class="block">Flush insert buffer into storage. To make sure the buffer persisted successfully, it calls
  1127. GetFlushState() to check related segments state.</div>
  1128. <dl>
  1129. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1130. <dd><code><a href="MilvusClient.html#flush(io.milvus.param.collection.FlushParam)">flush</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1131. <dt><span class="paramLabel">Parameters:</span></dt>
  1132. <dd><code>requestParam</code> - <a href="../param/collection/FlushParam.html" title="class in io.milvus.param.collection"><code>FlushParam</code></a></dd>
  1133. <dt><span class="returnLabel">Returns:</span></dt>
  1134. <dd>{status:result code,data: FlushResponse{flush segment ids}}</dd>
  1135. </dl>
  1136. </li>
  1137. </ul>
  1138. <a id="flushAll(boolean,long,long)">
  1139. <!-- -->
  1140. </a>
  1141. <ul class="blockList">
  1142. <li class="blockList">
  1143. <h4>flushAll</h4>
  1144. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.FlushAllResponse&gt;&nbsp;flushAll&#8203;(boolean&nbsp;syncFlushAll,
  1145. long&nbsp;syncFlushAllWaitingInterval,
  1146. long&nbsp;syncFlushAllTimeout)</pre>
  1147. <div class="block">Flush all collections. All insertions, deletions, and upserts before `flushAll` will be synced.</div>
  1148. <dl>
  1149. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1150. <dd><code><a href="MilvusClient.html#flushAll(boolean,long,long)">flushAll</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1151. <dt><span class="paramLabel">Parameters:</span></dt>
  1152. <dd><code>syncFlushAll</code> - {flushAll synchronously or asynchronously}</dd>
  1153. <dd><code>syncFlushAllWaitingInterval</code> - {wait intervel when flushAll synchronously}</dd>
  1154. <dd><code>syncFlushAllTimeout</code> - {timeout when flushAll synchronously}</dd>
  1155. <dt><span class="returnLabel">Returns:</span></dt>
  1156. <dd>{status:result code,data: FlushAllResponse{flushAllTs}}</dd>
  1157. </dl>
  1158. </li>
  1159. </ul>
  1160. <a id="createPartition(io.milvus.param.partition.CreatePartitionParam)">
  1161. <!-- -->
  1162. </a>
  1163. <ul class="blockList">
  1164. <li class="blockList">
  1165. <h4>createPartition</h4>
  1166. <pre class="methodSignature">public&nbsp;<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;(@NonNull
  1167. @NonNull <a href="../param/partition/CreatePartitionParam.html" title="class in io.milvus.param.partition">CreatePartitionParam</a>&nbsp;requestParam)</pre>
  1168. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#createPartition(io.milvus.param.partition.CreatePartitionParam)">MilvusClient</a></code></span></div>
  1169. <div class="block">Creates a partition in the specified collection.</div>
  1170. <dl>
  1171. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1172. <dd><code><a href="MilvusClient.html#createPartition(io.milvus.param.partition.CreatePartitionParam)">createPartition</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1173. <dt><span class="paramLabel">Parameters:</span></dt>
  1174. <dd><code>requestParam</code> - <a href="../param/partition/CreatePartitionParam.html" title="class in io.milvus.param.partition"><code>CreatePartitionParam</code></a></dd>
  1175. <dt><span class="returnLabel">Returns:</span></dt>
  1176. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1177. </dl>
  1178. </li>
  1179. </ul>
  1180. <a id="dropPartition(io.milvus.param.partition.DropPartitionParam)">
  1181. <!-- -->
  1182. </a>
  1183. <ul class="blockList">
  1184. <li class="blockList">
  1185. <h4>dropPartition</h4>
  1186. <pre class="methodSignature">public&nbsp;<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;(@NonNull
  1187. @NonNull <a href="../param/partition/DropPartitionParam.html" title="class in io.milvus.param.partition">DropPartitionParam</a>&nbsp;requestParam)</pre>
  1188. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#dropPartition(io.milvus.param.partition.DropPartitionParam)">MilvusClient</a></code></span></div>
  1189. <div class="block">Drops a partition. Note that this method drops all data in this partition
  1190. and the _default partition cannot be dropped.</div>
  1191. <dl>
  1192. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1193. <dd><code><a href="MilvusClient.html#dropPartition(io.milvus.param.partition.DropPartitionParam)">dropPartition</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1194. <dt><span class="paramLabel">Parameters:</span></dt>
  1195. <dd><code>requestParam</code> - <a href="../param/partition/DropPartitionParam.html" title="class in io.milvus.param.partition"><code>DropPartitionParam</code></a></dd>
  1196. <dt><span class="returnLabel">Returns:</span></dt>
  1197. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1198. </dl>
  1199. </li>
  1200. </ul>
  1201. <a id="hasPartition(io.milvus.param.partition.HasPartitionParam)">
  1202. <!-- -->
  1203. </a>
  1204. <ul class="blockList">
  1205. <li class="blockList">
  1206. <h4>hasPartition</h4>
  1207. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;java.lang.Boolean&gt;&nbsp;hasPartition&#8203;(@NonNull
  1208. @NonNull <a href="../param/partition/HasPartitionParam.html" title="class in io.milvus.param.partition">HasPartitionParam</a>&nbsp;requestParam)</pre>
  1209. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#hasPartition(io.milvus.param.partition.HasPartitionParam)">MilvusClient</a></code></span></div>
  1210. <div class="block">Checks if a partition exists in the specified collection.</div>
  1211. <dl>
  1212. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1213. <dd><code><a href="MilvusClient.html#hasPartition(io.milvus.param.partition.HasPartitionParam)">hasPartition</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1214. <dt><span class="paramLabel">Parameters:</span></dt>
  1215. <dd><code>requestParam</code> - <a href="../param/partition/HasPartitionParam.html" title="class in io.milvus.param.partition"><code>HasPartitionParam</code></a></dd>
  1216. <dt><span class="returnLabel">Returns:</span></dt>
  1217. <dd>{status:result code, data: boolean, whether if has collection or not}</dd>
  1218. </dl>
  1219. </li>
  1220. </ul>
  1221. <a id="loadPartitions(io.milvus.param.partition.LoadPartitionsParam)">
  1222. <!-- -->
  1223. </a>
  1224. <ul class="blockList">
  1225. <li class="blockList">
  1226. <h4>loadPartitions</h4>
  1227. <pre class="methodSignature">public&nbsp;<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;(@NonNull
  1228. @NonNull <a href="../param/partition/LoadPartitionsParam.html" title="class in io.milvus.param.partition">LoadPartitionsParam</a>&nbsp;requestParam)</pre>
  1229. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#loadPartitions(io.milvus.param.partition.LoadPartitionsParam)">MilvusClient</a></code></span></div>
  1230. <div class="block">Loads a partition into memory.</div>
  1231. <dl>
  1232. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1233. <dd><code><a href="MilvusClient.html#loadPartitions(io.milvus.param.partition.LoadPartitionsParam)">loadPartitions</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1234. <dt><span class="paramLabel">Parameters:</span></dt>
  1235. <dd><code>requestParam</code> - <a href="../param/partition/LoadPartitionsParam.html" title="class in io.milvus.param.partition"><code>LoadPartitionsParam</code></a></dd>
  1236. <dt><span class="returnLabel">Returns:</span></dt>
  1237. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1238. </dl>
  1239. </li>
  1240. </ul>
  1241. <a id="releasePartitions(io.milvus.param.partition.ReleasePartitionsParam)">
  1242. <!-- -->
  1243. </a>
  1244. <ul class="blockList">
  1245. <li class="blockList">
  1246. <h4>releasePartitions</h4>
  1247. <pre class="methodSignature">public&nbsp;<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;(@NonNull
  1248. @NonNull <a href="../param/partition/ReleasePartitionsParam.html" title="class in io.milvus.param.partition">ReleasePartitionsParam</a>&nbsp;requestParam)</pre>
  1249. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#releasePartitions(io.milvus.param.partition.ReleasePartitionsParam)">MilvusClient</a></code></span></div>
  1250. <div class="block">Releases a partition from memory.</div>
  1251. <dl>
  1252. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1253. <dd><code><a href="MilvusClient.html#releasePartitions(io.milvus.param.partition.ReleasePartitionsParam)">releasePartitions</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1254. <dt><span class="paramLabel">Parameters:</span></dt>
  1255. <dd><code>requestParam</code> - <a href="../param/partition/ReleasePartitionsParam.html" title="class in io.milvus.param.partition"><code>ReleasePartitionsParam</code></a></dd>
  1256. <dt><span class="returnLabel">Returns:</span></dt>
  1257. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1258. </dl>
  1259. </li>
  1260. </ul>
  1261. <a id="getPartitionStatistics(io.milvus.param.partition.GetPartitionStatisticsParam)">
  1262. <!-- -->
  1263. </a>
  1264. <ul class="blockList">
  1265. <li class="blockList">
  1266. <h4>getPartitionStatistics</h4>
  1267. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetPartitionStatisticsResponse&gt;&nbsp;getPartitionStatistics&#8203;(@NonNull
  1268. @NonNull <a href="../param/partition/GetPartitionStatisticsParam.html" title="class in io.milvus.param.partition">GetPartitionStatisticsParam</a>&nbsp;requestParam)</pre>
  1269. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#getPartitionStatistics(io.milvus.param.partition.GetPartitionStatisticsParam)">MilvusClient</a></code></span></div>
  1270. <div class="block">Shows the statistics information of a partition.</div>
  1271. <dl>
  1272. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1273. <dd><code><a href="MilvusClient.html#getPartitionStatistics(io.milvus.param.partition.GetPartitionStatisticsParam)">getPartitionStatistics</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1274. <dt><span class="paramLabel">Parameters:</span></dt>
  1275. <dd><code>requestParam</code> - <a href="../param/partition/GetPartitionStatisticsParam.html" title="class in io.milvus.param.partition"><code>GetPartitionStatisticsParam</code></a></dd>
  1276. <dt><span class="returnLabel">Returns:</span></dt>
  1277. <dd>{status:result code,data:GetPartitionStatisticsResponse{status,stats}}</dd>
  1278. </dl>
  1279. </li>
  1280. </ul>
  1281. <a id="showPartitions(io.milvus.param.partition.ShowPartitionsParam)">
  1282. <!-- -->
  1283. </a>
  1284. <ul class="blockList">
  1285. <li class="blockList">
  1286. <h4>showPartitions</h4>
  1287. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.ShowPartitionsResponse&gt;&nbsp;showPartitions&#8203;(@NonNull
  1288. @NonNull <a href="../param/partition/ShowPartitionsParam.html" title="class in io.milvus.param.partition">ShowPartitionsParam</a>&nbsp;requestParam)</pre>
  1289. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#showPartitions(io.milvus.param.partition.ShowPartitionsParam)">MilvusClient</a></code></span></div>
  1290. <div class="block">Shows all partitions in the specified collection.</div>
  1291. <dl>
  1292. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1293. <dd><code><a href="MilvusClient.html#showPartitions(io.milvus.param.partition.ShowPartitionsParam)">showPartitions</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1294. <dt><span class="paramLabel">Parameters:</span></dt>
  1295. <dd><code>requestParam</code> - <a href="../param/partition/ShowPartitionsParam.html" title="class in io.milvus.param.partition"><code>ShowPartitionsParam</code></a></dd>
  1296. <dt><span class="returnLabel">Returns:</span></dt>
  1297. <dd>{status:result code, data:ShowPartitionsResponse{partition_names,partitionIDs,created_timestamps,created_utc_timestamps}}</dd>
  1298. </dl>
  1299. </li>
  1300. </ul>
  1301. <a id="createAlias(io.milvus.param.alias.CreateAliasParam)">
  1302. <!-- -->
  1303. </a>
  1304. <ul class="blockList">
  1305. <li class="blockList">
  1306. <h4>createAlias</h4>
  1307. <pre class="methodSignature">public&nbsp;<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;(@NonNull
  1308. @NonNull <a href="../param/alias/CreateAliasParam.html" title="class in io.milvus.param.alias">CreateAliasParam</a>&nbsp;requestParam)</pre>
  1309. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#createAlias(io.milvus.param.alias.CreateAliasParam)">MilvusClient</a></code></span></div>
  1310. <div class="block">Creates an alias for a collection.
  1311. Alias can be used in search or query to replace the collection name</div>
  1312. <dl>
  1313. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1314. <dd><code><a href="MilvusClient.html#createAlias(io.milvus.param.alias.CreateAliasParam)">createAlias</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1315. <dt><span class="paramLabel">Parameters:</span></dt>
  1316. <dd><code>requestParam</code> - <a href="../param/alias/CreateAliasParam.html" title="class in io.milvus.param.alias"><code>CreateAliasParam</code></a></dd>
  1317. <dt><span class="returnLabel">Returns:</span></dt>
  1318. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1319. </dl>
  1320. </li>
  1321. </ul>
  1322. <a id="dropAlias(io.milvus.param.alias.DropAliasParam)">
  1323. <!-- -->
  1324. </a>
  1325. <ul class="blockList">
  1326. <li class="blockList">
  1327. <h4>dropAlias</h4>
  1328. <pre class="methodSignature">public&nbsp;<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;(@NonNull
  1329. @NonNull <a href="../param/alias/DropAliasParam.html" title="class in io.milvus.param.alias">DropAliasParam</a>&nbsp;requestParam)</pre>
  1330. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#dropAlias(io.milvus.param.alias.DropAliasParam)">MilvusClient</a></code></span></div>
  1331. <div class="block">Drops an alias for the specified collection.</div>
  1332. <dl>
  1333. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1334. <dd><code><a href="MilvusClient.html#dropAlias(io.milvus.param.alias.DropAliasParam)">dropAlias</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1335. <dt><span class="paramLabel">Parameters:</span></dt>
  1336. <dd><code>requestParam</code> - <a href="../param/alias/DropAliasParam.html" title="class in io.milvus.param.alias"><code>DropAliasParam</code></a></dd>
  1337. <dt><span class="returnLabel">Returns:</span></dt>
  1338. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1339. </dl>
  1340. </li>
  1341. </ul>
  1342. <a id="alterAlias(io.milvus.param.alias.AlterAliasParam)">
  1343. <!-- -->
  1344. </a>
  1345. <ul class="blockList">
  1346. <li class="blockList">
  1347. <h4>alterAlias</h4>
  1348. <pre class="methodSignature">public&nbsp;<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;(@NonNull
  1349. @NonNull <a href="../param/alias/AlterAliasParam.html" title="class in io.milvus.param.alias">AlterAliasParam</a>&nbsp;requestParam)</pre>
  1350. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#alterAlias(io.milvus.param.alias.AlterAliasParam)">MilvusClient</a></code></span></div>
  1351. <div class="block">Alters alias from a collection to another.</div>
  1352. <dl>
  1353. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1354. <dd><code><a href="MilvusClient.html#alterAlias(io.milvus.param.alias.AlterAliasParam)">alterAlias</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1355. <dt><span class="paramLabel">Parameters:</span></dt>
  1356. <dd><code>requestParam</code> - <a href="../param/alias/AlterAliasParam.html" title="class in io.milvus.param.alias"><code>AlterAliasParam</code></a></dd>
  1357. <dt><span class="returnLabel">Returns:</span></dt>
  1358. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1359. </dl>
  1360. </li>
  1361. </ul>
  1362. <a id="listAliases(io.milvus.param.alias.ListAliasesParam)">
  1363. <!-- -->
  1364. </a>
  1365. <ul class="blockList">
  1366. <li class="blockList">
  1367. <h4>listAliases</h4>
  1368. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.ListAliasesResponse&gt;&nbsp;listAliases&#8203;(<a href="../param/alias/ListAliasesParam.html" title="class in io.milvus.param.alias">ListAliasesParam</a>&nbsp;requestParam)</pre>
  1369. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#listAliases(io.milvus.param.alias.ListAliasesParam)">MilvusClient</a></code></span></div>
  1370. <div class="block">List all alias for a collection.</div>
  1371. <dl>
  1372. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1373. <dd><code><a href="MilvusClient.html#listAliases(io.milvus.param.alias.ListAliasesParam)">listAliases</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1374. <dt><span class="paramLabel">Parameters:</span></dt>
  1375. <dd><code>requestParam</code> - <a href="../param/alias/ListAliasesParam.html" title="class in io.milvus.param.alias"><code>ListAliasesParam</code></a></dd>
  1376. <dt><span class="returnLabel">Returns:</span></dt>
  1377. <dd>{status:result code, data:ListAliasesResponse{status, aliases}}</dd>
  1378. </dl>
  1379. </li>
  1380. </ul>
  1381. <a id="createIndex(io.milvus.param.index.CreateIndexParam)">
  1382. <!-- -->
  1383. </a>
  1384. <ul class="blockList">
  1385. <li class="blockList">
  1386. <h4>createIndex</h4>
  1387. <pre class="methodSignature">public&nbsp;<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;(@NonNull
  1388. @NonNull <a href="../param/index/CreateIndexParam.html" title="class in io.milvus.param.index">CreateIndexParam</a>&nbsp;requestParam)</pre>
  1389. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#createIndex(io.milvus.param.index.CreateIndexParam)">MilvusClient</a></code></span></div>
  1390. <div class="block">Creates an index on a vector field in the specified collection.
  1391. Note that index building is an async progress.</div>
  1392. <dl>
  1393. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1394. <dd><code><a href="MilvusClient.html#createIndex(io.milvus.param.index.CreateIndexParam)">createIndex</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1395. <dt><span class="paramLabel">Parameters:</span></dt>
  1396. <dd><code>requestParam</code> - <a href="../param/index/CreateIndexParam.html" title="class in io.milvus.param.index"><code>CreateIndexParam</code></a></dd>
  1397. <dt><span class="returnLabel">Returns:</span></dt>
  1398. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1399. </dl>
  1400. </li>
  1401. </ul>
  1402. <a id="dropIndex(io.milvus.param.index.DropIndexParam)">
  1403. <!-- -->
  1404. </a>
  1405. <ul class="blockList">
  1406. <li class="blockList">
  1407. <h4>dropIndex</h4>
  1408. <pre class="methodSignature">public&nbsp;<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;(@NonNull
  1409. @NonNull <a href="../param/index/DropIndexParam.html" title="class in io.milvus.param.index">DropIndexParam</a>&nbsp;requestParam)</pre>
  1410. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#dropIndex(io.milvus.param.index.DropIndexParam)">MilvusClient</a></code></span></div>
  1411. <div class="block">Drops the index on a vector field in the specified collection.</div>
  1412. <dl>
  1413. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1414. <dd><code><a href="MilvusClient.html#dropIndex(io.milvus.param.index.DropIndexParam)">dropIndex</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1415. <dt><span class="paramLabel">Parameters:</span></dt>
  1416. <dd><code>requestParam</code> - <a href="../param/index/DropIndexParam.html" title="class in io.milvus.param.index"><code>DropIndexParam</code></a></dd>
  1417. <dt><span class="returnLabel">Returns:</span></dt>
  1418. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1419. </dl>
  1420. </li>
  1421. </ul>
  1422. <a id="describeIndex(io.milvus.param.index.DescribeIndexParam)">
  1423. <!-- -->
  1424. </a>
  1425. <ul class="blockList">
  1426. <li class="blockList">
  1427. <h4>describeIndex</h4>
  1428. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.DescribeIndexResponse&gt;&nbsp;describeIndex&#8203;(@NonNull
  1429. @NonNull <a href="../param/index/DescribeIndexParam.html" title="class in io.milvus.param.index">DescribeIndexParam</a>&nbsp;requestParam)</pre>
  1430. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#describeIndex(io.milvus.param.index.DescribeIndexParam)">MilvusClient</a></code></span></div>
  1431. <div class="block">Shows the information of the specified index. Current release of Milvus
  1432. only supports showing latest built index.</div>
  1433. <dl>
  1434. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1435. <dd><code><a href="MilvusClient.html#describeIndex(io.milvus.param.index.DescribeIndexParam)">describeIndex</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1436. <dt><span class="paramLabel">Parameters:</span></dt>
  1437. <dd><code>requestParam</code> - <a href="../param/index/DescribeIndexParam.html" title="class in io.milvus.param.index"><code>DescribeIndexParam</code></a></dd>
  1438. <dt><span class="returnLabel">Returns:</span></dt>
  1439. <dd>{status:result code, data:DescribeIndexResponse{status,index_descriptions}}</dd>
  1440. </dl>
  1441. </li>
  1442. </ul>
  1443. <a id="getIndexState(io.milvus.param.index.GetIndexStateParam)">
  1444. <!-- -->
  1445. </a>
  1446. <ul class="blockList">
  1447. <li class="blockList">
  1448. <h4>getIndexState</h4>
  1449. <pre class="methodSignature">@Deprecated
  1450. public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetIndexStateResponse&gt;&nbsp;getIndexState&#8203;(@NonNull
  1451. @NonNull <a href="../param/index/GetIndexStateParam.html" title="class in io.milvus.param.index">GetIndexStateParam</a>&nbsp;requestParam)</pre>
  1452. <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
  1453. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#getIndexState(io.milvus.param.index.GetIndexStateParam)">MilvusClient</a></code></span></div>
  1454. <div class="block">Shows the index building state(in-progress/finished/failed), and the reason for failure (if any).</div>
  1455. <dl>
  1456. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1457. <dd><code><a href="MilvusClient.html#getIndexState(io.milvus.param.index.GetIndexStateParam)">getIndexState</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1458. <dt><span class="paramLabel">Parameters:</span></dt>
  1459. <dd><code>requestParam</code> - <a href="../param/index/GetIndexStateParam.html" title="class in io.milvus.param.index"><code>GetIndexStateParam</code></a></dd>
  1460. <dt><span class="returnLabel">Returns:</span></dt>
  1461. <dd>{status:result code, data:GetIndexStateResponse{status,state}}</dd>
  1462. </dl>
  1463. </li>
  1464. </ul>
  1465. <a id="getIndexBuildProgress(io.milvus.param.index.GetIndexBuildProgressParam)">
  1466. <!-- -->
  1467. </a>
  1468. <ul class="blockList">
  1469. <li class="blockList">
  1470. <h4>getIndexBuildProgress</h4>
  1471. <pre class="methodSignature">@Deprecated
  1472. public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetIndexBuildProgressResponse&gt;&nbsp;getIndexBuildProgress&#8203;(@NonNull
  1473. @NonNull <a href="../param/index/GetIndexBuildProgressParam.html" title="class in io.milvus.param.index">GetIndexBuildProgressParam</a>&nbsp;requestParam)</pre>
  1474. <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
  1475. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#getIndexBuildProgress(io.milvus.param.index.GetIndexBuildProgressParam)">MilvusClient</a></code></span></div>
  1476. <div class="block">Shows the index building progress, such as how many rows are indexed.</div>
  1477. <dl>
  1478. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1479. <dd><code><a href="MilvusClient.html#getIndexBuildProgress(io.milvus.param.index.GetIndexBuildProgressParam)">getIndexBuildProgress</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1480. <dt><span class="paramLabel">Parameters:</span></dt>
  1481. <dd><code>requestParam</code> - <a href="../param/index/GetIndexBuildProgressParam.html" title="class in io.milvus.param.index"><code>GetIndexBuildProgressParam</code></a></dd>
  1482. <dt><span class="returnLabel">Returns:</span></dt>
  1483. <dd>{status:result code, data:GetIndexBuildProgressResponse{status,indexed_rows}}</dd>
  1484. </dl>
  1485. </li>
  1486. </ul>
  1487. <a id="alterIndex(io.milvus.param.index.AlterIndexParam)">
  1488. <!-- -->
  1489. </a>
  1490. <ul class="blockList">
  1491. <li class="blockList">
  1492. <h4>alterIndex</h4>
  1493. <pre class="methodSignature">public&nbsp;<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;alterIndex&#8203;(<a href="../param/index/AlterIndexParam.html" title="class in io.milvus.param.index">AlterIndexParam</a>&nbsp;requestParam)</pre>
  1494. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#alterIndex(io.milvus.param.index.AlterIndexParam)">MilvusClient</a></code></span></div>
  1495. <div class="block">Alter index with key value properties.</div>
  1496. <dl>
  1497. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1498. <dd><code><a href="MilvusClient.html#alterIndex(io.milvus.param.index.AlterIndexParam)">alterIndex</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1499. <dt><span class="paramLabel">Parameters:</span></dt>
  1500. <dd><code>requestParam</code> - <a href="../param/index/AlterIndexParam.html" title="class in io.milvus.param.index"><code>AlterIndexParam</code></a></dd>
  1501. <dt><span class="returnLabel">Returns:</span></dt>
  1502. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1503. </dl>
  1504. </li>
  1505. </ul>
  1506. <a id="delete(io.milvus.param.dml.DeleteParam)">
  1507. <!-- -->
  1508. </a>
  1509. <ul class="blockList">
  1510. <li class="blockList">
  1511. <h4>delete</h4>
  1512. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.MutationResult&gt;&nbsp;delete&#8203;(@NonNull
  1513. @NonNull <a href="../param/dml/DeleteParam.html" title="class in io.milvus.param.dml">DeleteParam</a>&nbsp;requestParam)</pre>
  1514. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#delete(io.milvus.param.dml.DeleteParam)">MilvusClient</a></code></span></div>
  1515. <div class="block">Deletes entity(s) based on primary key(s) filtered by boolean expression. Current release
  1516. of Milvus only supports expression in the format "pk_field in [1, 2, ...]"</div>
  1517. <dl>
  1518. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1519. <dd><code><a href="MilvusClient.html#delete(io.milvus.param.dml.DeleteParam)">delete</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1520. <dt><span class="paramLabel">Parameters:</span></dt>
  1521. <dd><code>requestParam</code> - <a href="../param/dml/DeleteParam.html" title="class in io.milvus.param.dml"><code>DeleteParam</code></a></dd>
  1522. <dt><span class="returnLabel">Returns:</span></dt>
  1523. <dd>{status:result code, data: MutationResult{delete results}}</dd>
  1524. </dl>
  1525. </li>
  1526. </ul>
  1527. <a id="insert(io.milvus.param.dml.InsertParam)">
  1528. <!-- -->
  1529. </a>
  1530. <ul class="blockList">
  1531. <li class="blockList">
  1532. <h4>insert</h4>
  1533. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.MutationResult&gt;&nbsp;insert&#8203;(@NonNull
  1534. @NonNull <a href="../param/dml/InsertParam.html" title="class in io.milvus.param.dml">InsertParam</a>&nbsp;requestParam)</pre>
  1535. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#insert(io.milvus.param.dml.InsertParam)">MilvusClient</a></code></span></div>
  1536. <div class="block">Inserts entities into a specified collection . Note that you don't need to
  1537. input primary key field if auto_id is enabled.</div>
  1538. <dl>
  1539. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1540. <dd><code><a href="MilvusClient.html#insert(io.milvus.param.dml.InsertParam)">insert</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1541. <dt><span class="paramLabel">Parameters:</span></dt>
  1542. <dd><code>requestParam</code> - <a href="../param/dml/InsertParam.html" title="class in io.milvus.param.dml"><code>InsertParam</code></a></dd>
  1543. <dt><span class="returnLabel">Returns:</span></dt>
  1544. <dd>{status:result code, data: MutationResult{insert results}}</dd>
  1545. </dl>
  1546. </li>
  1547. </ul>
  1548. <a id="insertAsync(io.milvus.param.dml.InsertParam)">
  1549. <!-- -->
  1550. </a>
  1551. <ul class="blockList">
  1552. <li class="blockList">
  1553. <h4>insertAsync</h4>
  1554. <pre class="methodSignature">public&nbsp;com.google.common.util.concurrent.ListenableFuture&lt;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.MutationResult&gt;&gt;&nbsp;insertAsync&#8203;(<a href="../param/dml/InsertParam.html" title="class in io.milvus.param.dml">InsertParam</a>&nbsp;requestParam)</pre>
  1555. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#insertAsync(io.milvus.param.dml.InsertParam)">MilvusClient</a></code></span></div>
  1556. <div class="block">Inserts entities into a specified collection asynchronously. Note that you don't need to
  1557. input primary key field if auto_id is enabled.</div>
  1558. <dl>
  1559. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1560. <dd><code><a href="MilvusClient.html#insertAsync(io.milvus.param.dml.InsertParam)">insertAsync</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1561. <dt><span class="paramLabel">Parameters:</span></dt>
  1562. <dd><code>requestParam</code> - <a href="../param/dml/InsertParam.html" title="class in io.milvus.param.dml"><code>InsertParam</code></a></dd>
  1563. <dt><span class="returnLabel">Returns:</span></dt>
  1564. <dd>a <code>ListenableFuture</code> object which holds the object {status:result code, data: MutationResult{insert results}}</dd>
  1565. </dl>
  1566. </li>
  1567. </ul>
  1568. <a id="upsert(io.milvus.param.dml.UpsertParam)">
  1569. <!-- -->
  1570. </a>
  1571. <ul class="blockList">
  1572. <li class="blockList">
  1573. <h4>upsert</h4>
  1574. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.MutationResult&gt;&nbsp;upsert&#8203;(<a href="../param/dml/UpsertParam.html" title="class in io.milvus.param.dml">UpsertParam</a>&nbsp;requestParam)</pre>
  1575. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#upsert(io.milvus.param.dml.UpsertParam)">MilvusClient</a></code></span></div>
  1576. <div class="block">Insert new entities into a specified collection, replace them if the entities already exist.</div>
  1577. <dl>
  1578. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1579. <dd><code><a href="MilvusClient.html#upsert(io.milvus.param.dml.UpsertParam)">upsert</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1580. <dt><span class="paramLabel">Parameters:</span></dt>
  1581. <dd><code>requestParam</code> - <a href="../param/dml/UpsertParam.html" title="class in io.milvus.param.dml"><code>UpsertParam</code></a></dd>
  1582. <dt><span class="returnLabel">Returns:</span></dt>
  1583. <dd>{status:result code, data: MutationResult{insert results}}</dd>
  1584. </dl>
  1585. </li>
  1586. </ul>
  1587. <a id="upsertAsync(io.milvus.param.dml.UpsertParam)">
  1588. <!-- -->
  1589. </a>
  1590. <ul class="blockList">
  1591. <li class="blockList">
  1592. <h4>upsertAsync</h4>
  1593. <pre class="methodSignature">public&nbsp;com.google.common.util.concurrent.ListenableFuture&lt;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.MutationResult&gt;&gt;&nbsp;upsertAsync&#8203;(<a href="../param/dml/UpsertParam.html" title="class in io.milvus.param.dml">UpsertParam</a>&nbsp;requestParam)</pre>
  1594. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#upsertAsync(io.milvus.param.dml.UpsertParam)">MilvusClient</a></code></span></div>
  1595. <div class="block">Insert new entities into a specified collection asynchronously, replace them if the entities already exist.</div>
  1596. <dl>
  1597. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1598. <dd><code><a href="MilvusClient.html#upsertAsync(io.milvus.param.dml.UpsertParam)">upsertAsync</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1599. <dt><span class="paramLabel">Parameters:</span></dt>
  1600. <dd><code>requestParam</code> - <a href="../param/dml/UpsertParam.html" title="class in io.milvus.param.dml"><code>UpsertParam</code></a></dd>
  1601. <dt><span class="returnLabel">Returns:</span></dt>
  1602. <dd>a <code>ListenableFuture</code> object which holds the object {status:result code, data: MutationResult{insert results}}</dd>
  1603. </dl>
  1604. </li>
  1605. </ul>
  1606. <a id="search(io.milvus.param.dml.SearchParam)">
  1607. <!-- -->
  1608. </a>
  1609. <ul class="blockList">
  1610. <li class="blockList">
  1611. <h4>search</h4>
  1612. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.SearchResults&gt;&nbsp;search&#8203;(@NonNull
  1613. @NonNull <a href="../param/dml/SearchParam.html" title="class in io.milvus.param.dml">SearchParam</a>&nbsp;requestParam)</pre>
  1614. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#search(io.milvus.param.dml.SearchParam)">MilvusClient</a></code></span></div>
  1615. <div class="block">Conducts ANN search on a vector field. Use expression to do filtering before search.</div>
  1616. <dl>
  1617. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1618. <dd><code><a href="MilvusClient.html#search(io.milvus.param.dml.SearchParam)">search</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1619. <dt><span class="paramLabel">Parameters:</span></dt>
  1620. <dd><code>requestParam</code> - <a href="../param/dml/SearchParam.html" title="class in io.milvus.param.dml"><code>SearchParam</code></a></dd>
  1621. <dt><span class="returnLabel">Returns:</span></dt>
  1622. <dd>{status:result code, data: SearchResults{topK results}}</dd>
  1623. </dl>
  1624. </li>
  1625. </ul>
  1626. <a id="searchAsync(io.milvus.param.dml.SearchParam)">
  1627. <!-- -->
  1628. </a>
  1629. <ul class="blockList">
  1630. <li class="blockList">
  1631. <h4>searchAsync</h4>
  1632. <pre class="methodSignature">public&nbsp;com.google.common.util.concurrent.ListenableFuture&lt;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.SearchResults&gt;&gt;&nbsp;searchAsync&#8203;(<a href="../param/dml/SearchParam.html" title="class in io.milvus.param.dml">SearchParam</a>&nbsp;requestParam)</pre>
  1633. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#searchAsync(io.milvus.param.dml.SearchParam)">MilvusClient</a></code></span></div>
  1634. <div class="block">Conducts ANN search on a vector field asynchronously. Use expression to do filtering before search.</div>
  1635. <dl>
  1636. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1637. <dd><code><a href="MilvusClient.html#searchAsync(io.milvus.param.dml.SearchParam)">searchAsync</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1638. <dt><span class="paramLabel">Parameters:</span></dt>
  1639. <dd><code>requestParam</code> - <a href="../param/dml/SearchParam.html" title="class in io.milvus.param.dml"><code>SearchParam</code></a></dd>
  1640. <dt><span class="returnLabel">Returns:</span></dt>
  1641. <dd>a <code>ListenableFuture</code> object which holds the object {status:result code, data: SearchResults{topK results}}</dd>
  1642. </dl>
  1643. </li>
  1644. </ul>
  1645. <a id="hybridSearch(io.milvus.param.dml.HybridSearchParam)">
  1646. <!-- -->
  1647. </a>
  1648. <ul class="blockList">
  1649. <li class="blockList">
  1650. <h4>hybridSearch</h4>
  1651. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.SearchResults&gt;&nbsp;hybridSearch&#8203;(<a href="../param/dml/HybridSearchParam.html" title="class in io.milvus.param.dml">HybridSearchParam</a>&nbsp;requestParam)</pre>
  1652. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#hybridSearch(io.milvus.param.dml.HybridSearchParam)">MilvusClient</a></code></span></div>
  1653. <div class="block">Conducts multi vector similarity search with a ranker for rearrangement.</div>
  1654. <dl>
  1655. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1656. <dd><code><a href="MilvusClient.html#hybridSearch(io.milvus.param.dml.HybridSearchParam)">hybridSearch</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1657. <dt><span class="paramLabel">Parameters:</span></dt>
  1658. <dd><code>requestParam</code> - <a href="../param/dml/HybridSearchParam.html" title="class in io.milvus.param.dml"><code>HybridSearchParam</code></a></dd>
  1659. <dt><span class="returnLabel">Returns:</span></dt>
  1660. <dd>{status:result code, data: SearchResults{topK results}}</dd>
  1661. </dl>
  1662. </li>
  1663. </ul>
  1664. <a id="hybridSearchAsync(io.milvus.param.dml.HybridSearchParam)">
  1665. <!-- -->
  1666. </a>
  1667. <ul class="blockList">
  1668. <li class="blockList">
  1669. <h4>hybridSearchAsync</h4>
  1670. <pre class="methodSignature">public&nbsp;com.google.common.util.concurrent.ListenableFuture&lt;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.SearchResults&gt;&gt;&nbsp;hybridSearchAsync&#8203;(<a href="../param/dml/HybridSearchParam.html" title="class in io.milvus.param.dml">HybridSearchParam</a>&nbsp;requestParam)</pre>
  1671. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#hybridSearchAsync(io.milvus.param.dml.HybridSearchParam)">MilvusClient</a></code></span></div>
  1672. <div class="block">Conducts multi vector similarity search asynchronously with a ranker for rearrangement.</div>
  1673. <dl>
  1674. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1675. <dd><code><a href="MilvusClient.html#hybridSearchAsync(io.milvus.param.dml.HybridSearchParam)">hybridSearchAsync</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1676. <dt><span class="paramLabel">Parameters:</span></dt>
  1677. <dd><code>requestParam</code> - <a href="../param/dml/HybridSearchParam.html" title="class in io.milvus.param.dml"><code>HybridSearchParam</code></a></dd>
  1678. <dt><span class="returnLabel">Returns:</span></dt>
  1679. <dd>a <code>ListenableFuture</code> object which holds the object {status:result code, data: SearchResults{topK results}}</dd>
  1680. </dl>
  1681. </li>
  1682. </ul>
  1683. <a id="query(io.milvus.param.dml.QueryParam)">
  1684. <!-- -->
  1685. </a>
  1686. <ul class="blockList">
  1687. <li class="blockList">
  1688. <h4>query</h4>
  1689. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.QueryResults&gt;&nbsp;query&#8203;(@NonNull
  1690. @NonNull <a href="../param/dml/QueryParam.html" title="class in io.milvus.param.dml">QueryParam</a>&nbsp;requestParam)</pre>
  1691. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#query(io.milvus.param.dml.QueryParam)">MilvusClient</a></code></span></div>
  1692. <div class="block">Queries entity(s) based on scalar field(s) filtered by boolean expression.
  1693. Note that the order of the returned entities cannot be guaranteed.</div>
  1694. <dl>
  1695. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1696. <dd><code><a href="MilvusClient.html#query(io.milvus.param.dml.QueryParam)">query</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1697. <dt><span class="paramLabel">Parameters:</span></dt>
  1698. <dd><code>requestParam</code> - <a href="../param/dml/QueryParam.html" title="class in io.milvus.param.dml"><code>QueryParam</code></a></dd>
  1699. <dt><span class="returnLabel">Returns:</span></dt>
  1700. <dd>{status:result code,data: QueryResults{filter results}}</dd>
  1701. </dl>
  1702. </li>
  1703. </ul>
  1704. <a id="queryAsync(io.milvus.param.dml.QueryParam)">
  1705. <!-- -->
  1706. </a>
  1707. <ul class="blockList">
  1708. <li class="blockList">
  1709. <h4>queryAsync</h4>
  1710. <pre class="methodSignature">public&nbsp;com.google.common.util.concurrent.ListenableFuture&lt;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.QueryResults&gt;&gt;&nbsp;queryAsync&#8203;(<a href="../param/dml/QueryParam.html" title="class in io.milvus.param.dml">QueryParam</a>&nbsp;requestParam)</pre>
  1711. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#queryAsync(io.milvus.param.dml.QueryParam)">MilvusClient</a></code></span></div>
  1712. <div class="block">Queries entity(s) asynchronously based on scalar field(s) filtered by boolean expression.
  1713. Note that the order of the returned entities cannot be guaranteed.</div>
  1714. <dl>
  1715. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1716. <dd><code><a href="MilvusClient.html#queryAsync(io.milvus.param.dml.QueryParam)">queryAsync</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1717. <dt><span class="paramLabel">Parameters:</span></dt>
  1718. <dd><code>requestParam</code> - <a href="../param/dml/QueryParam.html" title="class in io.milvus.param.dml"><code>QueryParam</code></a></dd>
  1719. <dt><span class="returnLabel">Returns:</span></dt>
  1720. <dd>{status:result code,data: QueryResults{filter results}}</dd>
  1721. </dl>
  1722. </li>
  1723. </ul>
  1724. <a id="getMetrics(io.milvus.param.control.GetMetricsParam)">
  1725. <!-- -->
  1726. </a>
  1727. <ul class="blockList">
  1728. <li class="blockList">
  1729. <h4>getMetrics</h4>
  1730. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetMetricsResponse&gt;&nbsp;getMetrics&#8203;(@NonNull
  1731. @NonNull <a href="../param/control/GetMetricsParam.html" title="class in io.milvus.param.control">GetMetricsParam</a>&nbsp;requestParam)</pre>
  1732. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#getMetrics(io.milvus.param.control.GetMetricsParam)">MilvusClient</a></code></span></div>
  1733. <div class="block">Gets the runtime metrics information of Milvus, returns the result in .json format.</div>
  1734. <dl>
  1735. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1736. <dd><code><a href="MilvusClient.html#getMetrics(io.milvus.param.control.GetMetricsParam)">getMetrics</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1737. <dt><span class="paramLabel">Parameters:</span></dt>
  1738. <dd><code>requestParam</code> - <a href="../param/control/GetMetricsParam.html" title="class in io.milvus.param.control"><code>GetMetricsParam</code></a></dd>
  1739. <dt><span class="returnLabel">Returns:</span></dt>
  1740. <dd>{status:result code, data:GetMetricsResponse{status,metrics}}</dd>
  1741. </dl>
  1742. </li>
  1743. </ul>
  1744. <a id="getFlushState(io.milvus.param.control.GetFlushStateParam)">
  1745. <!-- -->
  1746. </a>
  1747. <ul class="blockList">
  1748. <li class="blockList">
  1749. <h4>getFlushState</h4>
  1750. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetFlushStateResponse&gt;&nbsp;getFlushState&#8203;(@NonNull
  1751. @NonNull <a href="../param/control/GetFlushStateParam.html" title="class in io.milvus.param.control">GetFlushStateParam</a>&nbsp;requestParam)</pre>
  1752. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#getFlushState(io.milvus.param.control.GetFlushStateParam)">MilvusClient</a></code></span></div>
  1753. <div class="block">Get flush state of specified collection.</div>
  1754. <dl>
  1755. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1756. <dd><code><a href="MilvusClient.html#getFlushState(io.milvus.param.control.GetFlushStateParam)">getFlushState</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1757. <dt><span class="paramLabel">Parameters:</span></dt>
  1758. <dd><code>requestParam</code> - <a href="../param/control/GetFlushStateParam.html" title="class in io.milvus.param.control"><code>GetFlushStateParam</code></a></dd>
  1759. <dt><span class="returnLabel">Returns:</span></dt>
  1760. <dd>{status:result code, data:GetMetricsResponse{status,metrics}}</dd>
  1761. </dl>
  1762. </li>
  1763. </ul>
  1764. <a id="getFlushAllState(io.milvus.param.control.GetFlushAllStateParam)">
  1765. <!-- -->
  1766. </a>
  1767. <ul class="blockList">
  1768. <li class="blockList">
  1769. <h4>getFlushAllState</h4>
  1770. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetFlushAllStateResponse&gt;&nbsp;getFlushAllState&#8203;(<a href="../param/control/GetFlushAllStateParam.html" title="class in io.milvus.param.control">GetFlushAllStateParam</a>&nbsp;requestParam)</pre>
  1771. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#getFlushAllState(io.milvus.param.control.GetFlushAllStateParam)">MilvusClient</a></code></span></div>
  1772. <div class="block">Get flush state of all segments.</div>
  1773. <dl>
  1774. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1775. <dd><code><a href="MilvusClient.html#getFlushAllState(io.milvus.param.control.GetFlushAllStateParam)">getFlushAllState</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1776. <dt><span class="paramLabel">Parameters:</span></dt>
  1777. <dd><code>requestParam</code> - <a href="../param/control/GetFlushAllStateParam.html" title="class in io.milvus.param.control"><code>GetFlushAllStateParam</code></a></dd>
  1778. <dt><span class="returnLabel">Returns:</span></dt>
  1779. <dd>{status:result code, data:GetMetricsResponse{status,metrics}}</dd>
  1780. </dl>
  1781. </li>
  1782. </ul>
  1783. <a id="getPersistentSegmentInfo(io.milvus.param.control.GetPersistentSegmentInfoParam)">
  1784. <!-- -->
  1785. </a>
  1786. <ul class="blockList">
  1787. <li class="blockList">
  1788. <h4>getPersistentSegmentInfo</h4>
  1789. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetPersistentSegmentInfoResponse&gt;&nbsp;getPersistentSegmentInfo&#8203;(@NonNull
  1790. @NonNull <a href="../param/control/GetPersistentSegmentInfoParam.html" title="class in io.milvus.param.control">GetPersistentSegmentInfoParam</a>&nbsp;requestParam)</pre>
  1791. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#getPersistentSegmentInfo(io.milvus.param.control.GetPersistentSegmentInfoParam)">MilvusClient</a></code></span></div>
  1792. <div class="block">Gets the information of persistent segments from data node, including row count,
  1793. persistence state(growing or flushed), etc.</div>
  1794. <dl>
  1795. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1796. <dd><code><a href="MilvusClient.html#getPersistentSegmentInfo(io.milvus.param.control.GetPersistentSegmentInfoParam)">getPersistentSegmentInfo</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1797. <dt><span class="paramLabel">Parameters:</span></dt>
  1798. <dd><code>requestParam</code> - <a href="../param/control/GetPersistentSegmentInfoParam.html" title="class in io.milvus.param.control"><code>GetPersistentSegmentInfoParam</code></a></dd>
  1799. <dt><span class="returnLabel">Returns:</span></dt>
  1800. <dd>{status:result code, data:GetPersistentSegmentInfoResponse{status,info}}</dd>
  1801. </dl>
  1802. </li>
  1803. </ul>
  1804. <a id="getQuerySegmentInfo(io.milvus.param.control.GetQuerySegmentInfoParam)">
  1805. <!-- -->
  1806. </a>
  1807. <ul class="blockList">
  1808. <li class="blockList">
  1809. <h4>getQuerySegmentInfo</h4>
  1810. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetQuerySegmentInfoResponse&gt;&nbsp;getQuerySegmentInfo&#8203;(@NonNull
  1811. @NonNull <a href="../param/control/GetQuerySegmentInfoParam.html" title="class in io.milvus.param.control">GetQuerySegmentInfoParam</a>&nbsp;requestParam)</pre>
  1812. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#getQuerySegmentInfo(io.milvus.param.control.GetQuerySegmentInfoParam)">MilvusClient</a></code></span></div>
  1813. <div class="block">Gets the query information of segments in a collection from query node, including row count,
  1814. memory usage size, index name, etc.</div>
  1815. <dl>
  1816. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1817. <dd><code><a href="MilvusClient.html#getQuerySegmentInfo(io.milvus.param.control.GetQuerySegmentInfoParam)">getQuerySegmentInfo</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1818. <dt><span class="paramLabel">Parameters:</span></dt>
  1819. <dd><code>requestParam</code> - <a href="../param/control/GetQuerySegmentInfoParam.html" title="class in io.milvus.param.control"><code>GetQuerySegmentInfoParam</code></a></dd>
  1820. <dt><span class="returnLabel">Returns:</span></dt>
  1821. <dd>{status:result code, data:GetQuerySegmentInfoResponse{status,info}}</dd>
  1822. </dl>
  1823. </li>
  1824. </ul>
  1825. <a id="getReplicas(io.milvus.param.control.GetReplicasParam)">
  1826. <!-- -->
  1827. </a>
  1828. <ul class="blockList">
  1829. <li class="blockList">
  1830. <h4>getReplicas</h4>
  1831. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetReplicasResponse&gt;&nbsp;getReplicas&#8203;(<a href="../param/control/GetReplicasParam.html" title="class in io.milvus.param.control">GetReplicasParam</a>&nbsp;requestParam)</pre>
  1832. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#getReplicas(io.milvus.param.control.GetReplicasParam)">MilvusClient</a></code></span></div>
  1833. <div class="block">Returns the collection's replica information</div>
  1834. <dl>
  1835. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1836. <dd><code><a href="MilvusClient.html#getReplicas(io.milvus.param.control.GetReplicasParam)">getReplicas</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1837. <dt><span class="paramLabel">Parameters:</span></dt>
  1838. <dd><code>requestParam</code> - <a href="../param/control/GetReplicasParam.html" title="class in io.milvus.param.control"><code>GetReplicasParam</code></a></dd>
  1839. <dt><span class="returnLabel">Returns:</span></dt>
  1840. <dd>{status:result code, data:GetReplicasResponse{status,info}}</dd>
  1841. </dl>
  1842. </li>
  1843. </ul>
  1844. <a id="loadBalance(io.milvus.param.control.LoadBalanceParam)">
  1845. <!-- -->
  1846. </a>
  1847. <ul class="blockList">
  1848. <li class="blockList">
  1849. <h4>loadBalance</h4>
  1850. <pre class="methodSignature">public&nbsp;<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>
  1851. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#loadBalance(io.milvus.param.control.LoadBalanceParam)">MilvusClient</a></code></span></div>
  1852. <div class="block">Moves segment from a query node to another to keep the load balanced.</div>
  1853. <dl>
  1854. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1855. <dd><code><a href="MilvusClient.html#loadBalance(io.milvus.param.control.LoadBalanceParam)">loadBalance</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1856. <dt><span class="paramLabel">Parameters:</span></dt>
  1857. <dd><code>requestParam</code> - <a href="../param/control/LoadBalanceParam.html" title="class in io.milvus.param.control"><code>LoadBalanceParam</code></a></dd>
  1858. <dt><span class="returnLabel">Returns:</span></dt>
  1859. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1860. </dl>
  1861. </li>
  1862. </ul>
  1863. <a id="getCompactionState(io.milvus.param.control.GetCompactionStateParam)">
  1864. <!-- -->
  1865. </a>
  1866. <ul class="blockList">
  1867. <li class="blockList">
  1868. <h4>getCompactionState</h4>
  1869. <pre class="methodSignature">public&nbsp;<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>
  1870. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#getCompactionState(io.milvus.param.control.GetCompactionStateParam)">MilvusClient</a></code></span></div>
  1871. <div class="block">Gets the compaction state by id.</div>
  1872. <dl>
  1873. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1874. <dd><code><a href="MilvusClient.html#getCompactionState(io.milvus.param.control.GetCompactionStateParam)">getCompactionState</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1875. <dt><span class="paramLabel">Parameters:</span></dt>
  1876. <dd><code>requestParam</code> - <a href="../param/control/GetCompactionStateParam.html" title="class in io.milvus.param.control"><code>GetCompactionStateParam</code></a></dd>
  1877. <dt><span class="returnLabel">Returns:</span></dt>
  1878. <dd>{status:result code, data:GetCompactionStateResponse{status,info}}</dd>
  1879. </dl>
  1880. </li>
  1881. </ul>
  1882. <a id="manualCompact(io.milvus.param.control.ManualCompactParam)">
  1883. <!-- -->
  1884. </a>
  1885. <ul class="blockList">
  1886. <li class="blockList">
  1887. <h4>manualCompact</h4>
  1888. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.ManualCompactionResponse&gt;&nbsp;manualCompact&#8203;(<a href="../param/control/ManualCompactParam.html" title="class in io.milvus.param.control">ManualCompactParam</a>&nbsp;requestParam)</pre>
  1889. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#manualCompact(io.milvus.param.control.ManualCompactParam)">MilvusClient</a></code></span></div>
  1890. <div class="block">Performs a manual compaction.</div>
  1891. <dl>
  1892. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1893. <dd><code><a href="MilvusClient.html#manualCompact(io.milvus.param.control.ManualCompactParam)">manualCompact</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1894. <dt><span class="paramLabel">Parameters:</span></dt>
  1895. <dd><code>requestParam</code> - <a href="../param/control/ManualCompactParam.html" title="class in io.milvus.param.control"><code>ManualCompactParam</code></a></dd>
  1896. <dt><span class="returnLabel">Returns:</span></dt>
  1897. <dd>{status:result code, data:ManualCompactionResponse{status,info}}</dd>
  1898. </dl>
  1899. </li>
  1900. </ul>
  1901. <a id="getCompactionStateWithPlans(io.milvus.param.control.GetCompactionPlansParam)">
  1902. <!-- -->
  1903. </a>
  1904. <ul class="blockList">
  1905. <li class="blockList">
  1906. <h4>getCompactionStateWithPlans</h4>
  1907. <pre class="methodSignature">public&nbsp;<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>
  1908. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#getCompactionStateWithPlans(io.milvus.param.control.GetCompactionPlansParam)">MilvusClient</a></code></span></div>
  1909. <div class="block">Gets compaction state with its plan.</div>
  1910. <dl>
  1911. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1912. <dd><code><a href="MilvusClient.html#getCompactionStateWithPlans(io.milvus.param.control.GetCompactionPlansParam)">getCompactionStateWithPlans</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1913. <dt><span class="paramLabel">Parameters:</span></dt>
  1914. <dd><code>requestParam</code> - <a href="../param/control/GetCompactionPlansParam.html" title="class in io.milvus.param.control"><code>GetCompactionPlansParam</code></a></dd>
  1915. <dt><span class="returnLabel">Returns:</span></dt>
  1916. <dd>{status:result code, data:GetCompactionPlansResponse{status,info}}</dd>
  1917. </dl>
  1918. </li>
  1919. </ul>
  1920. <a id="createCredential(io.milvus.param.credential.CreateCredentialParam)">
  1921. <!-- -->
  1922. </a>
  1923. <ul class="blockList">
  1924. <li class="blockList">
  1925. <h4>createCredential</h4>
  1926. <pre class="methodSignature">public&nbsp;<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;createCredential&#8203;(<a href="../param/credential/CreateCredentialParam.html" title="class in io.milvus.param.credential">CreateCredentialParam</a>&nbsp;requestParam)</pre>
  1927. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#createCredential(io.milvus.param.credential.CreateCredentialParam)">MilvusClient</a></code></span></div>
  1928. <div class="block">Create credential using the given user and password.</div>
  1929. <dl>
  1930. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1931. <dd><code><a href="MilvusClient.html#createCredential(io.milvus.param.credential.CreateCredentialParam)">createCredential</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1932. <dt><span class="paramLabel">Parameters:</span></dt>
  1933. <dd><code>requestParam</code> - <a href="../param/credential/CreateCredentialParam.html" title="class in io.milvus.param.credential"><code>CreateCredentialParam</code></a></dd>
  1934. <dt><span class="returnLabel">Returns:</span></dt>
  1935. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1936. </dl>
  1937. </li>
  1938. </ul>
  1939. <a id="updateCredential(io.milvus.param.credential.UpdateCredentialParam)">
  1940. <!-- -->
  1941. </a>
  1942. <ul class="blockList">
  1943. <li class="blockList">
  1944. <h4>updateCredential</h4>
  1945. <pre class="methodSignature">public&nbsp;<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;updateCredential&#8203;(<a href="../param/credential/UpdateCredentialParam.html" title="class in io.milvus.param.credential">UpdateCredentialParam</a>&nbsp;requestParam)</pre>
  1946. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#updateCredential(io.milvus.param.credential.UpdateCredentialParam)">MilvusClient</a></code></span></div>
  1947. <div class="block">Update credential using the given user and password.
  1948. You must provide the original password to check if the operation is valid.
  1949. Note: after this operation, client won't change the related header of this connection.
  1950. So if you update credential for this connection, the connection may be invalid.</div>
  1951. <dl>
  1952. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1953. <dd><code><a href="MilvusClient.html#updateCredential(io.milvus.param.credential.UpdateCredentialParam)">updateCredential</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1954. <dt><span class="paramLabel">Parameters:</span></dt>
  1955. <dd><code>requestParam</code> - <a href="../param/credential/UpdateCredentialParam.html" title="class in io.milvus.param.credential"><code>UpdateCredentialParam</code></a></dd>
  1956. <dt><span class="returnLabel">Returns:</span></dt>
  1957. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1958. </dl>
  1959. </li>
  1960. </ul>
  1961. <a id="deleteCredential(io.milvus.param.credential.DeleteCredentialParam)">
  1962. <!-- -->
  1963. </a>
  1964. <ul class="blockList">
  1965. <li class="blockList">
  1966. <h4>deleteCredential</h4>
  1967. <pre class="methodSignature">public&nbsp;<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;deleteCredential&#8203;(<a href="../param/credential/DeleteCredentialParam.html" title="class in io.milvus.param.credential">DeleteCredentialParam</a>&nbsp;requestParam)</pre>
  1968. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#deleteCredential(io.milvus.param.credential.DeleteCredentialParam)">MilvusClient</a></code></span></div>
  1969. <div class="block">Delete credential corresponding to the user.</div>
  1970. <dl>
  1971. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1972. <dd><code><a href="MilvusClient.html#deleteCredential(io.milvus.param.credential.DeleteCredentialParam)">deleteCredential</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1973. <dt><span class="paramLabel">Parameters:</span></dt>
  1974. <dd><code>requestParam</code> - <a href="../param/credential/DeleteCredentialParam.html" title="class in io.milvus.param.credential"><code>DeleteCredentialParam</code></a></dd>
  1975. <dt><span class="returnLabel">Returns:</span></dt>
  1976. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1977. </dl>
  1978. </li>
  1979. </ul>
  1980. <a id="listCredUsers(io.milvus.param.credential.ListCredUsersParam)">
  1981. <!-- -->
  1982. </a>
  1983. <ul class="blockList">
  1984. <li class="blockList">
  1985. <h4>listCredUsers</h4>
  1986. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.ListCredUsersResponse&gt;&nbsp;listCredUsers&#8203;(<a href="../param/credential/ListCredUsersParam.html" title="class in io.milvus.param.credential">ListCredUsersParam</a>&nbsp;requestParam)</pre>
  1987. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#listCredUsers(io.milvus.param.credential.ListCredUsersParam)">MilvusClient</a></code></span></div>
  1988. <div class="block">List all user names.</div>
  1989. <dl>
  1990. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1991. <dd><code><a href="MilvusClient.html#listCredUsers(io.milvus.param.credential.ListCredUsersParam)">listCredUsers</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1992. <dt><span class="paramLabel">Parameters:</span></dt>
  1993. <dd><code>requestParam</code> - <a href="../param/credential/ListCredUsersParam.html" title="class in io.milvus.param.credential"><code>ListCredUsersParam</code></a></dd>
  1994. <dt><span class="returnLabel">Returns:</span></dt>
  1995. <dd>{status:result code, data:ListCredUsersResponse{status,info}}</dd>
  1996. </dl>
  1997. </li>
  1998. </ul>
  1999. <a id="addUserToRole(io.milvus.param.role.AddUserToRoleParam)">
  2000. <!-- -->
  2001. </a>
  2002. <ul class="blockList">
  2003. <li class="blockList">
  2004. <h4>addUserToRole</h4>
  2005. <pre class="methodSignature">public&nbsp;<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;addUserToRole&#8203;(<a href="../param/role/AddUserToRoleParam.html" title="class in io.milvus.param.role">AddUserToRoleParam</a>&nbsp;requestParam)</pre>
  2006. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#addUserToRole(io.milvus.param.role.AddUserToRoleParam)">MilvusClient</a></code></span></div>
  2007. <div class="block">The user will get permissions that the role are allowed to perform operations.</div>
  2008. <dl>
  2009. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2010. <dd><code><a href="MilvusClient.html#addUserToRole(io.milvus.param.role.AddUserToRoleParam)">addUserToRole</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  2011. <dt><span class="paramLabel">Parameters:</span></dt>
  2012. <dd><code>requestParam</code> - <a href="../param/role/AddUserToRoleParam.html" title="class in io.milvus.param.role"><code>AddUserToRoleParam</code></a></dd>
  2013. <dt><span class="returnLabel">Returns:</span></dt>
  2014. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  2015. </dl>
  2016. </li>
  2017. </ul>
  2018. <a id="removeUserFromRole(io.milvus.param.role.RemoveUserFromRoleParam)">
  2019. <!-- -->
  2020. </a>
  2021. <ul class="blockList">
  2022. <li class="blockList">
  2023. <h4>removeUserFromRole</h4>
  2024. <pre class="methodSignature">public&nbsp;<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;removeUserFromRole&#8203;(<a href="../param/role/RemoveUserFromRoleParam.html" title="class in io.milvus.param.role">RemoveUserFromRoleParam</a>&nbsp;requestParam)</pre>
  2025. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#removeUserFromRole(io.milvus.param.role.RemoveUserFromRoleParam)">MilvusClient</a></code></span></div>
  2026. <div class="block">The user will remove permissions that the role are allowed to perform operations.</div>
  2027. <dl>
  2028. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2029. <dd><code><a href="MilvusClient.html#removeUserFromRole(io.milvus.param.role.RemoveUserFromRoleParam)">removeUserFromRole</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  2030. <dt><span class="paramLabel">Parameters:</span></dt>
  2031. <dd><code>requestParam</code> - <a href="../param/role/AddUserToRoleParam.html" title="class in io.milvus.param.role"><code>AddUserToRoleParam</code></a></dd>
  2032. <dt><span class="returnLabel">Returns:</span></dt>
  2033. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  2034. </dl>
  2035. </li>
  2036. </ul>
  2037. <a id="createRole(io.milvus.param.role.CreateRoleParam)">
  2038. <!-- -->
  2039. </a>
  2040. <ul class="blockList">
  2041. <li class="blockList">
  2042. <h4>createRole</h4>
  2043. <pre class="methodSignature">public&nbsp;<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;createRole&#8203;(<a href="../param/role/CreateRoleParam.html" title="class in io.milvus.param.role">CreateRoleParam</a>&nbsp;requestParam)</pre>
  2044. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#createRole(io.milvus.param.role.CreateRoleParam)">MilvusClient</a></code></span></div>
  2045. <div class="block">It will success if the role isn't existed, otherwise fail.</div>
  2046. <dl>
  2047. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2048. <dd><code><a href="MilvusClient.html#createRole(io.milvus.param.role.CreateRoleParam)">createRole</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  2049. <dt><span class="paramLabel">Parameters:</span></dt>
  2050. <dd><code>requestParam</code> - <a href="../param/role/CreateRoleParam.html" title="class in io.milvus.param.role"><code>CreateRoleParam</code></a></dd>
  2051. <dt><span class="returnLabel">Returns:</span></dt>
  2052. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  2053. </dl>
  2054. </li>
  2055. </ul>
  2056. <a id="dropRole(io.milvus.param.role.DropRoleParam)">
  2057. <!-- -->
  2058. </a>
  2059. <ul class="blockList">
  2060. <li class="blockList">
  2061. <h4>dropRole</h4>
  2062. <pre class="methodSignature">public&nbsp;<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;dropRole&#8203;(<a href="../param/role/DropRoleParam.html" title="class in io.milvus.param.role">DropRoleParam</a>&nbsp;requestParam)</pre>
  2063. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#dropRole(io.milvus.param.role.DropRoleParam)">MilvusClient</a></code></span></div>
  2064. <div class="block">It will success if the role is existed, otherwise fail.</div>
  2065. <dl>
  2066. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2067. <dd><code><a href="MilvusClient.html#dropRole(io.milvus.param.role.DropRoleParam)">dropRole</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  2068. <dt><span class="paramLabel">Parameters:</span></dt>
  2069. <dd><code>requestParam</code> - <a href="../param/role/DropRoleParam.html" title="class in io.milvus.param.role"><code>DropRoleParam</code></a></dd>
  2070. <dt><span class="returnLabel">Returns:</span></dt>
  2071. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  2072. </dl>
  2073. </li>
  2074. </ul>
  2075. <a id="selectRole(io.milvus.param.role.SelectRoleParam)">
  2076. <!-- -->
  2077. </a>
  2078. <ul class="blockList">
  2079. <li class="blockList">
  2080. <h4>selectRole</h4>
  2081. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.SelectRoleResponse&gt;&nbsp;selectRole&#8203;(<a href="../param/role/SelectRoleParam.html" title="class in io.milvus.param.role">SelectRoleParam</a>&nbsp;requestParam)</pre>
  2082. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#selectRole(io.milvus.param.role.SelectRoleParam)">MilvusClient</a></code></span></div>
  2083. <div class="block">Get all users who are added to the role.</div>
  2084. <dl>
  2085. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2086. <dd><code><a href="MilvusClient.html#selectRole(io.milvus.param.role.SelectRoleParam)">selectRole</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  2087. <dt><span class="paramLabel">Parameters:</span></dt>
  2088. <dd><code>requestParam</code> - <a href="../param/role/SelectRoleParam.html" title="class in io.milvus.param.role"><code>SelectRoleParam</code></a></dd>
  2089. <dt><span class="returnLabel">Returns:</span></dt>
  2090. <dd>{status:result code, data:SelectRoleResponse{status,info}}</dd>
  2091. </dl>
  2092. </li>
  2093. </ul>
  2094. <a id="selectUser(io.milvus.param.role.SelectUserParam)">
  2095. <!-- -->
  2096. </a>
  2097. <ul class="blockList">
  2098. <li class="blockList">
  2099. <h4>selectUser</h4>
  2100. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.SelectUserResponse&gt;&nbsp;selectUser&#8203;(<a href="../param/role/SelectUserParam.html" title="class in io.milvus.param.role">SelectUserParam</a>&nbsp;requestParam)</pre>
  2101. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#selectUser(io.milvus.param.role.SelectUserParam)">MilvusClient</a></code></span></div>
  2102. <div class="block">Get all roles the user has.</div>
  2103. <dl>
  2104. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2105. <dd><code><a href="MilvusClient.html#selectUser(io.milvus.param.role.SelectUserParam)">selectUser</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  2106. <dt><span class="paramLabel">Parameters:</span></dt>
  2107. <dd><code>requestParam</code> - <a href="../param/role/SelectUserParam.html" title="class in io.milvus.param.role"><code>SelectUserParam</code></a></dd>
  2108. <dt><span class="returnLabel">Returns:</span></dt>
  2109. <dd>{status:result code, data:SelectUserResponse{status,info}}</dd>
  2110. </dl>
  2111. </li>
  2112. </ul>
  2113. <a id="grantRolePrivilege(io.milvus.param.role.GrantRolePrivilegeParam)">
  2114. <!-- -->
  2115. </a>
  2116. <ul class="blockList">
  2117. <li class="blockList">
  2118. <h4>grantRolePrivilege</h4>
  2119. <pre class="methodSignature">public&nbsp;<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;grantRolePrivilege&#8203;(<a href="../param/role/GrantRolePrivilegeParam.html" title="class in io.milvus.param.role">GrantRolePrivilegeParam</a>&nbsp;requestParam)</pre>
  2120. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#grantRolePrivilege(io.milvus.param.role.GrantRolePrivilegeParam)">MilvusClient</a></code></span></div>
  2121. <div class="block">Grant Role Privilege.</div>
  2122. <dl>
  2123. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2124. <dd><code><a href="MilvusClient.html#grantRolePrivilege(io.milvus.param.role.GrantRolePrivilegeParam)">grantRolePrivilege</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  2125. <dt><span class="paramLabel">Parameters:</span></dt>
  2126. <dd><code>requestParam</code> - <a href="../param/role/GrantRolePrivilegeParam.html" title="class in io.milvus.param.role"><code>GrantRolePrivilegeParam</code></a></dd>
  2127. <dt><span class="returnLabel">Returns:</span></dt>
  2128. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  2129. </dl>
  2130. </li>
  2131. </ul>
  2132. <a id="revokeRolePrivilege(io.milvus.param.role.RevokeRolePrivilegeParam)">
  2133. <!-- -->
  2134. </a>
  2135. <ul class="blockList">
  2136. <li class="blockList">
  2137. <h4>revokeRolePrivilege</h4>
  2138. <pre class="methodSignature">public&nbsp;<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;revokeRolePrivilege&#8203;(<a href="../param/role/RevokeRolePrivilegeParam.html" title="class in io.milvus.param.role">RevokeRolePrivilegeParam</a>&nbsp;requestParam)</pre>
  2139. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#revokeRolePrivilege(io.milvus.param.role.RevokeRolePrivilegeParam)">MilvusClient</a></code></span></div>
  2140. <div class="block">Revoke Role Privilege.</div>
  2141. <dl>
  2142. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2143. <dd><code><a href="MilvusClient.html#revokeRolePrivilege(io.milvus.param.role.RevokeRolePrivilegeParam)">revokeRolePrivilege</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  2144. <dt><span class="paramLabel">Parameters:</span></dt>
  2145. <dd><code>requestParam</code> - <a href="../param/role/RevokeRolePrivilegeParam.html" title="class in io.milvus.param.role"><code>RevokeRolePrivilegeParam</code></a></dd>
  2146. <dt><span class="returnLabel">Returns:</span></dt>
  2147. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  2148. </dl>
  2149. </li>
  2150. </ul>
  2151. <a id="selectGrantForRole(io.milvus.param.role.SelectGrantForRoleParam)">
  2152. <!-- -->
  2153. </a>
  2154. <ul class="blockList">
  2155. <li class="blockList">
  2156. <h4>selectGrantForRole</h4>
  2157. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.SelectGrantResponse&gt;&nbsp;selectGrantForRole&#8203;(<a href="../param/role/SelectGrantForRoleParam.html" title="class in io.milvus.param.role">SelectGrantForRoleParam</a>&nbsp;requestParam)</pre>
  2158. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#selectGrantForRole(io.milvus.param.role.SelectGrantForRoleParam)">MilvusClient</a></code></span></div>
  2159. <div class="block">List a grant info for the role and the specific object</div>
  2160. <dl>
  2161. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2162. <dd><code><a href="MilvusClient.html#selectGrantForRole(io.milvus.param.role.SelectGrantForRoleParam)">selectGrantForRole</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  2163. <dt><span class="paramLabel">Parameters:</span></dt>
  2164. <dd><code>requestParam</code> - <a href="../param/role/SelectGrantForRoleParam.html" title="class in io.milvus.param.role"><code>SelectGrantForRoleParam</code></a></dd>
  2165. <dt><span class="returnLabel">Returns:</span></dt>
  2166. <dd>{status:result code, data:SelectRoleResponse{status,info}}</dd>
  2167. </dl>
  2168. </li>
  2169. </ul>
  2170. <a id="selectGrantForRoleAndObject(io.milvus.param.role.SelectGrantForRoleAndObjectParam)">
  2171. <!-- -->
  2172. </a>
  2173. <ul class="blockList">
  2174. <li class="blockList">
  2175. <h4>selectGrantForRoleAndObject</h4>
  2176. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.SelectGrantResponse&gt;&nbsp;selectGrantForRoleAndObject&#8203;(<a href="../param/role/SelectGrantForRoleAndObjectParam.html" title="class in io.milvus.param.role">SelectGrantForRoleAndObjectParam</a>&nbsp;requestParam)</pre>
  2177. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#selectGrantForRoleAndObject(io.milvus.param.role.SelectGrantForRoleAndObjectParam)">MilvusClient</a></code></span></div>
  2178. <div class="block">List a grant info for the role</div>
  2179. <dl>
  2180. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2181. <dd><code><a href="MilvusClient.html#selectGrantForRoleAndObject(io.milvus.param.role.SelectGrantForRoleAndObjectParam)">selectGrantForRoleAndObject</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  2182. <dt><span class="paramLabel">Parameters:</span></dt>
  2183. <dd><code>requestParam</code> - <a href="../param/role/SelectGrantForRoleAndObjectParam.html" title="class in io.milvus.param.role"><code>SelectGrantForRoleAndObjectParam</code></a></dd>
  2184. <dt><span class="returnLabel">Returns:</span></dt>
  2185. <dd>{status:result code, data:SelectRoleResponse{status,info}}</dd>
  2186. </dl>
  2187. </li>
  2188. </ul>
  2189. <a id="bulkInsert(io.milvus.param.bulkinsert.BulkInsertParam)">
  2190. <!-- -->
  2191. </a>
  2192. <ul class="blockList">
  2193. <li class="blockList">
  2194. <h4>bulkInsert</h4>
  2195. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.ImportResponse&gt;&nbsp;bulkInsert&#8203;(<a href="../param/bulkinsert/BulkInsertParam.html" title="class in io.milvus.param.bulkinsert">BulkInsertParam</a>&nbsp;requestParam)</pre>
  2196. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#bulkInsert(io.milvus.param.bulkinsert.BulkInsertParam)">MilvusClient</a></code></span></div>
  2197. <div class="block">Import data from external files, currently support JSON format</div>
  2198. <dl>
  2199. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2200. <dd><code><a href="MilvusClient.html#bulkInsert(io.milvus.param.bulkinsert.BulkInsertParam)">bulkInsert</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  2201. <dt><span class="paramLabel">Parameters:</span></dt>
  2202. <dd><code>requestParam</code> - <a href="../param/bulkinsert/BulkInsertParam.html" title="class in io.milvus.param.bulkinsert"><code>BulkInsertParam</code></a></dd>
  2203. <dt><span class="returnLabel">Returns:</span></dt>
  2204. <dd>{status:result code, data:ImportResponse{status,info}}</dd>
  2205. </dl>
  2206. </li>
  2207. </ul>
  2208. <a id="getBulkInsertState(io.milvus.param.bulkinsert.GetBulkInsertStateParam)">
  2209. <!-- -->
  2210. </a>
  2211. <ul class="blockList">
  2212. <li class="blockList">
  2213. <h4>getBulkInsertState</h4>
  2214. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetImportStateResponse&gt;&nbsp;getBulkInsertState&#8203;(<a href="../param/bulkinsert/GetBulkInsertStateParam.html" title="class in io.milvus.param.bulkinsert">GetBulkInsertStateParam</a>&nbsp;requestParam)</pre>
  2215. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#getBulkInsertState(io.milvus.param.bulkinsert.GetBulkInsertStateParam)">MilvusClient</a></code></span></div>
  2216. <div class="block">Get state of bulk insert task</div>
  2217. <dl>
  2218. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2219. <dd><code><a href="MilvusClient.html#getBulkInsertState(io.milvus.param.bulkinsert.GetBulkInsertStateParam)">getBulkInsertState</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  2220. <dt><span class="paramLabel">Parameters:</span></dt>
  2221. <dd><code>requestParam</code> - <a href="../param/bulkinsert/GetBulkInsertStateParam.html" title="class in io.milvus.param.bulkinsert"><code>GetBulkInsertStateParam</code></a></dd>
  2222. <dt><span class="returnLabel">Returns:</span></dt>
  2223. <dd>{status:result code, data:GetImportStateResponse{status,info}}</dd>
  2224. </dl>
  2225. </li>
  2226. </ul>
  2227. <a id="listBulkInsertTasks(io.milvus.param.bulkinsert.ListBulkInsertTasksParam)">
  2228. <!-- -->
  2229. </a>
  2230. <ul class="blockList">
  2231. <li class="blockList">
  2232. <h4>listBulkInsertTasks</h4>
  2233. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.ListImportTasksResponse&gt;&nbsp;listBulkInsertTasks&#8203;(<a href="../param/bulkinsert/ListBulkInsertTasksParam.html" title="class in io.milvus.param.bulkinsert">ListBulkInsertTasksParam</a>&nbsp;requestParam)</pre>
  2234. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#listBulkInsertTasks(io.milvus.param.bulkinsert.ListBulkInsertTasksParam)">MilvusClient</a></code></span></div>
  2235. <div class="block">List bulk insert tasks</div>
  2236. <dl>
  2237. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2238. <dd><code><a href="MilvusClient.html#listBulkInsertTasks(io.milvus.param.bulkinsert.ListBulkInsertTasksParam)">listBulkInsertTasks</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  2239. <dt><span class="paramLabel">Parameters:</span></dt>
  2240. <dd><code>requestParam</code> - <a href="../param/bulkinsert/ListBulkInsertTasksParam.html" title="class in io.milvus.param.bulkinsert"><code>ListBulkInsertTasksParam</code></a></dd>
  2241. <dt><span class="returnLabel">Returns:</span></dt>
  2242. <dd>{status:result code, data:ListImportTasksResponse{status,info}}</dd>
  2243. </dl>
  2244. </li>
  2245. </ul>
  2246. <a id="getLoadingProgress(io.milvus.param.collection.GetLoadingProgressParam)">
  2247. <!-- -->
  2248. </a>
  2249. <ul class="blockList">
  2250. <li class="blockList">
  2251. <h4>getLoadingProgress</h4>
  2252. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetLoadingProgressResponse&gt;&nbsp;getLoadingProgress&#8203;(<a href="../param/collection/GetLoadingProgressParam.html" title="class in io.milvus.param.collection">GetLoadingProgressParam</a>&nbsp;requestParam)</pre>
  2253. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#getLoadingProgress(io.milvus.param.collection.GetLoadingProgressParam)">MilvusClient</a></code></span></div>
  2254. <div class="block">Get collection loading progress</div>
  2255. <dl>
  2256. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2257. <dd><code><a href="MilvusClient.html#getLoadingProgress(io.milvus.param.collection.GetLoadingProgressParam)">getLoadingProgress</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  2258. <dt><span class="paramLabel">Parameters:</span></dt>
  2259. <dd><code>requestParam</code> - <a href="../param/collection/GetLoadingProgressParam.html" title="class in io.milvus.param.collection"><code>GetLoadingProgressParam</code></a></dd>
  2260. <dt><span class="returnLabel">Returns:</span></dt>
  2261. <dd>{status:result code, data:GetLoadingProgressResponse{status}}</dd>
  2262. </dl>
  2263. </li>
  2264. </ul>
  2265. <a id="getLoadState(io.milvus.param.collection.GetLoadStateParam)">
  2266. <!-- -->
  2267. </a>
  2268. <ul class="blockList">
  2269. <li class="blockList">
  2270. <h4>getLoadState</h4>
  2271. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetLoadStateResponse&gt;&nbsp;getLoadState&#8203;(<a href="../param/collection/GetLoadStateParam.html" title="class in io.milvus.param.collection">GetLoadStateParam</a>&nbsp;requestParam)</pre>
  2272. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#getLoadState(io.milvus.param.collection.GetLoadStateParam)">MilvusClient</a></code></span></div>
  2273. <div class="block">Get collection loading state</div>
  2274. <dl>
  2275. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2276. <dd><code><a href="MilvusClient.html#getLoadState(io.milvus.param.collection.GetLoadStateParam)">getLoadState</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  2277. <dt><span class="paramLabel">Parameters:</span></dt>
  2278. <dd><code>requestParam</code> - <a href="../param/collection/GetLoadStateParam.html" title="class in io.milvus.param.collection"><code>GetLoadStateParam</code></a></dd>
  2279. <dt><span class="returnLabel">Returns:</span></dt>
  2280. <dd>{status:result code, data:GetLoadStateResponse{status}}</dd>
  2281. </dl>
  2282. </li>
  2283. </ul>
  2284. <a id="checkHealth()">
  2285. <!-- -->
  2286. </a>
  2287. <ul class="blockList">
  2288. <li class="blockList">
  2289. <h4>checkHealth</h4>
  2290. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.CheckHealthResponse&gt;&nbsp;checkHealth()</pre>
  2291. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#checkHealth()">MilvusClient</a></code></span></div>
  2292. <div class="block">Check server health</div>
  2293. <dl>
  2294. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2295. <dd><code><a href="MilvusClient.html#checkHealth()">checkHealth</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  2296. <dt><span class="returnLabel">Returns:</span></dt>
  2297. <dd>{status:result code, data:CheckHealthResponse{status,info}}</dd>
  2298. </dl>
  2299. </li>
  2300. </ul>
  2301. <a id="getVersion()">
  2302. <!-- -->
  2303. </a>
  2304. <ul class="blockList">
  2305. <li class="blockList">
  2306. <h4>getVersion</h4>
  2307. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetVersionResponse&gt;&nbsp;getVersion()</pre>
  2308. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#getVersion()">MilvusClient</a></code></span></div>
  2309. <div class="block">Get server version</div>
  2310. <dl>
  2311. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2312. <dd><code><a href="MilvusClient.html#getVersion()">getVersion</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  2313. <dt><span class="returnLabel">Returns:</span></dt>
  2314. <dd>{status:result code, data:GetVersionResponse{status,info}}</dd>
  2315. </dl>
  2316. </li>
  2317. </ul>
  2318. <a id="createResourceGroup(io.milvus.param.resourcegroup.CreateResourceGroupParam)">
  2319. <!-- -->
  2320. </a>
  2321. <ul class="blockList">
  2322. <li class="blockList">
  2323. <h4>createResourceGroup</h4>
  2324. <pre class="methodSignature">public&nbsp;<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;createResourceGroup&#8203;(<a href="../param/resourcegroup/CreateResourceGroupParam.html" title="class in io.milvus.param.resourcegroup">CreateResourceGroupParam</a>&nbsp;requestParam)</pre>
  2325. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#createResourceGroup(io.milvus.param.resourcegroup.CreateResourceGroupParam)">MilvusClient</a></code></span></div>
  2326. <div class="block">Create a resource group.</div>
  2327. <dl>
  2328. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2329. <dd><code><a href="MilvusClient.html#createResourceGroup(io.milvus.param.resourcegroup.CreateResourceGroupParam)">createResourceGroup</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  2330. <dt><span class="paramLabel">Parameters:</span></dt>
  2331. <dd><code>requestParam</code> - <a href="../param/resourcegroup/CreateResourceGroupParam.html" title="class in io.milvus.param.resourcegroup"><code>CreateResourceGroupParam</code></a></dd>
  2332. <dt><span class="returnLabel">Returns:</span></dt>
  2333. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  2334. </dl>
  2335. </li>
  2336. </ul>
  2337. <a id="dropResourceGroup(io.milvus.param.resourcegroup.DropResourceGroupParam)">
  2338. <!-- -->
  2339. </a>
  2340. <ul class="blockList">
  2341. <li class="blockList">
  2342. <h4>dropResourceGroup</h4>
  2343. <pre class="methodSignature">public&nbsp;<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;dropResourceGroup&#8203;(<a href="../param/resourcegroup/DropResourceGroupParam.html" title="class in io.milvus.param.resourcegroup">DropResourceGroupParam</a>&nbsp;requestParam)</pre>
  2344. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#dropResourceGroup(io.milvus.param.resourcegroup.DropResourceGroupParam)">MilvusClient</a></code></span></div>
  2345. <div class="block">Drop a resource group.</div>
  2346. <dl>
  2347. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2348. <dd><code><a href="MilvusClient.html#dropResourceGroup(io.milvus.param.resourcegroup.DropResourceGroupParam)">dropResourceGroup</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  2349. <dt><span class="paramLabel">Parameters:</span></dt>
  2350. <dd><code>requestParam</code> - <a href="../param/resourcegroup/DropResourceGroupParam.html" title="class in io.milvus.param.resourcegroup"><code>DropResourceGroupParam</code></a></dd>
  2351. <dt><span class="returnLabel">Returns:</span></dt>
  2352. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  2353. </dl>
  2354. </li>
  2355. </ul>
  2356. <a id="listResourceGroups(io.milvus.param.resourcegroup.ListResourceGroupsParam)">
  2357. <!-- -->
  2358. </a>
  2359. <ul class="blockList">
  2360. <li class="blockList">
  2361. <h4>listResourceGroups</h4>
  2362. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.ListResourceGroupsResponse&gt;&nbsp;listResourceGroups&#8203;(<a href="../param/resourcegroup/ListResourceGroupsParam.html" title="class in io.milvus.param.resourcegroup">ListResourceGroupsParam</a>&nbsp;requestParam)</pre>
  2363. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#listResourceGroups(io.milvus.param.resourcegroup.ListResourceGroupsParam)">MilvusClient</a></code></span></div>
  2364. <div class="block">List resource groups.</div>
  2365. <dl>
  2366. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2367. <dd><code><a href="MilvusClient.html#listResourceGroups(io.milvus.param.resourcegroup.ListResourceGroupsParam)">listResourceGroups</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  2368. <dt><span class="paramLabel">Parameters:</span></dt>
  2369. <dd><code>requestParam</code> - <a href="../param/resourcegroup/ListResourceGroupsParam.html" title="class in io.milvus.param.resourcegroup"><code>ListResourceGroupsParam</code></a></dd>
  2370. <dt><span class="returnLabel">Returns:</span></dt>
  2371. <dd>{status:result code, data:ListResourceGroupsResponse{status}}</dd>
  2372. </dl>
  2373. </li>
  2374. </ul>
  2375. <a id="describeResourceGroup(io.milvus.param.resourcegroup.DescribeResourceGroupParam)">
  2376. <!-- -->
  2377. </a>
  2378. <ul class="blockList">
  2379. <li class="blockList">
  2380. <h4>describeResourceGroup</h4>
  2381. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.DescribeResourceGroupResponse&gt;&nbsp;describeResourceGroup&#8203;(<a href="../param/resourcegroup/DescribeResourceGroupParam.html" title="class in io.milvus.param.resourcegroup">DescribeResourceGroupParam</a>&nbsp;requestParam)</pre>
  2382. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#describeResourceGroup(io.milvus.param.resourcegroup.DescribeResourceGroupParam)">MilvusClient</a></code></span></div>
  2383. <div class="block">Describe a resource group.</div>
  2384. <dl>
  2385. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2386. <dd><code><a href="MilvusClient.html#describeResourceGroup(io.milvus.param.resourcegroup.DescribeResourceGroupParam)">describeResourceGroup</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  2387. <dt><span class="paramLabel">Parameters:</span></dt>
  2388. <dd><code>requestParam</code> - <a href="../param/resourcegroup/DescribeResourceGroupParam.html" title="class in io.milvus.param.resourcegroup"><code>DescribeResourceGroupParam</code></a></dd>
  2389. <dt><span class="returnLabel">Returns:</span></dt>
  2390. <dd>{status:result code, data:DescribeResourceGroupResponse{status}}</dd>
  2391. </dl>
  2392. </li>
  2393. </ul>
  2394. <a id="transferNode(io.milvus.param.resourcegroup.TransferNodeParam)">
  2395. <!-- -->
  2396. </a>
  2397. <ul class="blockList">
  2398. <li class="blockList">
  2399. <h4>transferNode</h4>
  2400. <pre class="methodSignature">public&nbsp;<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;transferNode&#8203;(<a href="../param/resourcegroup/TransferNodeParam.html" title="class in io.milvus.param.resourcegroup">TransferNodeParam</a>&nbsp;requestParam)</pre>
  2401. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#transferNode(io.milvus.param.resourcegroup.TransferNodeParam)">MilvusClient</a></code></span></div>
  2402. <div class="block">Transfer a query node from source resource group to target resource_group.</div>
  2403. <dl>
  2404. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2405. <dd><code><a href="MilvusClient.html#transferNode(io.milvus.param.resourcegroup.TransferNodeParam)">transferNode</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  2406. <dt><span class="paramLabel">Parameters:</span></dt>
  2407. <dd><code>requestParam</code> - <a href="../param/resourcegroup/TransferNodeParam.html" title="class in io.milvus.param.resourcegroup"><code>TransferNodeParam</code></a></dd>
  2408. <dt><span class="returnLabel">Returns:</span></dt>
  2409. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  2410. </dl>
  2411. </li>
  2412. </ul>
  2413. <a id="transferReplica(io.milvus.param.resourcegroup.TransferReplicaParam)">
  2414. <!-- -->
  2415. </a>
  2416. <ul class="blockList">
  2417. <li class="blockList">
  2418. <h4>transferReplica</h4>
  2419. <pre class="methodSignature">public&nbsp;<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;transferReplica&#8203;(<a href="../param/resourcegroup/TransferReplicaParam.html" title="class in io.milvus.param.resourcegroup">TransferReplicaParam</a>&nbsp;requestParam)</pre>
  2420. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#transferReplica(io.milvus.param.resourcegroup.TransferReplicaParam)">MilvusClient</a></code></span></div>
  2421. <div class="block">Transfer a replica from source resource group to target resource_group.</div>
  2422. <dl>
  2423. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2424. <dd><code><a href="MilvusClient.html#transferReplica(io.milvus.param.resourcegroup.TransferReplicaParam)">transferReplica</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  2425. <dt><span class="paramLabel">Parameters:</span></dt>
  2426. <dd><code>requestParam</code> - <a href="../param/resourcegroup/TransferReplicaParam.html" title="class in io.milvus.param.resourcegroup"><code>TransferReplicaParam</code></a></dd>
  2427. <dt><span class="returnLabel">Returns:</span></dt>
  2428. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  2429. </dl>
  2430. </li>
  2431. </ul>
  2432. <a id="createCollection(io.milvus.param.highlevel.collection.CreateSimpleCollectionParam)">
  2433. <!-- -->
  2434. </a>
  2435. <ul class="blockList">
  2436. <li class="blockList">
  2437. <h4>createCollection</h4>
  2438. <pre class="methodSignature">public&nbsp;<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/highlevel/collection/CreateSimpleCollectionParam.html" title="class in io.milvus.param.highlevel.collection">CreateSimpleCollectionParam</a>&nbsp;requestParam)</pre>
  2439. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#createCollection(io.milvus.param.highlevel.collection.CreateSimpleCollectionParam)">MilvusClient</a></code></span></div>
  2440. <div class="block">Creates a collection in Milvus.</div>
  2441. <dl>
  2442. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2443. <dd><code><a href="MilvusClient.html#createCollection(io.milvus.param.highlevel.collection.CreateSimpleCollectionParam)">createCollection</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  2444. <dt><span class="paramLabel">Parameters:</span></dt>
  2445. <dd><code>requestParam</code> - <a href="../param/highlevel/collection/CreateSimpleCollectionParam.html" title="class in io.milvus.param.highlevel.collection"><code>CreateSimpleCollectionParam</code></a></dd>
  2446. <dt><span class="returnLabel">Returns:</span></dt>
  2447. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  2448. </dl>
  2449. </li>
  2450. </ul>
  2451. <a id="listCollections(io.milvus.param.highlevel.collection.ListCollectionsParam)">
  2452. <!-- -->
  2453. </a>
  2454. <ul class="blockList">
  2455. <li class="blockList">
  2456. <h4>listCollections</h4>
  2457. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/highlevel/collection/response/ListCollectionsResponse.html" title="class in io.milvus.param.highlevel.collection.response">ListCollectionsResponse</a>&gt;&nbsp;listCollections&#8203;(<a href="../param/highlevel/collection/ListCollectionsParam.html" title="class in io.milvus.param.highlevel.collection">ListCollectionsParam</a>&nbsp;requestParam)</pre>
  2458. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#listCollections(io.milvus.param.highlevel.collection.ListCollectionsParam)">MilvusClient</a></code></span></div>
  2459. <div class="block">Lists all collections</div>
  2460. <dl>
  2461. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2462. <dd><code><a href="MilvusClient.html#listCollections(io.milvus.param.highlevel.collection.ListCollectionsParam)">listCollections</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  2463. <dt><span class="paramLabel">Parameters:</span></dt>
  2464. <dd><code>requestParam</code> - <a href="../param/highlevel/collection/ListCollectionsParam.html" title="class in io.milvus.param.highlevel.collection"><code>ListCollectionsParam</code></a></dd>
  2465. <dt><span class="returnLabel">Returns:</span></dt>
  2466. <dd>{status:result code, data: ListCollectionsResponse{collection_names}}</dd>
  2467. </dl>
  2468. </li>
  2469. </ul>
  2470. <a id="insert(io.milvus.param.highlevel.dml.InsertRowsParam)">
  2471. <!-- -->
  2472. </a>
  2473. <ul class="blockList">
  2474. <li class="blockList">
  2475. <h4>insert</h4>
  2476. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/highlevel/dml/response/InsertResponse.html" title="class in io.milvus.param.highlevel.dml.response">InsertResponse</a>&gt;&nbsp;insert&#8203;(<a href="../param/highlevel/dml/InsertRowsParam.html" title="class in io.milvus.param.highlevel.dml">InsertRowsParam</a>&nbsp;requestParam)</pre>
  2477. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#insert(io.milvus.param.highlevel.dml.InsertRowsParam)">MilvusClient</a></code></span></div>
  2478. <div class="block">Inserts rows data into a specified collection . Note that you don't need to
  2479. input primary key field if auto_id is enabled.</div>
  2480. <dl>
  2481. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2482. <dd><code><a href="MilvusClient.html#insert(io.milvus.param.highlevel.dml.InsertRowsParam)">insert</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  2483. <dt><span class="paramLabel">Parameters:</span></dt>
  2484. <dd><code>requestParam</code> - <a href="../param/highlevel/dml/InsertRowsParam.html" title="class in io.milvus.param.highlevel.dml"><code>InsertRowsParam</code></a></dd>
  2485. <dt><span class="returnLabel">Returns:</span></dt>
  2486. <dd>{status:result code, data: MutationResult{insert results}}</dd>
  2487. </dl>
  2488. </li>
  2489. </ul>
  2490. <a id="delete(io.milvus.param.highlevel.dml.DeleteIdsParam)">
  2491. <!-- -->
  2492. </a>
  2493. <ul class="blockList">
  2494. <li class="blockList">
  2495. <h4>delete</h4>
  2496. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/highlevel/dml/response/DeleteResponse.html" title="class in io.milvus.param.highlevel.dml.response">DeleteResponse</a>&gt;&nbsp;delete&#8203;(<a href="../param/highlevel/dml/DeleteIdsParam.html" title="class in io.milvus.param.highlevel.dml">DeleteIdsParam</a>&nbsp;requestParam)</pre>
  2497. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#delete(io.milvus.param.highlevel.dml.DeleteIdsParam)">MilvusClient</a></code></span></div>
  2498. <div class="block">Deletes entity(s) based on the value of primary key.</div>
  2499. <dl>
  2500. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2501. <dd><code><a href="MilvusClient.html#delete(io.milvus.param.highlevel.dml.DeleteIdsParam)">delete</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  2502. <dt><span class="paramLabel">Parameters:</span></dt>
  2503. <dd><code>requestParam</code> - <a href="../param/highlevel/dml/DeleteIdsParam.html" title="class in io.milvus.param.highlevel.dml"><code>DeleteIdsParam</code></a></dd>
  2504. <dt><span class="returnLabel">Returns:</span></dt>
  2505. <dd>{status:result code, data: MutationResult{delete results}}</dd>
  2506. </dl>
  2507. </li>
  2508. </ul>
  2509. <a id="get(io.milvus.param.highlevel.dml.GetIdsParam)">
  2510. <!-- -->
  2511. </a>
  2512. <ul class="blockList">
  2513. <li class="blockList">
  2514. <h4>get</h4>
  2515. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/highlevel/dml/response/GetResponse.html" title="class in io.milvus.param.highlevel.dml.response">GetResponse</a>&gt;&nbsp;get&#8203;(<a href="../param/highlevel/dml/GetIdsParam.html" title="class in io.milvus.param.highlevel.dml">GetIdsParam</a>&nbsp;requestParam)</pre>
  2516. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#get(io.milvus.param.highlevel.dml.GetIdsParam)">MilvusClient</a></code></span></div>
  2517. <div class="block">Get entity(s) based on the value of primary key.</div>
  2518. <dl>
  2519. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2520. <dd><code><a href="MilvusClient.html#get(io.milvus.param.highlevel.dml.GetIdsParam)">get</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  2521. <dt><span class="paramLabel">Parameters:</span></dt>
  2522. <dd><code>requestParam</code> - <a href="../param/highlevel/dml/GetIdsParam.html" title="class in io.milvus.param.highlevel.dml"><code>GetIdsParam</code></a></dd>
  2523. <dt><span class="returnLabel">Returns:</span></dt>
  2524. <dd>{status:result code, data: QueryResults{query results}}</dd>
  2525. </dl>
  2526. </li>
  2527. </ul>
  2528. <a id="query(io.milvus.param.highlevel.dml.QuerySimpleParam)">
  2529. <!-- -->
  2530. </a>
  2531. <ul class="blockList">
  2532. <li class="blockList">
  2533. <h4>query</h4>
  2534. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/highlevel/dml/response/QueryResponse.html" title="class in io.milvus.param.highlevel.dml.response">QueryResponse</a>&gt;&nbsp;query&#8203;(<a href="../param/highlevel/dml/QuerySimpleParam.html" title="class in io.milvus.param.highlevel.dml">QuerySimpleParam</a>&nbsp;requestParam)</pre>
  2535. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#query(io.milvus.param.highlevel.dml.QuerySimpleParam)">MilvusClient</a></code></span></div>
  2536. <div class="block">Queries entity(s) based on scalar field(s) filtered by boolean expression.
  2537. Note that the order of the returned entities cannot be guaranteed.</div>
  2538. <dl>
  2539. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2540. <dd><code><a href="MilvusClient.html#query(io.milvus.param.highlevel.dml.QuerySimpleParam)">query</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  2541. <dt><span class="paramLabel">Parameters:</span></dt>
  2542. <dd><code>requestParam</code> - <a href="../param/highlevel/dml/QuerySimpleParam.html" title="class in io.milvus.param.highlevel.dml"><code>QuerySimpleParam</code></a></dd>
  2543. <dt><span class="returnLabel">Returns:</span></dt>
  2544. <dd>{status:result code,data: QueryResults{filter results}}</dd>
  2545. </dl>
  2546. </li>
  2547. </ul>
  2548. <a id="search(io.milvus.param.highlevel.dml.SearchSimpleParam)">
  2549. <!-- -->
  2550. </a>
  2551. <ul class="blockList">
  2552. <li class="blockList">
  2553. <h4>search</h4>
  2554. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/highlevel/dml/response/SearchResponse.html" title="class in io.milvus.param.highlevel.dml.response">SearchResponse</a>&gt;&nbsp;search&#8203;(<a href="../param/highlevel/dml/SearchSimpleParam.html" title="class in io.milvus.param.highlevel.dml">SearchSimpleParam</a>&nbsp;requestParam)</pre>
  2555. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#search(io.milvus.param.highlevel.dml.SearchSimpleParam)">MilvusClient</a></code></span></div>
  2556. <div class="block">Conducts ANN search on a vector field. Use expression to do filtering before search.</div>
  2557. <dl>
  2558. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2559. <dd><code><a href="MilvusClient.html#search(io.milvus.param.highlevel.dml.SearchSimpleParam)">search</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  2560. <dt><span class="paramLabel">Parameters:</span></dt>
  2561. <dd><code>requestParam</code> - <a href="../param/highlevel/dml/SearchSimpleParam.html" title="class in io.milvus.param.highlevel.dml"><code>SearchSimpleParam</code></a></dd>
  2562. <dt><span class="returnLabel">Returns:</span></dt>
  2563. <dd>{status:result code, data: SearchResults{topK results}}</dd>
  2564. </dl>
  2565. </li>
  2566. </ul>
  2567. <a id="queryIterator(io.milvus.param.dml.QueryIteratorParam)">
  2568. <!-- -->
  2569. </a>
  2570. <ul class="blockList">
  2571. <li class="blockList">
  2572. <h4>queryIterator</h4>
  2573. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../orm/iterator/QueryIterator.html" title="class in io.milvus.orm.iterator">QueryIterator</a>&gt;&nbsp;queryIterator&#8203;(<a href="../param/dml/QueryIteratorParam.html" title="class in io.milvus.param.dml">QueryIteratorParam</a>&nbsp;requestParam)</pre>
  2574. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#queryIterator(io.milvus.param.dml.QueryIteratorParam)">MilvusClient</a></code></span></div>
  2575. <div class="block">Get queryIterator based on scalar field(s) filtered by boolean expression.
  2576. Note that the order of the returned entities cannot be guaranteed.</div>
  2577. <dl>
  2578. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2579. <dd><code><a href="MilvusClient.html#queryIterator(io.milvus.param.dml.QueryIteratorParam)">queryIterator</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  2580. <dt><span class="paramLabel">Parameters:</span></dt>
  2581. <dd><code>requestParam</code> - <a href="../param/dml/QueryIteratorParam.html" title="class in io.milvus.param.dml"><code>QueryIteratorParam</code></a></dd>
  2582. <dt><span class="returnLabel">Returns:</span></dt>
  2583. <dd>{status:result code,data: QueryIterator}</dd>
  2584. </dl>
  2585. </li>
  2586. </ul>
  2587. <a id="searchIterator(io.milvus.param.dml.SearchIteratorParam)">
  2588. <!-- -->
  2589. </a>
  2590. <ul class="blockListLast">
  2591. <li class="blockList">
  2592. <h4>searchIterator</h4>
  2593. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../orm/iterator/SearchIterator.html" title="class in io.milvus.orm.iterator">SearchIterator</a>&gt;&nbsp;searchIterator&#8203;(<a href="../param/dml/SearchIteratorParam.html" title="class in io.milvus.param.dml">SearchIteratorParam</a>&nbsp;requestParam)</pre>
  2594. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#searchIterator(io.milvus.param.dml.SearchIteratorParam)">MilvusClient</a></code></span></div>
  2595. <div class="block">Get searchIterator based on a vector field. Use expression to do filtering before search.</div>
  2596. <dl>
  2597. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2598. <dd><code><a href="MilvusClient.html#searchIterator(io.milvus.param.dml.SearchIteratorParam)">searchIterator</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  2599. <dt><span class="paramLabel">Parameters:</span></dt>
  2600. <dd><code>requestParam</code> - <a href="../param/dml/SearchIteratorParam.html" title="class in io.milvus.param.dml"><code>SearchIteratorParam</code></a></dd>
  2601. <dt><span class="returnLabel">Returns:</span></dt>
  2602. <dd>{status:result code, data: SearchIterator}</dd>
  2603. </dl>
  2604. </li>
  2605. </ul>
  2606. </li>
  2607. </ul>
  2608. </section>
  2609. </li>
  2610. </ul>
  2611. </div>
  2612. </div>
  2613. </main>
  2614. <!-- ========= END OF CLASS DATA ========= -->
  2615. <footer role="contentinfo">
  2616. <nav role="navigation">
  2617. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  2618. <div class="bottomNav"><a id="navbar.bottom">
  2619. <!-- -->
  2620. </a>
  2621. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  2622. <a id="navbar.bottom.firstrow">
  2623. <!-- -->
  2624. </a>
  2625. <ul class="navList" title="Navigation">
  2626. <li><a href="../../../index.html">Overview</a></li>
  2627. <li><a href="package-summary.html">Package</a></li>
  2628. <li class="navBarCell1Rev">Class</li>
  2629. <li><a href="package-tree.html">Tree</a></li>
  2630. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  2631. <li><a href="../../../index-files/index-1.html">Index</a></li>
  2632. <li><a href="../../../help-doc.html">Help</a></li>
  2633. </ul>
  2634. </div>
  2635. <div class="subNav">
  2636. <ul class="navList" id="allclasses_navbar_bottom">
  2637. <li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
  2638. </ul>
  2639. <div>
  2640. <script type="text/javascript"><!--
  2641. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  2642. if(window==top) {
  2643. allClassesLink.style.display = "block";
  2644. }
  2645. else {
  2646. allClassesLink.style.display = "none";
  2647. }
  2648. //-->
  2649. </script>
  2650. <noscript>
  2651. <div>JavaScript is disabled on your browser.</div>
  2652. </noscript>
  2653. </div>
  2654. <div>
  2655. <ul class="subNavList">
  2656. <li>Summary:&nbsp;</li>
  2657. <li>Nested&nbsp;|&nbsp;</li>
  2658. <li>Field&nbsp;|&nbsp;</li>
  2659. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  2660. <li><a href="#method.summary">Method</a></li>
  2661. </ul>
  2662. <ul class="subNavList">
  2663. <li>Detail:&nbsp;</li>
  2664. <li>Field&nbsp;|&nbsp;</li>
  2665. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  2666. <li><a href="#method.detail">Method</a></li>
  2667. </ul>
  2668. </div>
  2669. <a id="skip.navbar.bottom">
  2670. <!-- -->
  2671. </a></div>
  2672. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  2673. </nav>
  2674. </footer>
  2675. </body>
  2676. </html>