AbstractMilvusGrpcClient.html 216 KB

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