MilvusMultiServiceClient.html 223 KB

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