MilvusMultiServiceClient.html 189 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618
  1. <!DOCTYPE HTML>
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (11.0.18) on Wed Nov 08 12:07:04 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,"i86":10,"i87":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 collection.</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="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.MutationResult&gt;</code></td>
  772. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#upsert(io.milvus.param.dml.UpsertParam)">upsert</a></span>&#8203;(<a href="../param/dml/UpsertParam.html" title="class in io.milvus.param.dml">UpsertParam</a>&nbsp;requestParam)</code></th>
  773. <td class="colLast">
  774. <div class="block">Insert new entities into a specified collection, replace them if the entities already exist.</div>
  775. </td>
  776. </tr>
  777. <tr id="i84" class="altColor">
  778. <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>
  779. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#upsertAsync(io.milvus.param.dml.UpsertParam)">upsertAsync</a></span>&#8203;(<a href="../param/dml/UpsertParam.html" title="class in io.milvus.param.dml">UpsertParam</a>&nbsp;requestParam)</code></th>
  780. <td class="colLast">
  781. <div class="block">Insert new entities into a specified collection asynchronously, replace them if the entities already exist.</div>
  782. </td>
  783. </tr>
  784. <tr id="i85" class="rowColor">
  785. <td class="colFirst"><code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></td>
  786. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withRetry(int)">withRetry</a></span>&#8203;(int&nbsp;retryTimes)</code></th>
  787. <td class="colLast">
  788. <div class="block">Number of retry attempts.</div>
  789. </td>
  790. </tr>
  791. <tr id="i86" class="altColor">
  792. <td class="colFirst"><code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></td>
  793. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withRetryInterval(long,java.util.concurrent.TimeUnit)">withRetryInterval</a></span>&#8203;(long&nbsp;interval,
  794. java.util.concurrent.TimeUnit&nbsp;timeUnit)</code></th>
  795. <td class="colLast">
  796. <div class="block">Time interval between retry attempts.</div>
  797. </td>
  798. </tr>
  799. <tr id="i87" class="rowColor">
  800. <td class="colFirst"><code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></td>
  801. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withTimeout(long,java.util.concurrent.TimeUnit)">withTimeout</a></span>&#8203;(long&nbsp;timeout,
  802. java.util.concurrent.TimeUnit&nbsp;timeoutUnit)</code></th>
  803. <td class="colLast">
  804. <div class="block">Timeout setting for rpc call.</div>
  805. </td>
  806. </tr>
  807. </table>
  808. <ul class="blockList">
  809. <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
  810. <!-- -->
  811. </a>
  812. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  813. <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  814. </ul>
  815. <ul class="blockList">
  816. <li class="blockList"><a id="methods.inherited.from.class.io.milvus.client.MilvusClient">
  817. <!-- -->
  818. </a>
  819. <h3>Methods inherited from interface&nbsp;io.milvus.client.<a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></h3>
  820. <code><a href="MilvusClient.html#close()">close</a></code></li>
  821. </ul>
  822. </li>
  823. </ul>
  824. </section>
  825. </li>
  826. </ul>
  827. </div>
  828. <div class="details">
  829. <ul class="blockList">
  830. <li class="blockList">
  831. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  832. <section>
  833. <ul class="blockList">
  834. <li class="blockList"><a id="constructor.detail">
  835. <!-- -->
  836. </a>
  837. <h3>Constructor Detail</h3>
  838. <a id="&lt;init&gt;(io.milvus.param.MultiConnectParam)">
  839. <!-- -->
  840. </a>
  841. <ul class="blockListLast">
  842. <li class="blockList">
  843. <h4>MilvusMultiServiceClient</h4>
  844. <pre>public&nbsp;MilvusMultiServiceClient&#8203;(@NonNull
  845. @NonNull <a href="../param/MultiConnectParam.html" title="class in io.milvus.param">MultiConnectParam</a>&nbsp;multiConnectParam)</pre>
  846. <div class="block">Sets connect param for multi milvus clusters.</div>
  847. <dl>
  848. <dt><span class="paramLabel">Parameters:</span></dt>
  849. <dd><code>multiConnectParam</code> - multi server connect param</dd>
  850. </dl>
  851. </li>
  852. </ul>
  853. </li>
  854. </ul>
  855. </section>
  856. <!-- ============ METHOD DETAIL ========== -->
  857. <section>
  858. <ul class="blockList">
  859. <li class="blockList"><a id="method.detail">
  860. <!-- -->
  861. </a>
  862. <h3>Method Detail</h3>
  863. <a id="withTimeout(long,java.util.concurrent.TimeUnit)">
  864. <!-- -->
  865. </a>
  866. <ul class="blockList">
  867. <li class="blockList">
  868. <h4>withTimeout</h4>
  869. <pre class="methodSignature">public&nbsp;<a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a>&nbsp;withTimeout&#8203;(long&nbsp;timeout,
  870. java.util.concurrent.TimeUnit&nbsp;timeoutUnit)</pre>
  871. <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>
  872. <div class="block">Timeout setting for rpc call.</div>
  873. <dl>
  874. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  875. <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>
  876. <dt><span class="paramLabel">Parameters:</span></dt>
  877. <dd><code>timeout</code> - set time waiting for a rpc call.</dd>
  878. <dd><code>timeoutUnit</code> - time unit</dd>
  879. </dl>
  880. </li>
  881. </ul>
  882. <a id="withRetry(int)">
  883. <!-- -->
  884. </a>
  885. <ul class="blockList">
  886. <li class="blockList">
  887. <h4>withRetry</h4>
  888. <pre class="methodSignature">public&nbsp;<a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a>&nbsp;withRetry&#8203;(int&nbsp;retryTimes)</pre>
  889. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#withRetry(int)">MilvusClient</a></code></span></div>
  890. <div class="block">Number of retry attempts.</div>
  891. <dl>
  892. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  893. <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>
  894. <dt><span class="paramLabel">Parameters:</span></dt>
  895. <dd><code>retryTimes</code> - number of retry attempts.</dd>
  896. </dl>
  897. </li>
  898. </ul>
  899. <a id="withRetryInterval(long,java.util.concurrent.TimeUnit)">
  900. <!-- -->
  901. </a>
  902. <ul class="blockList">
  903. <li class="blockList">
  904. <h4>withRetryInterval</h4>
  905. <pre class="methodSignature">public&nbsp;<a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a>&nbsp;withRetryInterval&#8203;(long&nbsp;interval,
  906. java.util.concurrent.TimeUnit&nbsp;timeUnit)</pre>
  907. <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>
  908. <div class="block">Time interval between retry attempts. Default value is 500ms.</div>
  909. <dl>
  910. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  911. <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>
  912. <dt><span class="paramLabel">Parameters:</span></dt>
  913. <dd><code>interval</code> - time interval between retry attempts.</dd>
  914. <dd><code>timeUnit</code> - time unit</dd>
  915. </dl>
  916. </li>
  917. </ul>
  918. <a id="close(long)">
  919. <!-- -->
  920. </a>
  921. <ul class="blockList">
  922. <li class="blockList">
  923. <h4>close</h4>
  924. <pre class="methodSignature">public&nbsp;void&nbsp;close&#8203;(long&nbsp;maxWaitSeconds)
  925. throws java.lang.InterruptedException</pre>
  926. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#close(long)">MilvusClient</a></code></span></div>
  927. <div class="block">Disconnects from a Milvus server with configurable timeout.</div>
  928. <dl>
  929. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  930. <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>
  931. <dt><span class="paramLabel">Parameters:</span></dt>
  932. <dd><code>maxWaitSeconds</code> - timeout unit: second</dd>
  933. <dt><span class="throwsLabel">Throws:</span></dt>
  934. <dd><code>java.lang.InterruptedException</code></dd>
  935. </dl>
  936. </li>
  937. </ul>
  938. <a id="setLogLevel(io.milvus.param.LogLevel)">
  939. <!-- -->
  940. </a>
  941. <ul class="blockList">
  942. <li class="blockList">
  943. <h4>setLogLevel</h4>
  944. <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>
  945. <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>
  946. <div class="block">Set log level in runtime.</div>
  947. <dl>
  948. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  949. <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>
  950. <dt><span class="paramLabel">Parameters:</span></dt>
  951. <dd><code>level</code> - <a href="../param/LogLevel.html" title="enum in io.milvus.param"><code>LogLevel</code></a></dd>
  952. </dl>
  953. </li>
  954. </ul>
  955. <a id="hasCollection(io.milvus.param.collection.HasCollectionParam)">
  956. <!-- -->
  957. </a>
  958. <ul class="blockList">
  959. <li class="blockList">
  960. <h4>hasCollection</h4>
  961. <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>
  962. <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>
  963. <div class="block">Checks if a collection exists.</div>
  964. <dl>
  965. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  966. <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>
  967. <dt><span class="paramLabel">Parameters:</span></dt>
  968. <dd><code>requestParam</code> - <a href="../param/collection/HasCollectionParam.html" title="class in io.milvus.param.collection"><code>HasCollectionParam</code></a></dd>
  969. <dt><span class="returnLabel">Returns:</span></dt>
  970. <dd>{status:result code, data: boolean, whether if has collection or not}</dd>
  971. </dl>
  972. </li>
  973. </ul>
  974. <a id="createDatabase(io.milvus.param.collection.CreateDatabaseParam)">
  975. <!-- -->
  976. </a>
  977. <ul class="blockList">
  978. <li class="blockList">
  979. <h4>createDatabase</h4>
  980. <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>
  981. <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>
  982. <div class="block">Creates a database in Milvus.</div>
  983. <dl>
  984. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  985. <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>
  986. <dt><span class="paramLabel">Parameters:</span></dt>
  987. <dd><code>requestParam</code> - <a href="../param/collection/CreateDatabaseParam.html" title="class in io.milvus.param.collection"><code>CreateDatabaseParam</code></a></dd>
  988. <dt><span class="returnLabel">Returns:</span></dt>
  989. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  990. </dl>
  991. </li>
  992. </ul>
  993. <a id="dropDatabase(io.milvus.param.collection.DropDatabaseParam)">
  994. <!-- -->
  995. </a>
  996. <ul class="blockList">
  997. <li class="blockList">
  998. <h4>dropDatabase</h4>
  999. <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>
  1000. <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>
  1001. <div class="block">Drops a database. Note that this method drops all data in the database.</div>
  1002. <dl>
  1003. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1004. <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>
  1005. <dt><span class="paramLabel">Parameters:</span></dt>
  1006. <dd><code>requestParam</code> - <a href="../param/collection/DropDatabaseParam.html" title="class in io.milvus.param.collection"><code>DropDatabaseParam</code></a></dd>
  1007. <dt><span class="returnLabel">Returns:</span></dt>
  1008. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1009. </dl>
  1010. </li>
  1011. </ul>
  1012. <a id="listDatabases()">
  1013. <!-- -->
  1014. </a>
  1015. <ul class="blockList">
  1016. <li class="blockList">
  1017. <h4>listDatabases</h4>
  1018. <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>
  1019. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#listDatabases()">MilvusClient</a></code></span></div>
  1020. <div class="block">List databases. Note that this method list all database in the cluster.</div>
  1021. <dl>
  1022. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1023. <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>
  1024. <dt><span class="returnLabel">Returns:</span></dt>
  1025. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1026. </dl>
  1027. </li>
  1028. </ul>
  1029. <a id="createCollection(io.milvus.param.collection.CreateCollectionParam)">
  1030. <!-- -->
  1031. </a>
  1032. <ul class="blockList">
  1033. <li class="blockList">
  1034. <h4>createCollection</h4>
  1035. <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>
  1036. <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>
  1037. <div class="block">Creates a collection in Milvus.</div>
  1038. <dl>
  1039. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1040. <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>
  1041. <dt><span class="paramLabel">Parameters:</span></dt>
  1042. <dd><code>requestParam</code> - <a href="../param/collection/CreateCollectionParam.html" title="class in io.milvus.param.collection"><code>CreateCollectionParam</code></a></dd>
  1043. <dt><span class="returnLabel">Returns:</span></dt>
  1044. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1045. </dl>
  1046. </li>
  1047. </ul>
  1048. <a id="dropCollection(io.milvus.param.collection.DropCollectionParam)">
  1049. <!-- -->
  1050. </a>
  1051. <ul class="blockList">
  1052. <li class="blockList">
  1053. <h4>dropCollection</h4>
  1054. <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>
  1055. <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>
  1056. <div class="block">Drops a collection. Note that this method drops all data in the collection.</div>
  1057. <dl>
  1058. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1059. <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>
  1060. <dt><span class="paramLabel">Parameters:</span></dt>
  1061. <dd><code>requestParam</code> - <a href="../param/collection/DropCollectionParam.html" title="class in io.milvus.param.collection"><code>DropCollectionParam</code></a></dd>
  1062. <dt><span class="returnLabel">Returns:</span></dt>
  1063. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1064. </dl>
  1065. </li>
  1066. </ul>
  1067. <a id="loadCollection(io.milvus.param.collection.LoadCollectionParam)">
  1068. <!-- -->
  1069. </a>
  1070. <ul class="blockList">
  1071. <li class="blockList">
  1072. <h4>loadCollection</h4>
  1073. <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>
  1074. <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>
  1075. <div class="block">Loads a collection to memory before search or query.</div>
  1076. <dl>
  1077. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1078. <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>
  1079. <dt><span class="paramLabel">Parameters:</span></dt>
  1080. <dd><code>requestParam</code> - <a href="../param/collection/LoadCollectionParam.html" title="class in io.milvus.param.collection"><code>LoadCollectionParam</code></a></dd>
  1081. <dt><span class="returnLabel">Returns:</span></dt>
  1082. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1083. </dl>
  1084. </li>
  1085. </ul>
  1086. <a id="releaseCollection(io.milvus.param.collection.ReleaseCollectionParam)">
  1087. <!-- -->
  1088. </a>
  1089. <ul class="blockList">
  1090. <li class="blockList">
  1091. <h4>releaseCollection</h4>
  1092. <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>
  1093. <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>
  1094. <div class="block">Releases a collection from memory to reduce memory usage. Note that you
  1095. cannot search while the corresponding collection is released from memory.</div>
  1096. <dl>
  1097. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1098. <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>
  1099. <dt><span class="paramLabel">Parameters:</span></dt>
  1100. <dd><code>requestParam</code> - <a href="../param/collection/ReleaseCollectionParam.html" title="class in io.milvus.param.collection"><code>ReleaseCollectionParam</code></a></dd>
  1101. <dt><span class="returnLabel">Returns:</span></dt>
  1102. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1103. </dl>
  1104. </li>
  1105. </ul>
  1106. <a id="renameCollection(io.milvus.param.collection.RenameCollectionParam)">
  1107. <!-- -->
  1108. </a>
  1109. <ul class="blockList">
  1110. <li class="blockList">
  1111. <h4>renameCollection</h4>
  1112. <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>
  1113. <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>
  1114. <div class="block">rename a collection</div>
  1115. <dl>
  1116. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1117. <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>
  1118. <dt><span class="paramLabel">Parameters:</span></dt>
  1119. <dd><code>requestParam</code> - <a href="../param/collection/RenameCollectionParam.html" title="class in io.milvus.param.collection"><code>RenameCollectionParam</code></a></dd>
  1120. <dt><span class="returnLabel">Returns:</span></dt>
  1121. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1122. </dl>
  1123. </li>
  1124. </ul>
  1125. <a id="describeCollection(io.milvus.param.collection.DescribeCollectionParam)">
  1126. <!-- -->
  1127. </a>
  1128. <ul class="blockList">
  1129. <li class="blockList">
  1130. <h4>describeCollection</h4>
  1131. <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>
  1132. <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>
  1133. <div class="block">Shows the details of a collection, e.g. name, schema.</div>
  1134. <dl>
  1135. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1136. <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>
  1137. <dt><span class="paramLabel">Parameters:</span></dt>
  1138. <dd><code>requestParam</code> - <a href="../param/collection/DescribeCollectionParam.html" title="class in io.milvus.param.collection"><code>DescribeCollectionParam</code></a></dd>
  1139. <dt><span class="returnLabel">Returns:</span></dt>
  1140. <dd>{status:result code, data:DescribeCollectionResponse{schema,collectionID}}</dd>
  1141. </dl>
  1142. </li>
  1143. </ul>
  1144. <a id="getCollectionStatistics(io.milvus.param.collection.GetCollectionStatisticsParam)">
  1145. <!-- -->
  1146. </a>
  1147. <ul class="blockList">
  1148. <li class="blockList">
  1149. <h4>getCollectionStatistics</h4>
  1150. <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>
  1151. <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>
  1152. <div class="block">Shows the statistics information of a collection.</div>
  1153. <dl>
  1154. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1155. <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>
  1156. <dt><span class="paramLabel">Parameters:</span></dt>
  1157. <dd><code>requestParam</code> - <a href="../param/collection/GetCollectionStatisticsParam.html" title="class in io.milvus.param.collection"><code>GetCollectionStatisticsParam</code></a></dd>
  1158. <dt><span class="returnLabel">Returns:</span></dt>
  1159. <dd>{status:result code, data: GetCollectionStatisticsResponse{status,stats}}</dd>
  1160. </dl>
  1161. </li>
  1162. </ul>
  1163. <a id="showCollections(io.milvus.param.collection.ShowCollectionsParam)">
  1164. <!-- -->
  1165. </a>
  1166. <ul class="blockList">
  1167. <li class="blockList">
  1168. <h4>showCollections</h4>
  1169. <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>
  1170. <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>
  1171. <div class="block">Lists all collections or gets collection loading status.</div>
  1172. <dl>
  1173. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1174. <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>
  1175. <dt><span class="paramLabel">Parameters:</span></dt>
  1176. <dd><code>requestParam</code> - <a href="../param/collection/ShowCollectionsParam.html" title="class in io.milvus.param.collection"><code>ShowCollectionsParam</code></a></dd>
  1177. <dt><span class="returnLabel">Returns:</span></dt>
  1178. <dd>{status:result code, data: ShowCollectionsResponse{status,collection_names,collection_ids,created_timestamps,created_utc_timestamps}}</dd>
  1179. </dl>
  1180. </li>
  1181. </ul>
  1182. <a id="alterCollection(io.milvus.param.collection.AlterCollectionParam)">
  1183. <!-- -->
  1184. </a>
  1185. <ul class="blockList">
  1186. <li class="blockList">
  1187. <h4>alterCollection</h4>
  1188. <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>
  1189. <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>
  1190. <div class="block">Alter collection.
  1191. Currently, only support setting collection TTL with key `collection.ttl.seconds`</div>
  1192. <dl>
  1193. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1194. <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>
  1195. <dt><span class="paramLabel">Parameters:</span></dt>
  1196. <dd><code>requestParam</code> - <a href="../param/collection/AlterCollectionParam.html" title="class in io.milvus.param.collection"><code>AlterCollectionParam</code></a></dd>
  1197. <dt><span class="returnLabel">Returns:</span></dt>
  1198. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1199. </dl>
  1200. </li>
  1201. </ul>
  1202. <a id="flush(io.milvus.param.collection.FlushParam)">
  1203. <!-- -->
  1204. </a>
  1205. <ul class="blockList">
  1206. <li class="blockList">
  1207. <h4>flush</h4>
  1208. <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>
  1209. <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>
  1210. <div class="block">Flushes inserted data in buffer into storage.</div>
  1211. <dl>
  1212. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1213. <dd><code><a href="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>
  1214. <dt><span class="paramLabel">Parameters:</span></dt>
  1215. <dd><code>requestParam</code> - <a href="../param/collection/FlushParam.html" title="class in io.milvus.param.collection"><code>FlushParam</code></a></dd>
  1216. <dt><span class="returnLabel">Returns:</span></dt>
  1217. <dd>{status:result code,data: FlushResponse{flush segment ids}}</dd>
  1218. </dl>
  1219. </li>
  1220. </ul>
  1221. <a id="flushAll(boolean,long,long)">
  1222. <!-- -->
  1223. </a>
  1224. <ul class="blockList">
  1225. <li class="blockList">
  1226. <h4>flushAll</h4>
  1227. <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,
  1228. long&nbsp;syncFlushAllWaitingInterval,
  1229. long&nbsp;syncFlushAllTimeout)</pre>
  1230. <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>
  1231. <div class="block">Flush all collections. All insertions, deletions, and upserts before `flushAll` will be synced.</div>
  1232. <dl>
  1233. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1234. <dd><code><a href="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>
  1235. <dt><span class="paramLabel">Parameters:</span></dt>
  1236. <dd><code>syncFlushAll</code> - {flushAll synchronously or asynchronously}</dd>
  1237. <dd><code>syncFlushAllWaitingInterval</code> - {wait intervel when flushAll synchronously}</dd>
  1238. <dd><code>syncFlushAllTimeout</code> - {timeout when flushAll synchronously}</dd>
  1239. <dt><span class="returnLabel">Returns:</span></dt>
  1240. <dd>{status:result code,data: FlushAllResponse{flushAllTs}}</dd>
  1241. </dl>
  1242. </li>
  1243. </ul>
  1244. <a id="createPartition(io.milvus.param.partition.CreatePartitionParam)">
  1245. <!-- -->
  1246. </a>
  1247. <ul class="blockList">
  1248. <li class="blockList">
  1249. <h4>createPartition</h4>
  1250. <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>
  1251. <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>
  1252. <div class="block">Creates a partition in the specified collection.</div>
  1253. <dl>
  1254. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1255. <dd><code><a href="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>
  1256. <dt><span class="paramLabel">Parameters:</span></dt>
  1257. <dd><code>requestParam</code> - <a href="../param/partition/CreatePartitionParam.html" title="class in io.milvus.param.partition"><code>CreatePartitionParam</code></a></dd>
  1258. <dt><span class="returnLabel">Returns:</span></dt>
  1259. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1260. </dl>
  1261. </li>
  1262. </ul>
  1263. <a id="dropPartition(io.milvus.param.partition.DropPartitionParam)">
  1264. <!-- -->
  1265. </a>
  1266. <ul class="blockList">
  1267. <li class="blockList">
  1268. <h4>dropPartition</h4>
  1269. <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>
  1270. <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>
  1271. <div class="block">Drops a partition. Note that this method drops all data in this partition
  1272. and the _default partition cannot be dropped.</div>
  1273. <dl>
  1274. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1275. <dd><code><a href="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>
  1276. <dt><span class="paramLabel">Parameters:</span></dt>
  1277. <dd><code>requestParam</code> - <a href="../param/partition/DropPartitionParam.html" title="class in io.milvus.param.partition"><code>DropPartitionParam</code></a></dd>
  1278. <dt><span class="returnLabel">Returns:</span></dt>
  1279. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1280. </dl>
  1281. </li>
  1282. </ul>
  1283. <a id="hasPartition(io.milvus.param.partition.HasPartitionParam)">
  1284. <!-- -->
  1285. </a>
  1286. <ul class="blockList">
  1287. <li class="blockList">
  1288. <h4>hasPartition</h4>
  1289. <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>
  1290. <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>
  1291. <div class="block">Checks if a partition exists in the specified collection.</div>
  1292. <dl>
  1293. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1294. <dd><code><a href="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>
  1295. <dt><span class="paramLabel">Parameters:</span></dt>
  1296. <dd><code>requestParam</code> - <a href="../param/partition/HasPartitionParam.html" title="class in io.milvus.param.partition"><code>HasPartitionParam</code></a></dd>
  1297. <dt><span class="returnLabel">Returns:</span></dt>
  1298. <dd>{status:result code, data: boolean, whether if has collection or not}</dd>
  1299. </dl>
  1300. </li>
  1301. </ul>
  1302. <a id="loadPartitions(io.milvus.param.partition.LoadPartitionsParam)">
  1303. <!-- -->
  1304. </a>
  1305. <ul class="blockList">
  1306. <li class="blockList">
  1307. <h4>loadPartitions</h4>
  1308. <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>
  1309. <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>
  1310. <div class="block">Loads a partition into memory.</div>
  1311. <dl>
  1312. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1313. <dd><code><a href="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>
  1314. <dt><span class="paramLabel">Parameters:</span></dt>
  1315. <dd><code>requestParam</code> - <a href="../param/partition/LoadPartitionsParam.html" title="class in io.milvus.param.partition"><code>LoadPartitionsParam</code></a></dd>
  1316. <dt><span class="returnLabel">Returns:</span></dt>
  1317. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1318. </dl>
  1319. </li>
  1320. </ul>
  1321. <a id="releasePartitions(io.milvus.param.partition.ReleasePartitionsParam)">
  1322. <!-- -->
  1323. </a>
  1324. <ul class="blockList">
  1325. <li class="blockList">
  1326. <h4>releasePartitions</h4>
  1327. <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>
  1328. <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>
  1329. <div class="block">Releases a partition from memory.</div>
  1330. <dl>
  1331. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1332. <dd><code><a href="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>
  1333. <dt><span class="paramLabel">Parameters:</span></dt>
  1334. <dd><code>requestParam</code> - <a href="../param/partition/ReleasePartitionsParam.html" title="class in io.milvus.param.partition"><code>ReleasePartitionsParam</code></a></dd>
  1335. <dt><span class="returnLabel">Returns:</span></dt>
  1336. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1337. </dl>
  1338. </li>
  1339. </ul>
  1340. <a id="getPartitionStatistics(io.milvus.param.partition.GetPartitionStatisticsParam)">
  1341. <!-- -->
  1342. </a>
  1343. <ul class="blockList">
  1344. <li class="blockList">
  1345. <h4>getPartitionStatistics</h4>
  1346. <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>
  1347. <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>
  1348. <div class="block">Shows the statistics information of a partition.</div>
  1349. <dl>
  1350. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1351. <dd><code><a href="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>
  1352. <dt><span class="paramLabel">Parameters:</span></dt>
  1353. <dd><code>requestParam</code> - <a href="../param/partition/GetPartitionStatisticsParam.html" title="class in io.milvus.param.partition"><code>GetPartitionStatisticsParam</code></a></dd>
  1354. <dt><span class="returnLabel">Returns:</span></dt>
  1355. <dd>{status:result code,data:GetPartitionStatisticsResponse{status,stats}}</dd>
  1356. </dl>
  1357. </li>
  1358. </ul>
  1359. <a id="showPartitions(io.milvus.param.partition.ShowPartitionsParam)">
  1360. <!-- -->
  1361. </a>
  1362. <ul class="blockList">
  1363. <li class="blockList">
  1364. <h4>showPartitions</h4>
  1365. <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>
  1366. <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>
  1367. <div class="block">Shows all partitions in the specified collection.</div>
  1368. <dl>
  1369. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1370. <dd><code><a href="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>
  1371. <dt><span class="paramLabel">Parameters:</span></dt>
  1372. <dd><code>requestParam</code> - <a href="../param/partition/ShowPartitionsParam.html" title="class in io.milvus.param.partition"><code>ShowPartitionsParam</code></a></dd>
  1373. <dt><span class="returnLabel">Returns:</span></dt>
  1374. <dd>{status:result code, data:ShowPartitionsResponse{partition_names,partitionIDs,created_timestamps,created_utc_timestamps}}</dd>
  1375. </dl>
  1376. </li>
  1377. </ul>
  1378. <a id="createAlias(io.milvus.param.alias.CreateAliasParam)">
  1379. <!-- -->
  1380. </a>
  1381. <ul class="blockList">
  1382. <li class="blockList">
  1383. <h4>createAlias</h4>
  1384. <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>
  1385. <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>
  1386. <div class="block">Creates an alias for a collection.
  1387. Alias can be used in search or query to replace the collection name</div>
  1388. <dl>
  1389. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1390. <dd><code><a href="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>
  1391. <dt><span class="paramLabel">Parameters:</span></dt>
  1392. <dd><code>requestParam</code> - <a href="../param/alias/CreateAliasParam.html" title="class in io.milvus.param.alias"><code>CreateAliasParam</code></a></dd>
  1393. <dt><span class="returnLabel">Returns:</span></dt>
  1394. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1395. </dl>
  1396. </li>
  1397. </ul>
  1398. <a id="dropAlias(io.milvus.param.alias.DropAliasParam)">
  1399. <!-- -->
  1400. </a>
  1401. <ul class="blockList">
  1402. <li class="blockList">
  1403. <h4>dropAlias</h4>
  1404. <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>
  1405. <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>
  1406. <div class="block">Drops an alias for the specified collection.</div>
  1407. <dl>
  1408. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1409. <dd><code><a href="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>
  1410. <dt><span class="paramLabel">Parameters:</span></dt>
  1411. <dd><code>requestParam</code> - <a href="../param/alias/DropAliasParam.html" title="class in io.milvus.param.alias"><code>DropAliasParam</code></a></dd>
  1412. <dt><span class="returnLabel">Returns:</span></dt>
  1413. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1414. </dl>
  1415. </li>
  1416. </ul>
  1417. <a id="alterAlias(io.milvus.param.alias.AlterAliasParam)">
  1418. <!-- -->
  1419. </a>
  1420. <ul class="blockList">
  1421. <li class="blockList">
  1422. <h4>alterAlias</h4>
  1423. <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>
  1424. <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>
  1425. <div class="block">Alters alias from a collection to another.</div>
  1426. <dl>
  1427. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1428. <dd><code><a href="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>
  1429. <dt><span class="paramLabel">Parameters:</span></dt>
  1430. <dd><code>requestParam</code> - <a href="../param/alias/AlterAliasParam.html" title="class in io.milvus.param.alias"><code>AlterAliasParam</code></a></dd>
  1431. <dt><span class="returnLabel">Returns:</span></dt>
  1432. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1433. </dl>
  1434. </li>
  1435. </ul>
  1436. <a id="createIndex(io.milvus.param.index.CreateIndexParam)">
  1437. <!-- -->
  1438. </a>
  1439. <ul class="blockList">
  1440. <li class="blockList">
  1441. <h4>createIndex</h4>
  1442. <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>
  1443. <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>
  1444. <div class="block">Creates an index on a vector field in the specified collection.
  1445. Note that index building is an async progress.</div>
  1446. <dl>
  1447. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1448. <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>
  1449. <dt><span class="paramLabel">Parameters:</span></dt>
  1450. <dd><code>requestParam</code> - <a href="../param/index/CreateIndexParam.html" title="class in io.milvus.param.index"><code>CreateIndexParam</code></a></dd>
  1451. <dt><span class="returnLabel">Returns:</span></dt>
  1452. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1453. </dl>
  1454. </li>
  1455. </ul>
  1456. <a id="dropIndex(io.milvus.param.index.DropIndexParam)">
  1457. <!-- -->
  1458. </a>
  1459. <ul class="blockList">
  1460. <li class="blockList">
  1461. <h4>dropIndex</h4>
  1462. <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>
  1463. <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>
  1464. <div class="block">Drops the index on a vector field in the specified collection.</div>
  1465. <dl>
  1466. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1467. <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>
  1468. <dt><span class="paramLabel">Parameters:</span></dt>
  1469. <dd><code>requestParam</code> - <a href="../param/index/DropIndexParam.html" title="class in io.milvus.param.index"><code>DropIndexParam</code></a></dd>
  1470. <dt><span class="returnLabel">Returns:</span></dt>
  1471. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1472. </dl>
  1473. </li>
  1474. </ul>
  1475. <a id="describeIndex(io.milvus.param.index.DescribeIndexParam)">
  1476. <!-- -->
  1477. </a>
  1478. <ul class="blockList">
  1479. <li class="blockList">
  1480. <h4>describeIndex</h4>
  1481. <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>
  1482. <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>
  1483. <div class="block">Shows the information of the specified index. Current release of Milvus
  1484. only supports showing latest built index.</div>
  1485. <dl>
  1486. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1487. <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>
  1488. <dt><span class="paramLabel">Parameters:</span></dt>
  1489. <dd><code>requestParam</code> - <a href="../param/index/DescribeIndexParam.html" title="class in io.milvus.param.index"><code>DescribeIndexParam</code></a></dd>
  1490. <dt><span class="returnLabel">Returns:</span></dt>
  1491. <dd>{status:result code, data:DescribeIndexResponse{status,index_descriptions}}</dd>
  1492. </dl>
  1493. </li>
  1494. </ul>
  1495. <a id="getIndexState(io.milvus.param.index.GetIndexStateParam)">
  1496. <!-- -->
  1497. </a>
  1498. <ul class="blockList">
  1499. <li class="blockList">
  1500. <h4>getIndexState</h4>
  1501. <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>
  1502. <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>
  1503. <div class="block">Shows the index building state(in-progress/finished/failed), and the reason for failure (if any).</div>
  1504. <dl>
  1505. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1506. <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>
  1507. <dt><span class="paramLabel">Parameters:</span></dt>
  1508. <dd><code>requestParam</code> - <a href="../param/index/GetIndexStateParam.html" title="class in io.milvus.param.index"><code>GetIndexStateParam</code></a></dd>
  1509. <dt><span class="returnLabel">Returns:</span></dt>
  1510. <dd>{status:result code, data:GetIndexStateResponse{status,state}}</dd>
  1511. </dl>
  1512. </li>
  1513. </ul>
  1514. <a id="getIndexBuildProgress(io.milvus.param.index.GetIndexBuildProgressParam)">
  1515. <!-- -->
  1516. </a>
  1517. <ul class="blockList">
  1518. <li class="blockList">
  1519. <h4>getIndexBuildProgress</h4>
  1520. <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>
  1521. <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>
  1522. <div class="block">Shows the index building progress, such as how many rows are indexed.</div>
  1523. <dl>
  1524. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1525. <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>
  1526. <dt><span class="paramLabel">Parameters:</span></dt>
  1527. <dd><code>requestParam</code> - <a href="../param/index/GetIndexBuildProgressParam.html" title="class in io.milvus.param.index"><code>GetIndexBuildProgressParam</code></a></dd>
  1528. <dt><span class="returnLabel">Returns:</span></dt>
  1529. <dd>{status:result code, data:GetIndexBuildProgressResponse{status,indexed_rows}}</dd>
  1530. </dl>
  1531. </li>
  1532. </ul>
  1533. <a id="insert(io.milvus.param.dml.InsertParam)">
  1534. <!-- -->
  1535. </a>
  1536. <ul class="blockList">
  1537. <li class="blockList">
  1538. <h4>insert</h4>
  1539. <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>
  1540. <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>
  1541. <div class="block">Inserts entities into a specified collection . Note that you don't need to
  1542. input primary key field if auto_id is enabled.</div>
  1543. <dl>
  1544. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1545. <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>
  1546. <dt><span class="paramLabel">Parameters:</span></dt>
  1547. <dd><code>requestParam</code> - <a href="../param/dml/InsertParam.html" title="class in io.milvus.param.dml"><code>InsertParam</code></a></dd>
  1548. <dt><span class="returnLabel">Returns:</span></dt>
  1549. <dd>{status:result code, data: MutationResult{insert results}}</dd>
  1550. </dl>
  1551. </li>
  1552. </ul>
  1553. <a id="insertAsync(io.milvus.param.dml.InsertParam)">
  1554. <!-- -->
  1555. </a>
  1556. <ul class="blockList">
  1557. <li class="blockList">
  1558. <h4>insertAsync</h4>
  1559. <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>
  1560. <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>
  1561. <div class="block">Inserts entities into a specified collection asynchronously. Note that you don't need to
  1562. input primary key field if auto_id is enabled.</div>
  1563. <dl>
  1564. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1565. <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>
  1566. <dt><span class="paramLabel">Parameters:</span></dt>
  1567. <dd><code>requestParam</code> - <a href="../param/dml/InsertParam.html" title="class in io.milvus.param.dml"><code>InsertParam</code></a></dd>
  1568. <dt><span class="returnLabel">Returns:</span></dt>
  1569. <dd>a <code>ListenableFuture</code> object which holds the object {status:result code, data: MutationResult{insert results}}</dd>
  1570. </dl>
  1571. </li>
  1572. </ul>
  1573. <a id="upsert(io.milvus.param.dml.UpsertParam)">
  1574. <!-- -->
  1575. </a>
  1576. <ul class="blockList">
  1577. <li class="blockList">
  1578. <h4>upsert</h4>
  1579. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.MutationResult&gt;&nbsp;upsert&#8203;(<a href="../param/dml/UpsertParam.html" title="class in io.milvus.param.dml">UpsertParam</a>&nbsp;requestParam)</pre>
  1580. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#upsert(io.milvus.param.dml.UpsertParam)">MilvusClient</a></code></span></div>
  1581. <div class="block">Insert new entities into a specified collection, replace them if the entities already exist.</div>
  1582. <dl>
  1583. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1584. <dd><code><a href="MilvusClient.html#upsert(io.milvus.param.dml.UpsertParam)">upsert</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1585. <dt><span class="paramLabel">Parameters:</span></dt>
  1586. <dd><code>requestParam</code> - <a href="../param/dml/UpsertParam.html" title="class in io.milvus.param.dml"><code>UpsertParam</code></a></dd>
  1587. <dt><span class="returnLabel">Returns:</span></dt>
  1588. <dd>{status:result code, data: MutationResult{insert results}}</dd>
  1589. </dl>
  1590. </li>
  1591. </ul>
  1592. <a id="upsertAsync(io.milvus.param.dml.UpsertParam)">
  1593. <!-- -->
  1594. </a>
  1595. <ul class="blockList">
  1596. <li class="blockList">
  1597. <h4>upsertAsync</h4>
  1598. <pre class="methodSignature">public&nbsp;com.google.common.util.concurrent.ListenableFuture&lt;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.MutationResult&gt;&gt;&nbsp;upsertAsync&#8203;(<a href="../param/dml/UpsertParam.html" title="class in io.milvus.param.dml">UpsertParam</a>&nbsp;requestParam)</pre>
  1599. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#upsertAsync(io.milvus.param.dml.UpsertParam)">MilvusClient</a></code></span></div>
  1600. <div class="block">Insert new entities into a specified collection asynchronously, replace them if the entities already exist.</div>
  1601. <dl>
  1602. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1603. <dd><code><a href="MilvusClient.html#upsertAsync(io.milvus.param.dml.UpsertParam)">upsertAsync</a></code>&nbsp;in interface&nbsp;<code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
  1604. <dt><span class="paramLabel">Parameters:</span></dt>
  1605. <dd><code>requestParam</code> - <a href="../param/dml/UpsertParam.html" title="class in io.milvus.param.dml"><code>UpsertParam</code></a></dd>
  1606. <dt><span class="returnLabel">Returns:</span></dt>
  1607. <dd>a <code>ListenableFuture</code> object which holds the object {status:result code, data: MutationResult{insert results}}</dd>
  1608. </dl>
  1609. </li>
  1610. </ul>
  1611. <a id="delete(io.milvus.param.dml.DeleteParam)">
  1612. <!-- -->
  1613. </a>
  1614. <ul class="blockList">
  1615. <li class="blockList">
  1616. <h4>delete</h4>
  1617. <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>
  1618. <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>
  1619. <div class="block">Deletes entity(s) based on primary key(s) filtered by boolean expression. Current release
  1620. of Milvus only supports expression in the format "pk_field in [1, 2, ...]"</div>
  1621. <dl>
  1622. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1623. <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>
  1624. <dt><span class="paramLabel">Parameters:</span></dt>
  1625. <dd><code>requestParam</code> - <a href="../param/dml/DeleteParam.html" title="class in io.milvus.param.dml"><code>DeleteParam</code></a></dd>
  1626. <dt><span class="returnLabel">Returns:</span></dt>
  1627. <dd>{status:result code, data: MutationResult{delete results}}</dd>
  1628. </dl>
  1629. </li>
  1630. </ul>
  1631. <a id="search(io.milvus.param.dml.SearchParam)">
  1632. <!-- -->
  1633. </a>
  1634. <ul class="blockList">
  1635. <li class="blockList">
  1636. <h4>search</h4>
  1637. <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>
  1638. <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>
  1639. <div class="block">Conducts ANN search on a vector field. Use expression to do filtering before search.</div>
  1640. <dl>
  1641. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1642. <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>
  1643. <dt><span class="paramLabel">Parameters:</span></dt>
  1644. <dd><code>requestParam</code> - <a href="../param/dml/SearchParam.html" title="class in io.milvus.param.dml"><code>SearchParam</code></a></dd>
  1645. <dt><span class="returnLabel">Returns:</span></dt>
  1646. <dd>{status:result code, data: SearchResults{topK results}}</dd>
  1647. </dl>
  1648. </li>
  1649. </ul>
  1650. <a id="searchAsync(io.milvus.param.dml.SearchParam)">
  1651. <!-- -->
  1652. </a>
  1653. <ul class="blockList">
  1654. <li class="blockList">
  1655. <h4>searchAsync</h4>
  1656. <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>
  1657. <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>
  1658. <div class="block">Conducts ANN search on a vector field asynchronously. Use expression to do filtering before search.</div>
  1659. <dl>
  1660. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1661. <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>
  1662. <dt><span class="paramLabel">Parameters:</span></dt>
  1663. <dd><code>requestParam</code> - <a href="../param/dml/SearchParam.html" title="class in io.milvus.param.dml"><code>SearchParam</code></a></dd>
  1664. <dt><span class="returnLabel">Returns:</span></dt>
  1665. <dd>a <code>ListenableFuture</code> object which holds the object {status:result code, data: SearchResults{topK results}}</dd>
  1666. </dl>
  1667. </li>
  1668. </ul>
  1669. <a id="query(io.milvus.param.dml.QueryParam)">
  1670. <!-- -->
  1671. </a>
  1672. <ul class="blockList">
  1673. <li class="blockList">
  1674. <h4>query</h4>
  1675. <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>
  1676. <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>
  1677. <div class="block">Queries entity(s) based on scalar field(s) filtered by boolean expression.
  1678. Note that the order of the returned entities cannot be guaranteed.</div>
  1679. <dl>
  1680. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1681. <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>
  1682. <dt><span class="paramLabel">Parameters:</span></dt>
  1683. <dd><code>requestParam</code> - <a href="../param/dml/QueryParam.html" title="class in io.milvus.param.dml"><code>QueryParam</code></a></dd>
  1684. <dt><span class="returnLabel">Returns:</span></dt>
  1685. <dd>{status:result code,data: QueryResults{filter results}}</dd>
  1686. </dl>
  1687. </li>
  1688. </ul>
  1689. <a id="queryAsync(io.milvus.param.dml.QueryParam)">
  1690. <!-- -->
  1691. </a>
  1692. <ul class="blockList">
  1693. <li class="blockList">
  1694. <h4>queryAsync</h4>
  1695. <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>
  1696. <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>
  1697. <div class="block">Queries entity(s) asynchronously based on scalar field(s) filtered by boolean expression.
  1698. Note that the order of the returned entities cannot be guaranteed.</div>
  1699. <dl>
  1700. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1701. <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>
  1702. <dt><span class="paramLabel">Parameters:</span></dt>
  1703. <dd><code>requestParam</code> - <a href="../param/dml/QueryParam.html" title="class in io.milvus.param.dml"><code>QueryParam</code></a></dd>
  1704. <dt><span class="returnLabel">Returns:</span></dt>
  1705. <dd>{status:result code,data: QueryResults{filter results}}</dd>
  1706. </dl>
  1707. </li>
  1708. </ul>
  1709. <a id="getMetrics(io.milvus.param.control.GetMetricsParam)">
  1710. <!-- -->
  1711. </a>
  1712. <ul class="blockList">
  1713. <li class="blockList">
  1714. <h4>getMetrics</h4>
  1715. <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>
  1716. <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>
  1717. <div class="block">Gets the runtime metrics information of Milvus, returns the result in .json format.</div>
  1718. <dl>
  1719. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1720. <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>
  1721. <dt><span class="paramLabel">Parameters:</span></dt>
  1722. <dd><code>requestParam</code> - <a href="../param/control/GetMetricsParam.html" title="class in io.milvus.param.control"><code>GetMetricsParam</code></a></dd>
  1723. <dt><span class="returnLabel">Returns:</span></dt>
  1724. <dd>{status:result code, data:GetMetricsResponse{status,metrics}}</dd>
  1725. </dl>
  1726. </li>
  1727. </ul>
  1728. <a id="getFlushState(io.milvus.param.control.GetFlushStateParam)">
  1729. <!-- -->
  1730. </a>
  1731. <ul class="blockList">
  1732. <li class="blockList">
  1733. <h4>getFlushState</h4>
  1734. <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>
  1735. <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>
  1736. <div class="block">Get flush state of specified collection.</div>
  1737. <dl>
  1738. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1739. <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>
  1740. <dt><span class="paramLabel">Parameters:</span></dt>
  1741. <dd><code>requestParam</code> - <a href="../param/control/GetFlushStateParam.html" title="class in io.milvus.param.control"><code>GetFlushStateParam</code></a></dd>
  1742. <dt><span class="returnLabel">Returns:</span></dt>
  1743. <dd>{status:result code, data:GetMetricsResponse{status,metrics}}</dd>
  1744. </dl>
  1745. </li>
  1746. </ul>
  1747. <a id="getFlushAllState(io.milvus.param.control.GetFlushAllStateParam)">
  1748. <!-- -->
  1749. </a>
  1750. <ul class="blockList">
  1751. <li class="blockList">
  1752. <h4>getFlushAllState</h4>
  1753. <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>
  1754. <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>
  1755. <div class="block">Get flush state of all segments.</div>
  1756. <dl>
  1757. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1758. <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>
  1759. <dt><span class="paramLabel">Parameters:</span></dt>
  1760. <dd><code>requestParam</code> - <a href="../param/control/GetFlushAllStateParam.html" title="class in io.milvus.param.control"><code>GetFlushAllStateParam</code></a></dd>
  1761. <dt><span class="returnLabel">Returns:</span></dt>
  1762. <dd>{status:result code, data:GetMetricsResponse{status,metrics}}</dd>
  1763. </dl>
  1764. </li>
  1765. </ul>
  1766. <a id="getPersistentSegmentInfo(io.milvus.param.control.GetPersistentSegmentInfoParam)">
  1767. <!-- -->
  1768. </a>
  1769. <ul class="blockList">
  1770. <li class="blockList">
  1771. <h4>getPersistentSegmentInfo</h4>
  1772. <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>
  1773. <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>
  1774. <div class="block">Gets the information of persistent segments from data node, including row count,
  1775. persistence state(growing or flushed), etc.</div>
  1776. <dl>
  1777. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1778. <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>
  1779. <dt><span class="paramLabel">Parameters:</span></dt>
  1780. <dd><code>requestParam</code> - <a href="../param/control/GetPersistentSegmentInfoParam.html" title="class in io.milvus.param.control"><code>GetPersistentSegmentInfoParam</code></a></dd>
  1781. <dt><span class="returnLabel">Returns:</span></dt>
  1782. <dd>{status:result code, data:GetPersistentSegmentInfoResponse{status,info}}</dd>
  1783. </dl>
  1784. </li>
  1785. </ul>
  1786. <a id="getQuerySegmentInfo(io.milvus.param.control.GetQuerySegmentInfoParam)">
  1787. <!-- -->
  1788. </a>
  1789. <ul class="blockList">
  1790. <li class="blockList">
  1791. <h4>getQuerySegmentInfo</h4>
  1792. <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>
  1793. <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>
  1794. <div class="block">Gets the query information of segments in a collection from query node, including row count,
  1795. memory usage size, index name, etc.</div>
  1796. <dl>
  1797. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1798. <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>
  1799. <dt><span class="paramLabel">Parameters:</span></dt>
  1800. <dd><code>requestParam</code> - <a href="../param/control/GetQuerySegmentInfoParam.html" title="class in io.milvus.param.control"><code>GetQuerySegmentInfoParam</code></a></dd>
  1801. <dt><span class="returnLabel">Returns:</span></dt>
  1802. <dd>{status:result code, data:GetQuerySegmentInfoResponse{status,info}}</dd>
  1803. </dl>
  1804. </li>
  1805. </ul>
  1806. <a id="getReplicas(io.milvus.param.control.GetReplicasParam)">
  1807. <!-- -->
  1808. </a>
  1809. <ul class="blockList">
  1810. <li class="blockList">
  1811. <h4>getReplicas</h4>
  1812. <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>
  1813. <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>
  1814. <div class="block">Returns the collection's replica information</div>
  1815. <dl>
  1816. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1817. <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>
  1818. <dt><span class="paramLabel">Parameters:</span></dt>
  1819. <dd><code>requestParam</code> - <a href="../param/control/GetReplicasParam.html" title="class in io.milvus.param.control"><code>GetReplicasParam</code></a></dd>
  1820. <dt><span class="returnLabel">Returns:</span></dt>
  1821. <dd>{status:result code, data:GetReplicasResponse{status,info}}</dd>
  1822. </dl>
  1823. </li>
  1824. </ul>
  1825. <a id="loadBalance(io.milvus.param.control.LoadBalanceParam)">
  1826. <!-- -->
  1827. </a>
  1828. <ul class="blockList">
  1829. <li class="blockList">
  1830. <h4>loadBalance</h4>
  1831. <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>
  1832. <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>
  1833. <div class="block">Moves segment from a query node to another to keep the load balanced.</div>
  1834. <dl>
  1835. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1836. <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>
  1837. <dt><span class="paramLabel">Parameters:</span></dt>
  1838. <dd><code>requestParam</code> - <a href="../param/control/LoadBalanceParam.html" title="class in io.milvus.param.control"><code>LoadBalanceParam</code></a></dd>
  1839. <dt><span class="returnLabel">Returns:</span></dt>
  1840. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1841. </dl>
  1842. </li>
  1843. </ul>
  1844. <a id="getCompactionState(io.milvus.param.control.GetCompactionStateParam)">
  1845. <!-- -->
  1846. </a>
  1847. <ul class="blockList">
  1848. <li class="blockList">
  1849. <h4>getCompactionState</h4>
  1850. <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>
  1851. <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>
  1852. <div class="block">Gets the compaction state by id.</div>
  1853. <dl>
  1854. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1855. <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>
  1856. <dt><span class="paramLabel">Parameters:</span></dt>
  1857. <dd><code>requestParam</code> - <a href="../param/control/GetCompactionStateParam.html" title="class in io.milvus.param.control"><code>GetCompactionStateParam</code></a></dd>
  1858. <dt><span class="returnLabel">Returns:</span></dt>
  1859. <dd>{status:result code, data:GetCompactionStateResponse{status,info}}</dd>
  1860. </dl>
  1861. </li>
  1862. </ul>
  1863. <a id="manualCompact(io.milvus.param.control.ManualCompactParam)">
  1864. <!-- -->
  1865. </a>
  1866. <ul class="blockList">
  1867. <li class="blockList">
  1868. <h4>manualCompact</h4>
  1869. <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>
  1870. <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>
  1871. <div class="block">Performs a manual compaction.</div>
  1872. <dl>
  1873. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1874. <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>
  1875. <dt><span class="paramLabel">Parameters:</span></dt>
  1876. <dd><code>requestParam</code> - <a href="../param/control/ManualCompactParam.html" title="class in io.milvus.param.control"><code>ManualCompactParam</code></a></dd>
  1877. <dt><span class="returnLabel">Returns:</span></dt>
  1878. <dd>{status:result code, data:ManualCompactionResponse{status,info}}</dd>
  1879. </dl>
  1880. </li>
  1881. </ul>
  1882. <a id="getCompactionStateWithPlans(io.milvus.param.control.GetCompactionPlansParam)">
  1883. <!-- -->
  1884. </a>
  1885. <ul class="blockList">
  1886. <li class="blockList">
  1887. <h4>getCompactionStateWithPlans</h4>
  1888. <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>
  1889. <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>
  1890. <div class="block">Gets compaction state with its plan.</div>
  1891. <dl>
  1892. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1893. <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>
  1894. <dt><span class="paramLabel">Parameters:</span></dt>
  1895. <dd><code>requestParam</code> - <a href="../param/control/GetCompactionPlansParam.html" title="class in io.milvus.param.control"><code>GetCompactionPlansParam</code></a></dd>
  1896. <dt><span class="returnLabel">Returns:</span></dt>
  1897. <dd>{status:result code, data:GetCompactionPlansResponse{status,info}}</dd>
  1898. </dl>
  1899. </li>
  1900. </ul>
  1901. <a id="createCredential(io.milvus.param.credential.CreateCredentialParam)">
  1902. <!-- -->
  1903. </a>
  1904. <ul class="blockList">
  1905. <li class="blockList">
  1906. <h4>createCredential</h4>
  1907. <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>
  1908. <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>
  1909. <div class="block">Create credential using the given user and password.</div>
  1910. <dl>
  1911. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1912. <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>
  1913. <dt><span class="paramLabel">Parameters:</span></dt>
  1914. <dd><code>requestParam</code> - <a href="../param/credential/CreateCredentialParam.html" title="class in io.milvus.param.credential"><code>CreateCredentialParam</code></a></dd>
  1915. <dt><span class="returnLabel">Returns:</span></dt>
  1916. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1917. </dl>
  1918. </li>
  1919. </ul>
  1920. <a id="updateCredential(io.milvus.param.credential.UpdateCredentialParam)">
  1921. <!-- -->
  1922. </a>
  1923. <ul class="blockList">
  1924. <li class="blockList">
  1925. <h4>updateCredential</h4>
  1926. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;updateCredential&#8203;(<a href="../param/credential/UpdateCredentialParam.html" title="class in io.milvus.param.credential">UpdateCredentialParam</a>&nbsp;requestParam)</pre>
  1927. <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>
  1928. <div class="block">Update credential using the given user and password.
  1929. You must provide the original password to check if the operation is valid.
  1930. Note: after this operation, client won't change the related header of this connection.
  1931. So if you update credential for this connection, the connection may be invalid.</div>
  1932. <dl>
  1933. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1934. <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>
  1935. <dt><span class="paramLabel">Parameters:</span></dt>
  1936. <dd><code>requestParam</code> - <a href="../param/credential/UpdateCredentialParam.html" title="class in io.milvus.param.credential"><code>UpdateCredentialParam</code></a></dd>
  1937. <dt><span class="returnLabel">Returns:</span></dt>
  1938. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1939. </dl>
  1940. </li>
  1941. </ul>
  1942. <a id="deleteCredential(io.milvus.param.credential.DeleteCredentialParam)">
  1943. <!-- -->
  1944. </a>
  1945. <ul class="blockList">
  1946. <li class="blockList">
  1947. <h4>deleteCredential</h4>
  1948. <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>
  1949. <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>
  1950. <div class="block">Delete credential corresponding to the user.</div>
  1951. <dl>
  1952. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1953. <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>
  1954. <dt><span class="paramLabel">Parameters:</span></dt>
  1955. <dd><code>requestParam</code> - <a href="../param/credential/DeleteCredentialParam.html" title="class in io.milvus.param.credential"><code>DeleteCredentialParam</code></a></dd>
  1956. <dt><span class="returnLabel">Returns:</span></dt>
  1957. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1958. </dl>
  1959. </li>
  1960. </ul>
  1961. <a id="listCredUsers(io.milvus.param.credential.ListCredUsersParam)">
  1962. <!-- -->
  1963. </a>
  1964. <ul class="blockList">
  1965. <li class="blockList">
  1966. <h4>listCredUsers</h4>
  1967. <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>
  1968. <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>
  1969. <div class="block">List all user names.</div>
  1970. <dl>
  1971. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1972. <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>
  1973. <dt><span class="paramLabel">Parameters:</span></dt>
  1974. <dd><code>requestParam</code> - <a href="../param/credential/ListCredUsersParam.html" title="class in io.milvus.param.credential"><code>ListCredUsersParam</code></a></dd>
  1975. <dt><span class="returnLabel">Returns:</span></dt>
  1976. <dd>{status:result code, data:ListCredUsersResponse{status,info}}</dd>
  1977. </dl>
  1978. </li>
  1979. </ul>
  1980. <a id="createRole(io.milvus.param.role.CreateRoleParam)">
  1981. <!-- -->
  1982. </a>
  1983. <ul class="blockList">
  1984. <li class="blockList">
  1985. <h4>createRole</h4>
  1986. <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>
  1987. <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>
  1988. <div class="block">It will success if the role isn't existed, otherwise fail.</div>
  1989. <dl>
  1990. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  1991. <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>
  1992. <dt><span class="paramLabel">Parameters:</span></dt>
  1993. <dd><code>requestParam</code> - <a href="../param/role/CreateRoleParam.html" title="class in io.milvus.param.role"><code>CreateRoleParam</code></a></dd>
  1994. <dt><span class="returnLabel">Returns:</span></dt>
  1995. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1996. </dl>
  1997. </li>
  1998. </ul>
  1999. <a id="dropRole(io.milvus.param.role.DropRoleParam)">
  2000. <!-- -->
  2001. </a>
  2002. <ul class="blockList">
  2003. <li class="blockList">
  2004. <h4>dropRole</h4>
  2005. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;dropRole&#8203;(<a href="../param/role/DropRoleParam.html" title="class in io.milvus.param.role">DropRoleParam</a>&nbsp;requestParam)</pre>
  2006. <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>
  2007. <div class="block">It will success if the role is existed, otherwise fail.</div>
  2008. <dl>
  2009. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2010. <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>
  2011. <dt><span class="paramLabel">Parameters:</span></dt>
  2012. <dd><code>requestParam</code> - <a href="../param/role/DropRoleParam.html" title="class in io.milvus.param.role"><code>DropRoleParam</code></a></dd>
  2013. <dt><span class="returnLabel">Returns:</span></dt>
  2014. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  2015. </dl>
  2016. </li>
  2017. </ul>
  2018. <a id="addUserToRole(io.milvus.param.role.AddUserToRoleParam)">
  2019. <!-- -->
  2020. </a>
  2021. <ul class="blockList">
  2022. <li class="blockList">
  2023. <h4>addUserToRole</h4>
  2024. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;addUserToRole&#8203;(<a href="../param/role/AddUserToRoleParam.html" title="class in io.milvus.param.role">AddUserToRoleParam</a>&nbsp;requestParam)</pre>
  2025. <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>
  2026. <div class="block">The user will get permissions that the role are allowed to perform operations.</div>
  2027. <dl>
  2028. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2029. <dd><code><a href="MilvusClient.html#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>
  2030. <dt><span class="paramLabel">Parameters:</span></dt>
  2031. <dd><code>requestParam</code> - <a href="../param/role/AddUserToRoleParam.html" title="class in io.milvus.param.role"><code>AddUserToRoleParam</code></a></dd>
  2032. <dt><span class="returnLabel">Returns:</span></dt>
  2033. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  2034. </dl>
  2035. </li>
  2036. </ul>
  2037. <a id="removeUserFromRole(io.milvus.param.role.RemoveUserFromRoleParam)">
  2038. <!-- -->
  2039. </a>
  2040. <ul class="blockList">
  2041. <li class="blockList">
  2042. <h4>removeUserFromRole</h4>
  2043. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;removeUserFromRole&#8203;(<a href="../param/role/RemoveUserFromRoleParam.html" title="class in io.milvus.param.role">RemoveUserFromRoleParam</a>&nbsp;requestParam)</pre>
  2044. <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>
  2045. <div class="block">The user will remove permissions that the role are allowed to perform operations.</div>
  2046. <dl>
  2047. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2048. <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>
  2049. <dt><span class="paramLabel">Parameters:</span></dt>
  2050. <dd><code>requestParam</code> - <a href="../param/role/AddUserToRoleParam.html" title="class in io.milvus.param.role"><code>AddUserToRoleParam</code></a></dd>
  2051. <dt><span class="returnLabel">Returns:</span></dt>
  2052. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  2053. </dl>
  2054. </li>
  2055. </ul>
  2056. <a id="selectRole(io.milvus.param.role.SelectRoleParam)">
  2057. <!-- -->
  2058. </a>
  2059. <ul class="blockList">
  2060. <li class="blockList">
  2061. <h4>selectRole</h4>
  2062. <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>
  2063. <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>
  2064. <div class="block">Get all users who are added to the role.</div>
  2065. <dl>
  2066. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2067. <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>
  2068. <dt><span class="paramLabel">Parameters:</span></dt>
  2069. <dd><code>requestParam</code> - <a href="../param/role/SelectRoleParam.html" title="class in io.milvus.param.role"><code>SelectRoleParam</code></a></dd>
  2070. <dt><span class="returnLabel">Returns:</span></dt>
  2071. <dd>{status:result code, data:SelectRoleResponse{status,info}}</dd>
  2072. </dl>
  2073. </li>
  2074. </ul>
  2075. <a id="selectUser(io.milvus.param.role.SelectUserParam)">
  2076. <!-- -->
  2077. </a>
  2078. <ul class="blockList">
  2079. <li class="blockList">
  2080. <h4>selectUser</h4>
  2081. <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>
  2082. <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>
  2083. <div class="block">Get all roles the user has.</div>
  2084. <dl>
  2085. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2086. <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>
  2087. <dt><span class="paramLabel">Parameters:</span></dt>
  2088. <dd><code>requestParam</code> - <a href="../param/role/SelectUserParam.html" title="class in io.milvus.param.role"><code>SelectUserParam</code></a></dd>
  2089. <dt><span class="returnLabel">Returns:</span></dt>
  2090. <dd>{status:result code, data:SelectUserResponse{status,info}}</dd>
  2091. </dl>
  2092. </li>
  2093. </ul>
  2094. <a id="grantRolePrivilege(io.milvus.param.role.GrantRolePrivilegeParam)">
  2095. <!-- -->
  2096. </a>
  2097. <ul class="blockList">
  2098. <li class="blockList">
  2099. <h4>grantRolePrivilege</h4>
  2100. <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>
  2101. <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>
  2102. <div class="block">Grant Role Privilege.</div>
  2103. <dl>
  2104. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2105. <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>
  2106. <dt><span class="paramLabel">Parameters:</span></dt>
  2107. <dd><code>requestParam</code> - <a href="../param/role/GrantRolePrivilegeParam.html" title="class in io.milvus.param.role"><code>GrantRolePrivilegeParam</code></a></dd>
  2108. <dt><span class="returnLabel">Returns:</span></dt>
  2109. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  2110. </dl>
  2111. </li>
  2112. </ul>
  2113. <a id="revokeRolePrivilege(io.milvus.param.role.RevokeRolePrivilegeParam)">
  2114. <!-- -->
  2115. </a>
  2116. <ul class="blockList">
  2117. <li class="blockList">
  2118. <h4>revokeRolePrivilege</h4>
  2119. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;revokeRolePrivilege&#8203;(<a href="../param/role/RevokeRolePrivilegeParam.html" title="class in io.milvus.param.role">RevokeRolePrivilegeParam</a>&nbsp;requestParam)</pre>
  2120. <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>
  2121. <div class="block">Revoke Role Privilege.</div>
  2122. <dl>
  2123. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2124. <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>
  2125. <dt><span class="paramLabel">Parameters:</span></dt>
  2126. <dd><code>requestParam</code> - <a href="../param/role/RevokeRolePrivilegeParam.html" title="class in io.milvus.param.role"><code>RevokeRolePrivilegeParam</code></a></dd>
  2127. <dt><span class="returnLabel">Returns:</span></dt>
  2128. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  2129. </dl>
  2130. </li>
  2131. </ul>
  2132. <a id="selectGrantForRole(io.milvus.param.role.SelectGrantForRoleParam)">
  2133. <!-- -->
  2134. </a>
  2135. <ul class="blockList">
  2136. <li class="blockList">
  2137. <h4>selectGrantForRole</h4>
  2138. <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>
  2139. <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>
  2140. <div class="block">List a grant info for the role and the specific object</div>
  2141. <dl>
  2142. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2143. <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>
  2144. <dt><span class="paramLabel">Parameters:</span></dt>
  2145. <dd><code>requestParam</code> - <a href="../param/role/SelectGrantForRoleParam.html" title="class in io.milvus.param.role"><code>SelectGrantForRoleParam</code></a></dd>
  2146. <dt><span class="returnLabel">Returns:</span></dt>
  2147. <dd>{status:result code, data:SelectRoleResponse{status,info}}</dd>
  2148. </dl>
  2149. </li>
  2150. </ul>
  2151. <a id="selectGrantForRoleAndObject(io.milvus.param.role.SelectGrantForRoleAndObjectParam)">
  2152. <!-- -->
  2153. </a>
  2154. <ul class="blockList">
  2155. <li class="blockList">
  2156. <h4>selectGrantForRoleAndObject</h4>
  2157. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.SelectGrantResponse&gt;&nbsp;selectGrantForRoleAndObject&#8203;(<a href="../param/role/SelectGrantForRoleAndObjectParam.html" title="class in io.milvus.param.role">SelectGrantForRoleAndObjectParam</a>&nbsp;requestParam)</pre>
  2158. <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>
  2159. <div class="block">List a grant info for the role</div>
  2160. <dl>
  2161. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2162. <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>
  2163. <dt><span class="paramLabel">Parameters:</span></dt>
  2164. <dd><code>requestParam</code> - <a href="../param/role/SelectGrantForRoleAndObjectParam.html" title="class in io.milvus.param.role"><code>SelectGrantForRoleAndObjectParam</code></a></dd>
  2165. <dt><span class="returnLabel">Returns:</span></dt>
  2166. <dd>{status:result code, data:SelectRoleResponse{status,info}}</dd>
  2167. </dl>
  2168. </li>
  2169. </ul>
  2170. <a id="bulkInsert(io.milvus.param.bulkinsert.BulkInsertParam)">
  2171. <!-- -->
  2172. </a>
  2173. <ul class="blockList">
  2174. <li class="blockList">
  2175. <h4>bulkInsert</h4>
  2176. <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>
  2177. <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>
  2178. <div class="block">Import data from external files, currently support JSON format</div>
  2179. <dl>
  2180. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2181. <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>
  2182. <dt><span class="paramLabel">Parameters:</span></dt>
  2183. <dd><code>requestParam</code> - <a href="../param/bulkinsert/BulkInsertParam.html" title="class in io.milvus.param.bulkinsert"><code>BulkInsertParam</code></a></dd>
  2184. <dt><span class="returnLabel">Returns:</span></dt>
  2185. <dd>{status:result code, data:ImportResponse{status,info}}</dd>
  2186. </dl>
  2187. </li>
  2188. </ul>
  2189. <a id="getBulkInsertState(io.milvus.param.bulkinsert.GetBulkInsertStateParam)">
  2190. <!-- -->
  2191. </a>
  2192. <ul class="blockList">
  2193. <li class="blockList">
  2194. <h4>getBulkInsertState</h4>
  2195. <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>
  2196. <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>
  2197. <div class="block">Get state of bulk insert task</div>
  2198. <dl>
  2199. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2200. <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>
  2201. <dt><span class="paramLabel">Parameters:</span></dt>
  2202. <dd><code>requestParam</code> - <a href="../param/bulkinsert/GetBulkInsertStateParam.html" title="class in io.milvus.param.bulkinsert"><code>GetBulkInsertStateParam</code></a></dd>
  2203. <dt><span class="returnLabel">Returns:</span></dt>
  2204. <dd>{status:result code, data:GetImportStateResponse{status,info}}</dd>
  2205. </dl>
  2206. </li>
  2207. </ul>
  2208. <a id="listBulkInsertTasks(io.milvus.param.bulkinsert.ListBulkInsertTasksParam)">
  2209. <!-- -->
  2210. </a>
  2211. <ul class="blockList">
  2212. <li class="blockList">
  2213. <h4>listBulkInsertTasks</h4>
  2214. <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>
  2215. <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>
  2216. <div class="block">List bulk insert tasks</div>
  2217. <dl>
  2218. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2219. <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>
  2220. <dt><span class="paramLabel">Parameters:</span></dt>
  2221. <dd><code>requestParam</code> - <a href="../param/bulkinsert/ListBulkInsertTasksParam.html" title="class in io.milvus.param.bulkinsert"><code>ListBulkInsertTasksParam</code></a></dd>
  2222. <dt><span class="returnLabel">Returns:</span></dt>
  2223. <dd>{status:result code, data:ListImportTasksResponse{status,info}}</dd>
  2224. </dl>
  2225. </li>
  2226. </ul>
  2227. <a id="checkHealth()">
  2228. <!-- -->
  2229. </a>
  2230. <ul class="blockList">
  2231. <li class="blockList">
  2232. <h4>checkHealth</h4>
  2233. <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>
  2234. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#checkHealth()">MilvusClient</a></code></span></div>
  2235. <div class="block">Check server health</div>
  2236. <dl>
  2237. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2238. <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>
  2239. <dt><span class="returnLabel">Returns:</span></dt>
  2240. <dd>{status:result code, data:CheckHealthResponse{status,info}}</dd>
  2241. </dl>
  2242. </li>
  2243. </ul>
  2244. <a id="getVersion()">
  2245. <!-- -->
  2246. </a>
  2247. <ul class="blockList">
  2248. <li class="blockList">
  2249. <h4>getVersion</h4>
  2250. <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>
  2251. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MilvusClient.html#getVersion()">MilvusClient</a></code></span></div>
  2252. <div class="block">Get server version</div>
  2253. <dl>
  2254. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2255. <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>
  2256. <dt><span class="returnLabel">Returns:</span></dt>
  2257. <dd>{status:result code, data:GetVersionResponse{status,info}}</dd>
  2258. </dl>
  2259. </li>
  2260. </ul>
  2261. <a id="getLoadingProgress(io.milvus.param.collection.GetLoadingProgressParam)">
  2262. <!-- -->
  2263. </a>
  2264. <ul class="blockList">
  2265. <li class="blockList">
  2266. <h4>getLoadingProgress</h4>
  2267. <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>
  2268. <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>
  2269. <div class="block">Get collection loading progress</div>
  2270. <dl>
  2271. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2272. <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>
  2273. <dt><span class="paramLabel">Parameters:</span></dt>
  2274. <dd><code>requestParam</code> - <a href="../param/collection/GetLoadingProgressParam.html" title="class in io.milvus.param.collection"><code>GetLoadingProgressParam</code></a></dd>
  2275. <dt><span class="returnLabel">Returns:</span></dt>
  2276. <dd>{status:result code, data:GetLoadingProgressResponse{status}}</dd>
  2277. </dl>
  2278. </li>
  2279. </ul>
  2280. <a id="getLoadState(io.milvus.param.collection.GetLoadStateParam)">
  2281. <!-- -->
  2282. </a>
  2283. <ul class="blockList">
  2284. <li class="blockList">
  2285. <h4>getLoadState</h4>
  2286. <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>
  2287. <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>
  2288. <div class="block">Get collection loading state</div>
  2289. <dl>
  2290. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2291. <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>
  2292. <dt><span class="paramLabel">Parameters:</span></dt>
  2293. <dd><code>requestParam</code> - <a href="../param/collection/GetLoadStateParam.html" title="class in io.milvus.param.collection"><code>GetLoadStateParam</code></a></dd>
  2294. <dt><span class="returnLabel">Returns:</span></dt>
  2295. <dd>{status:result code, data:GetLoadStateResponse{status}}</dd>
  2296. </dl>
  2297. </li>
  2298. </ul>
  2299. <a id="createResourceGroup(io.milvus.param.resourcegroup.CreateResourceGroupParam)">
  2300. <!-- -->
  2301. </a>
  2302. <ul class="blockList">
  2303. <li class="blockList">
  2304. <h4>createResourceGroup</h4>
  2305. <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>
  2306. <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>
  2307. <div class="block">Create a resource group.</div>
  2308. <dl>
  2309. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2310. <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>
  2311. <dt><span class="paramLabel">Parameters:</span></dt>
  2312. <dd><code>requestParam</code> - <a href="../param/resourcegroup/CreateResourceGroupParam.html" title="class in io.milvus.param.resourcegroup"><code>CreateResourceGroupParam</code></a></dd>
  2313. <dt><span class="returnLabel">Returns:</span></dt>
  2314. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  2315. </dl>
  2316. </li>
  2317. </ul>
  2318. <a id="dropResourceGroup(io.milvus.param.resourcegroup.DropResourceGroupParam)">
  2319. <!-- -->
  2320. </a>
  2321. <ul class="blockList">
  2322. <li class="blockList">
  2323. <h4>dropResourceGroup</h4>
  2324. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;dropResourceGroup&#8203;(<a href="../param/resourcegroup/DropResourceGroupParam.html" title="class in io.milvus.param.resourcegroup">DropResourceGroupParam</a>&nbsp;requestParam)</pre>
  2325. <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>
  2326. <div class="block">Drop a resource group.</div>
  2327. <dl>
  2328. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2329. <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>
  2330. <dt><span class="paramLabel">Parameters:</span></dt>
  2331. <dd><code>requestParam</code> - <a href="../param/resourcegroup/DropResourceGroupParam.html" title="class in io.milvus.param.resourcegroup"><code>DropResourceGroupParam</code></a></dd>
  2332. <dt><span class="returnLabel">Returns:</span></dt>
  2333. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  2334. </dl>
  2335. </li>
  2336. </ul>
  2337. <a id="listResourceGroups(io.milvus.param.resourcegroup.ListResourceGroupsParam)">
  2338. <!-- -->
  2339. </a>
  2340. <ul class="blockList">
  2341. <li class="blockList">
  2342. <h4>listResourceGroups</h4>
  2343. <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>
  2344. <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>
  2345. <div class="block">List resource groups.</div>
  2346. <dl>
  2347. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2348. <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>
  2349. <dt><span class="paramLabel">Parameters:</span></dt>
  2350. <dd><code>requestParam</code> - <a href="../param/resourcegroup/ListResourceGroupsParam.html" title="class in io.milvus.param.resourcegroup"><code>ListResourceGroupsParam</code></a></dd>
  2351. <dt><span class="returnLabel">Returns:</span></dt>
  2352. <dd>{status:result code, data:ListResourceGroupsResponse{status}}</dd>
  2353. </dl>
  2354. </li>
  2355. </ul>
  2356. <a id="describeResourceGroup(io.milvus.param.resourcegroup.DescribeResourceGroupParam)">
  2357. <!-- -->
  2358. </a>
  2359. <ul class="blockList">
  2360. <li class="blockList">
  2361. <h4>describeResourceGroup</h4>
  2362. <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>
  2363. <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>
  2364. <div class="block">Describe a resource group.</div>
  2365. <dl>
  2366. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2367. <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>
  2368. <dt><span class="paramLabel">Parameters:</span></dt>
  2369. <dd><code>requestParam</code> - <a href="../param/resourcegroup/DescribeResourceGroupParam.html" title="class in io.milvus.param.resourcegroup"><code>DescribeResourceGroupParam</code></a></dd>
  2370. <dt><span class="returnLabel">Returns:</span></dt>
  2371. <dd>{status:result code, data:DescribeResourceGroupResponse{status}}</dd>
  2372. </dl>
  2373. </li>
  2374. </ul>
  2375. <a id="transferNode(io.milvus.param.resourcegroup.TransferNodeParam)">
  2376. <!-- -->
  2377. </a>
  2378. <ul class="blockList">
  2379. <li class="blockList">
  2380. <h4>transferNode</h4>
  2381. <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>
  2382. <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>
  2383. <div class="block">Transfer a query node from source resource group to target resource_group.</div>
  2384. <dl>
  2385. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2386. <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>
  2387. <dt><span class="paramLabel">Parameters:</span></dt>
  2388. <dd><code>requestParam</code> - <a href="../param/resourcegroup/TransferNodeParam.html" title="class in io.milvus.param.resourcegroup"><code>TransferNodeParam</code></a></dd>
  2389. <dt><span class="returnLabel">Returns:</span></dt>
  2390. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  2391. </dl>
  2392. </li>
  2393. </ul>
  2394. <a id="transferReplica(io.milvus.param.resourcegroup.TransferReplicaParam)">
  2395. <!-- -->
  2396. </a>
  2397. <ul class="blockList">
  2398. <li class="blockList">
  2399. <h4>transferReplica</h4>
  2400. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;transferReplica&#8203;(<a href="../param/resourcegroup/TransferReplicaParam.html" title="class in io.milvus.param.resourcegroup">TransferReplicaParam</a>&nbsp;requestParam)</pre>
  2401. <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>
  2402. <div class="block">Transfer a replica from source resource group to target resource_group.</div>
  2403. <dl>
  2404. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2405. <dd><code><a href="MilvusClient.html#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>
  2406. <dt><span class="paramLabel">Parameters:</span></dt>
  2407. <dd><code>requestParam</code> - <a href="../param/resourcegroup/TransferReplicaParam.html" title="class in io.milvus.param.resourcegroup"><code>TransferReplicaParam</code></a></dd>
  2408. <dt><span class="returnLabel">Returns:</span></dt>
  2409. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  2410. </dl>
  2411. </li>
  2412. </ul>
  2413. <a id="createCollection(io.milvus.param.highlevel.collection.CreateSimpleCollectionParam)">
  2414. <!-- -->
  2415. </a>
  2416. <ul class="blockList">
  2417. <li class="blockList">
  2418. <h4>createCollection</h4>
  2419. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;createCollection&#8203;(<a href="../param/highlevel/collection/CreateSimpleCollectionParam.html" title="class in io.milvus.param.highlevel.collection">CreateSimpleCollectionParam</a>&nbsp;requestParam)</pre>
  2420. <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>
  2421. <div class="block">Creates a collection in Milvus.</div>
  2422. <dl>
  2423. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2424. <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>
  2425. <dt><span class="paramLabel">Parameters:</span></dt>
  2426. <dd><code>requestParam</code> - <a href="../param/highlevel/collection/CreateSimpleCollectionParam.html" title="class in io.milvus.param.highlevel.collection"><code>CreateSimpleCollectionParam</code></a></dd>
  2427. <dt><span class="returnLabel">Returns:</span></dt>
  2428. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  2429. </dl>
  2430. </li>
  2431. </ul>
  2432. <a id="listCollections(io.milvus.param.highlevel.collection.ListCollectionsParam)">
  2433. <!-- -->
  2434. </a>
  2435. <ul class="blockList">
  2436. <li class="blockList">
  2437. <h4>listCollections</h4>
  2438. <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>
  2439. <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>
  2440. <div class="block">Lists all collections</div>
  2441. <dl>
  2442. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2443. <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>
  2444. <dt><span class="paramLabel">Parameters:</span></dt>
  2445. <dd><code>requestParam</code> - <a href="../param/highlevel/collection/ListCollectionsParam.html" title="class in io.milvus.param.highlevel.collection"><code>ListCollectionsParam</code></a></dd>
  2446. <dt><span class="returnLabel">Returns:</span></dt>
  2447. <dd>{status:result code, data: ListCollectionsResponse{collection_names}}</dd>
  2448. </dl>
  2449. </li>
  2450. </ul>
  2451. <a id="insert(io.milvus.param.highlevel.dml.InsertRowsParam)">
  2452. <!-- -->
  2453. </a>
  2454. <ul class="blockList">
  2455. <li class="blockList">
  2456. <h4>insert</h4>
  2457. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/highlevel/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>
  2458. <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>
  2459. <div class="block">Inserts rows data into a specified collection . Note that you don't need to
  2460. input primary key field if auto_id is enabled.</div>
  2461. <dl>
  2462. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2463. <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>
  2464. <dt><span class="paramLabel">Parameters:</span></dt>
  2465. <dd><code>requestParam</code> - <a href="../param/highlevel/dml/InsertRowsParam.html" title="class in io.milvus.param.highlevel.dml"><code>InsertRowsParam</code></a></dd>
  2466. <dt><span class="returnLabel">Returns:</span></dt>
  2467. <dd>{status:result code, data: MutationResult{insert results}}</dd>
  2468. </dl>
  2469. </li>
  2470. </ul>
  2471. <a id="delete(io.milvus.param.highlevel.dml.DeleteIdsParam)">
  2472. <!-- -->
  2473. </a>
  2474. <ul class="blockList">
  2475. <li class="blockList">
  2476. <h4>delete</h4>
  2477. <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>
  2478. <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>
  2479. <div class="block">Deletes entity(s) based on the value of primary key.</div>
  2480. <dl>
  2481. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2482. <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>
  2483. <dt><span class="paramLabel">Parameters:</span></dt>
  2484. <dd><code>requestParam</code> - <a href="../param/highlevel/dml/DeleteIdsParam.html" title="class in io.milvus.param.highlevel.dml"><code>DeleteIdsParam</code></a></dd>
  2485. <dt><span class="returnLabel">Returns:</span></dt>
  2486. <dd>{status:result code, data: MutationResult{delete results}}</dd>
  2487. </dl>
  2488. </li>
  2489. </ul>
  2490. <a id="get(io.milvus.param.highlevel.dml.GetIdsParam)">
  2491. <!-- -->
  2492. </a>
  2493. <ul class="blockList">
  2494. <li class="blockList">
  2495. <h4>get</h4>
  2496. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/highlevel/dml/response/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>
  2497. <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>
  2498. <div class="block">Get entity(s) based on the value of primary key.</div>
  2499. <dl>
  2500. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2501. <dd><code><a href="MilvusClient.html#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>
  2502. <dt><span class="paramLabel">Parameters:</span></dt>
  2503. <dd><code>requestParam</code> - <a href="../param/highlevel/dml/GetIdsParam.html" title="class in io.milvus.param.highlevel.dml"><code>GetIdsParam</code></a></dd>
  2504. <dt><span class="returnLabel">Returns:</span></dt>
  2505. <dd>{status:result code, data: QueryResults{query results}}</dd>
  2506. </dl>
  2507. </li>
  2508. </ul>
  2509. <a id="query(io.milvus.param.highlevel.dml.QuerySimpleParam)">
  2510. <!-- -->
  2511. </a>
  2512. <ul class="blockList">
  2513. <li class="blockList">
  2514. <h4>query</h4>
  2515. <pre class="methodSignature">public&nbsp;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/highlevel/dml/response/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>
  2516. <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>
  2517. <div class="block">Queries entity(s) based on scalar field(s) filtered by boolean expression.
  2518. Note that the order of the returned entities cannot be guaranteed.</div>
  2519. <dl>
  2520. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2521. <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>
  2522. <dt><span class="paramLabel">Parameters:</span></dt>
  2523. <dd><code>requestParam</code> - <a href="../param/highlevel/dml/QuerySimpleParam.html" title="class in io.milvus.param.highlevel.dml"><code>QuerySimpleParam</code></a></dd>
  2524. <dt><span class="returnLabel">Returns:</span></dt>
  2525. <dd>{status:result code,data: QueryResults{filter results}}</dd>
  2526. </dl>
  2527. </li>
  2528. </ul>
  2529. <a id="search(io.milvus.param.highlevel.dml.SearchSimpleParam)">
  2530. <!-- -->
  2531. </a>
  2532. <ul class="blockListLast">
  2533. <li class="blockList">
  2534. <h4>search</h4>
  2535. <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>
  2536. <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>
  2537. <div class="block">Conducts ANN search on a vector field. Use expression to do filtering before search.</div>
  2538. <dl>
  2539. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  2540. <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>
  2541. <dt><span class="paramLabel">Parameters:</span></dt>
  2542. <dd><code>requestParam</code> - <a href="../param/highlevel/dml/SearchSimpleParam.html" title="class in io.milvus.param.highlevel.dml"><code>SearchSimpleParam</code></a></dd>
  2543. <dt><span class="returnLabel">Returns:</span></dt>
  2544. <dd>{status:result code, data: SearchResults{topK results}}</dd>
  2545. </dl>
  2546. </li>
  2547. </ul>
  2548. </li>
  2549. </ul>
  2550. </section>
  2551. </li>
  2552. </ul>
  2553. </div>
  2554. </div>
  2555. </main>
  2556. <!-- ========= END OF CLASS DATA ========= -->
  2557. <footer role="contentinfo">
  2558. <nav role="navigation">
  2559. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  2560. <div class="bottomNav"><a id="navbar.bottom">
  2561. <!-- -->
  2562. </a>
  2563. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  2564. <a id="navbar.bottom.firstrow">
  2565. <!-- -->
  2566. </a>
  2567. <ul class="navList" title="Navigation">
  2568. <li><a href="../../../index.html">Overview</a></li>
  2569. <li><a href="package-summary.html">Package</a></li>
  2570. <li class="navBarCell1Rev">Class</li>
  2571. <li><a href="package-tree.html">Tree</a></li>
  2572. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  2573. <li><a href="../../../index-files/index-1.html">Index</a></li>
  2574. <li><a href="../../../help-doc.html">Help</a></li>
  2575. </ul>
  2576. </div>
  2577. <div class="subNav">
  2578. <ul class="navList" id="allclasses_navbar_bottom">
  2579. <li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
  2580. </ul>
  2581. <div>
  2582. <script type="text/javascript"><!--
  2583. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  2584. if(window==top) {
  2585. allClassesLink.style.display = "block";
  2586. }
  2587. else {
  2588. allClassesLink.style.display = "none";
  2589. }
  2590. //-->
  2591. </script>
  2592. <noscript>
  2593. <div>JavaScript is disabled on your browser.</div>
  2594. </noscript>
  2595. </div>
  2596. <div>
  2597. <ul class="subNavList">
  2598. <li>Summary:&nbsp;</li>
  2599. <li>Nested&nbsp;|&nbsp;</li>
  2600. <li>Field&nbsp;|&nbsp;</li>
  2601. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  2602. <li><a href="#method.summary">Method</a></li>
  2603. </ul>
  2604. <ul class="subNavList">
  2605. <li>Detail:&nbsp;</li>
  2606. <li>Field&nbsp;|&nbsp;</li>
  2607. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  2608. <li><a href="#method.detail">Method</a></li>
  2609. </ul>
  2610. </div>
  2611. <a id="skip.navbar.bottom">
  2612. <!-- -->
  2613. </a></div>
  2614. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  2615. </nav>
  2616. </footer>
  2617. </body>
  2618. </html>