AbstractMilvusGrpcClient.html 177 KB

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