MilvusMultiServiceClient.html 185 KB

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