123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751 |
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
- <!-- NewPage -->
- <html lang="en">
- <head>
- <!-- Generated by javadoc (1.8.0_402-402) on Thu Aug 08 18:00:37 CST 2024 -->
- <title>MilvusMultiServiceClient</title>
- <meta name="date" content="2024-08-08">
- <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
- <script type="text/javascript" src="../../../script.js"></script>
- </head>
- <body>
- <script type="text/javascript"><!--
- try {
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="MilvusMultiServiceClient";
- }
- }
- catch(err) {
- }
- //-->
- var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10,"i57":10,"i58":10,"i59":10,"i60":10,"i61":10,"i62":10,"i63":10,"i64":10,"i65":10,"i66":10,"i67":10,"i68":10,"i69":10,"i70":10,"i71":10,"i72":10,"i73":10,"i74":10,"i75":10,"i76":10,"i77":10,"i78":10,"i79":10,"i80":10,"i81":10,"i82":10,"i83":10,"i84":10,"i85":10,"i86":10,"i87":10,"i88":10,"i89":10,"i90":10,"i91":10,"i92":10,"i93":10,"i94":10,"i95":10,"i96":10,"i97":10};
- var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
- var altColor = "altColor";
- var rowColor = "rowColor";
- var tableTab = "tableTab";
- var activeTableTab = "activeTableTab";
- </script>
- <noscript>
- <div>JavaScript is disabled on your browser.</div>
- </noscript>
- <!-- ========= START OF TOP NAVBAR ======= -->
- <div class="topNav"><a name="navbar.top">
- <!-- -->
- </a>
- <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
- <a name="navbar.top.firstrow">
- <!-- -->
- </a>
- <ul class="navList" title="Navigation">
- <li><a href="../../../overview-summary.html">Overview</a></li>
- <li><a href="package-summary.html">Package</a></li>
- <li class="navBarCell1Rev">Class</li>
- <li><a href="package-tree.html">Tree</a></li>
- <li><a href="../../../deprecated-list.html">Deprecated</a></li>
- <li><a href="../../../index-files/index-1.html">Index</a></li>
- <li><a href="../../../help-doc.html">Help</a></li>
- </ul>
- </div>
- <div class="subNav">
- <ul class="navList">
- <li><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client"><span class="typeNameLink">Prev Class</span></a></li>
- <li><a href="../../../io/milvus/client/MilvusServiceClient.html" title="class in io.milvus.client"><span class="typeNameLink">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../../../index.html?io/milvus/client/MilvusMultiServiceClient.html" target="_top">Frames</a></li>
- <li><a href="MilvusMultiServiceClient.html" target="_top">No Frames</a></li>
- </ul>
- <ul class="navList" id="allclasses_navbar_top">
- <li><a href="../../../allclasses-noframe.html">All Classes</a></li>
- </ul>
- <div>
- <script type="text/javascript"><!--
- allClassesLink = document.getElementById("allclasses_navbar_top");
- if(window==top) {
- allClassesLink.style.display = "block";
- }
- else {
- allClassesLink.style.display = "none";
- }
- //-->
- </script>
- </div>
- <div>
- <ul class="subNavList">
- <li>Summary: </li>
- <li>Nested | </li>
- <li>Field | </li>
- <li><a href="#constructor.summary">Constr</a> | </li>
- <li><a href="#method.summary">Method</a></li>
- </ul>
- <ul class="subNavList">
- <li>Detail: </li>
- <li>Field | </li>
- <li><a href="#constructor.detail">Constr</a> | </li>
- <li><a href="#method.detail">Method</a></li>
- </ul>
- </div>
- <a name="skip.navbar.top">
- <!-- -->
- </a></div>
- <!-- ========= END OF TOP NAVBAR ========= -->
- <!-- ======== START OF CLASS DATA ======== -->
- <div class="header">
- <div class="subTitle">io.milvus.client</div>
- <h2 title="Class MilvusMultiServiceClient" class="title">Class MilvusMultiServiceClient</h2>
- </div>
- <div class="contentContainer">
- <ul class="inheritance">
- <li>java.lang.Object</li>
- <li>
- <ul class="inheritance">
- <li>io.milvus.client.MilvusMultiServiceClient</li>
- </ul>
- </li>
- </ul>
- <div class="description">
- <ul class="blockList">
- <li class="blockList">
- <dl>
- <dt>All Implemented Interfaces:</dt>
- <dd><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></dd>
- </dl>
- <hr>
- <br>
- <pre>public class <span class="typeNameLabel">MilvusMultiServiceClient</span>
- extends java.lang.Object
- implements <a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></pre>
- </li>
- </ul>
- </div>
- <div class="summary">
- <ul class="blockList">
- <li class="blockList">
- <!-- ======== CONSTRUCTOR SUMMARY ======== -->
- <ul class="blockList">
- <li class="blockList"><a name="constructor.summary">
- <!-- -->
- </a>
- <h3>Constructor Summary</h3>
- <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
- <caption><span>Constructors</span><span class="tabEnd"> </span></caption>
- <tr>
- <th class="colOne" scope="col">Constructor and Description</th>
- </tr>
- <tr class="altColor">
- <td class="colOne"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#MilvusMultiServiceClient-io.milvus.param.MultiConnectParam-">MilvusMultiServiceClient</a></span>(@NonNull <a href="../../../io/milvus/param/MultiConnectParam.html" title="class in io.milvus.param">MultiConnectParam</a> multiConnectParam)</code>
- <div class="block">Sets connect param for multi milvus clusters.</div>
- </td>
- </tr>
- </table>
- </li>
- </ul>
- <!-- ========== METHOD SUMMARY =========== -->
- <ul class="blockList">
- <li class="blockList"><a name="method.summary">
- <!-- -->
- </a>
- <h3>Method Summary</h3>
- <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
- <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
- <tr>
- <th class="colFirst" scope="col">Modifier and Type</th>
- <th class="colLast" scope="col">Method and Description</th>
- </tr>
- <tr id="i0" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#addUserToRole-io.milvus.param.role.AddUserToRoleParam-">addUserToRole</a></span>(<a href="../../../io/milvus/param/role/AddUserToRoleParam.html" title="class in io.milvus.param.role">AddUserToRoleParam</a> requestParam)</code>
- <div class="block">The user will get permissions that the role are allowed to perform operations.</div>
- </td>
- </tr>
- <tr id="i1" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#alterAlias-io.milvus.param.alias.AlterAliasParam-">alterAlias</a></span>(<a href="../../../io/milvus/param/alias/AlterAliasParam.html" title="class in io.milvus.param.alias">AlterAliasParam</a> requestParam)</code>
- <div class="block">Alters alias from a collection to another.</div>
- </td>
- </tr>
- <tr id="i2" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#alterCollection-io.milvus.param.collection.AlterCollectionParam-">alterCollection</a></span>(<a href="../../../io/milvus/param/collection/AlterCollectionParam.html" title="class in io.milvus.param.collection">AlterCollectionParam</a> requestParam)</code>
- <div class="block">Alter collection with key-value properties.</div>
- </td>
- </tr>
- <tr id="i3" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#alterDatabase-io.milvus.param.collection.AlterDatabaseParam-">alterDatabase</a></span>(<a href="../../../io/milvus/param/collection/AlterDatabaseParam.html" title="class in io.milvus.param.collection">AlterDatabaseParam</a> requestParam)</code>
- <div class="block">Alter database with key value pair.</div>
- </td>
- </tr>
- <tr id="i4" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#alterIndex-io.milvus.param.index.AlterIndexParam-">alterIndex</a></span>(<a href="../../../io/milvus/param/index/AlterIndexParam.html" title="class in io.milvus.param.index">AlterIndexParam</a> requestParam)</code>
- <div class="block">Alter index with key value properties.</div>
- </td>
- </tr>
- <tr id="i5" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ImportResponse></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#bulkInsert-io.milvus.param.bulkinsert.BulkInsertParam-">bulkInsert</a></span>(<a href="../../../io/milvus/param/bulkinsert/BulkInsertParam.html" title="class in io.milvus.param.bulkinsert">BulkInsertParam</a> requestParam)</code>
- <div class="block">Import data from external files, currently support JSON format</div>
- </td>
- </tr>
- <tr id="i6" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.CheckHealthResponse></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#checkHealth--">checkHealth</a></span>()</code>
- <div class="block">Check server health</div>
- </td>
- </tr>
- <tr id="i7" class="rowColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#close-long-">close</a></span>(long maxWaitSeconds)</code>
- <div class="block">Disconnects from a Milvus server with configurable timeout.</div>
- </td>
- </tr>
- <tr id="i8" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#createAlias-io.milvus.param.alias.CreateAliasParam-">createAlias</a></span>(<a href="../../../io/milvus/param/alias/CreateAliasParam.html" title="class in io.milvus.param.alias">CreateAliasParam</a> requestParam)</code>
- <div class="block">Creates an alias for a collection.</div>
- </td>
- </tr>
- <tr id="i9" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#createCollection-io.milvus.param.collection.CreateCollectionParam-">createCollection</a></span>(<a href="../../../io/milvus/param/collection/CreateCollectionParam.html" title="class in io.milvus.param.collection">CreateCollectionParam</a> requestParam)</code>
- <div class="block">Creates a collection in Milvus.</div>
- </td>
- </tr>
- <tr id="i10" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#createCollection-io.milvus.param.highlevel.collection.CreateSimpleCollectionParam-">createCollection</a></span>(<a href="../../../io/milvus/param/highlevel/collection/CreateSimpleCollectionParam.html" title="class in io.milvus.param.highlevel.collection">CreateSimpleCollectionParam</a> requestParam)</code>
- <div class="block">Creates a collection in Milvus.</div>
- </td>
- </tr>
- <tr id="i11" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#createCredential-io.milvus.param.credential.CreateCredentialParam-">createCredential</a></span>(<a href="../../../io/milvus/param/credential/CreateCredentialParam.html" title="class in io.milvus.param.credential">CreateCredentialParam</a> requestParam)</code>
- <div class="block">Create credential using the given user and password.</div>
- </td>
- </tr>
- <tr id="i12" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#createDatabase-io.milvus.param.collection.CreateDatabaseParam-">createDatabase</a></span>(<a href="../../../io/milvus/param/collection/CreateDatabaseParam.html" title="class in io.milvus.param.collection">CreateDatabaseParam</a> requestParam)</code>
- <div class="block">Creates a database in Milvus.</div>
- </td>
- </tr>
- <tr id="i13" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#createIndex-io.milvus.param.index.CreateIndexParam-">createIndex</a></span>(<a href="../../../io/milvus/param/index/CreateIndexParam.html" title="class in io.milvus.param.index">CreateIndexParam</a> requestParam)</code>
- <div class="block">Creates an index on a vector field in the specified collection.</div>
- </td>
- </tr>
- <tr id="i14" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#createPartition-io.milvus.param.partition.CreatePartitionParam-">createPartition</a></span>(<a href="../../../io/milvus/param/partition/CreatePartitionParam.html" title="class in io.milvus.param.partition">CreatePartitionParam</a> requestParam)</code>
- <div class="block">Creates a partition in the specified collection.</div>
- </td>
- </tr>
- <tr id="i15" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#createResourceGroup-io.milvus.param.resourcegroup.CreateResourceGroupParam-">createResourceGroup</a></span>(<a href="../../../io/milvus/param/resourcegroup/CreateResourceGroupParam.html" title="class in io.milvus.param.resourcegroup">CreateResourceGroupParam</a> requestParam)</code>
- <div class="block">Create a resource group.</div>
- </td>
- </tr>
- <tr id="i16" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#createRole-io.milvus.param.role.CreateRoleParam-">createRole</a></span>(<a href="../../../io/milvus/param/role/CreateRoleParam.html" title="class in io.milvus.param.role">CreateRoleParam</a> requestParam)</code>
- <div class="block">It will success if the role isn't existed, otherwise fail.</div>
- </td>
- </tr>
- <tr id="i17" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/highlevel/dml/response/DeleteResponse.html" title="class in io.milvus.param.highlevel.dml.response">DeleteResponse</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#delete-io.milvus.param.highlevel.dml.DeleteIdsParam-">delete</a></span>(<a href="../../../io/milvus/param/highlevel/dml/DeleteIdsParam.html" title="class in io.milvus.param.highlevel.dml">DeleteIdsParam</a> requestParam)</code>
- <div class="block">Deletes entity(s) based on the value of primary key.</div>
- </td>
- </tr>
- <tr id="i18" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.MutationResult></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#delete-io.milvus.param.dml.DeleteParam-">delete</a></span>(<a href="../../../io/milvus/param/dml/DeleteParam.html" title="class in io.milvus.param.dml">DeleteParam</a> requestParam)</code>
- <div class="block">Deletes entity(s) based on primary key(s) filtered by boolean expression.</div>
- </td>
- </tr>
- <tr id="i19" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#deleteCredential-io.milvus.param.credential.DeleteCredentialParam-">deleteCredential</a></span>(<a href="../../../io/milvus/param/credential/DeleteCredentialParam.html" title="class in io.milvus.param.credential">DeleteCredentialParam</a> requestParam)</code>
- <div class="block">Delete credential corresponding to the user.</div>
- </td>
- </tr>
- <tr id="i20" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.DescribeCollectionResponse></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#describeCollection-io.milvus.param.collection.DescribeCollectionParam-">describeCollection</a></span>(<a href="../../../io/milvus/param/collection/DescribeCollectionParam.html" title="class in io.milvus.param.collection">DescribeCollectionParam</a> requestParam)</code>
- <div class="block">Shows the details of a collection, e.g.</div>
- </td>
- </tr>
- <tr id="i21" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.DescribeDatabaseResponse></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#describeDatabase-io.milvus.param.collection.DescribeDatabaseParam-">describeDatabase</a></span>(<a href="../../../io/milvus/param/collection/DescribeDatabaseParam.html" title="class in io.milvus.param.collection">DescribeDatabaseParam</a> requestParam)</code>
- <div class="block">Show detail of database base, such as replica number and resource groups.</div>
- </td>
- </tr>
- <tr id="i22" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.DescribeIndexResponse></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#describeIndex-io.milvus.param.index.DescribeIndexParam-">describeIndex</a></span>(<a href="../../../io/milvus/param/index/DescribeIndexParam.html" title="class in io.milvus.param.index">DescribeIndexParam</a> requestParam)</code>
- <div class="block">Shows the information of the specified index.</div>
- </td>
- </tr>
- <tr id="i23" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.DescribeResourceGroupResponse></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#describeResourceGroup-io.milvus.param.resourcegroup.DescribeResourceGroupParam-">describeResourceGroup</a></span>(<a href="../../../io/milvus/param/resourcegroup/DescribeResourceGroupParam.html" title="class in io.milvus.param.resourcegroup">DescribeResourceGroupParam</a> requestParam)</code>
- <div class="block">Describe a resource group.</div>
- </td>
- </tr>
- <tr id="i24" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#dropAlias-io.milvus.param.alias.DropAliasParam-">dropAlias</a></span>(<a href="../../../io/milvus/param/alias/DropAliasParam.html" title="class in io.milvus.param.alias">DropAliasParam</a> requestParam)</code>
- <div class="block">Drops an alias for the specified collection.</div>
- </td>
- </tr>
- <tr id="i25" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#dropCollection-io.milvus.param.collection.DropCollectionParam-">dropCollection</a></span>(<a href="../../../io/milvus/param/collection/DropCollectionParam.html" title="class in io.milvus.param.collection">DropCollectionParam</a> requestParam)</code>
- <div class="block">Drops a collection.</div>
- </td>
- </tr>
- <tr id="i26" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#dropDatabase-io.milvus.param.collection.DropDatabaseParam-">dropDatabase</a></span>(<a href="../../../io/milvus/param/collection/DropDatabaseParam.html" title="class in io.milvus.param.collection">DropDatabaseParam</a> requestParam)</code>
- <div class="block">Drops a database.</div>
- </td>
- </tr>
- <tr id="i27" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#dropIndex-io.milvus.param.index.DropIndexParam-">dropIndex</a></span>(<a href="../../../io/milvus/param/index/DropIndexParam.html" title="class in io.milvus.param.index">DropIndexParam</a> requestParam)</code>
- <div class="block">Drops the index on a vector field in the specified collection.</div>
- </td>
- </tr>
- <tr id="i28" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#dropPartition-io.milvus.param.partition.DropPartitionParam-">dropPartition</a></span>(<a href="../../../io/milvus/param/partition/DropPartitionParam.html" title="class in io.milvus.param.partition">DropPartitionParam</a> requestParam)</code>
- <div class="block">Drops a partition.</div>
- </td>
- </tr>
- <tr id="i29" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#dropResourceGroup-io.milvus.param.resourcegroup.DropResourceGroupParam-">dropResourceGroup</a></span>(<a href="../../../io/milvus/param/resourcegroup/DropResourceGroupParam.html" title="class in io.milvus.param.resourcegroup">DropResourceGroupParam</a> requestParam)</code>
- <div class="block">Drop a resource group.</div>
- </td>
- </tr>
- <tr id="i30" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#dropRole-io.milvus.param.role.DropRoleParam-">dropRole</a></span>(<a href="../../../io/milvus/param/role/DropRoleParam.html" title="class in io.milvus.param.role">DropRoleParam</a> requestParam)</code>
- <div class="block">It will success if the role is existed, otherwise fail.</div>
- </td>
- </tr>
- <tr id="i31" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.FlushResponse></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#flush-io.milvus.param.collection.FlushParam-">flush</a></span>(<a href="../../../io/milvus/param/collection/FlushParam.html" title="class in io.milvus.param.collection">FlushParam</a> requestParam)</code>
- <div class="block">Flushes inserted data in buffer into storage.</div>
- </td>
- </tr>
- <tr id="i32" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.FlushAllResponse></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#flushAll-boolean-long-long-">flushAll</a></span>(boolean syncFlushAll,
- long syncFlushAllWaitingInterval,
- long syncFlushAllTimeout)</code>
- <div class="block">Flush all collections.</div>
- </td>
- </tr>
- <tr id="i33" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/highlevel/dml/response/GetResponse.html" title="class in io.milvus.param.highlevel.dml.response">GetResponse</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#get-io.milvus.param.highlevel.dml.GetIdsParam-">get</a></span>(<a href="../../../io/milvus/param/highlevel/dml/GetIdsParam.html" title="class in io.milvus.param.highlevel.dml">GetIdsParam</a> requestParam)</code>
- <div class="block">Get entity(s) based on the value of primary key.</div>
- </td>
- </tr>
- <tr id="i34" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetImportStateResponse></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#getBulkInsertState-io.milvus.param.bulkinsert.GetBulkInsertStateParam-">getBulkInsertState</a></span>(<a href="../../../io/milvus/param/bulkinsert/GetBulkInsertStateParam.html" title="class in io.milvus.param.bulkinsert">GetBulkInsertStateParam</a> requestParam)</code>
- <div class="block">Get state of bulk insert task</div>
- </td>
- </tr>
- <tr id="i35" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetCollectionStatisticsResponse></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#getCollectionStatistics-io.milvus.param.collection.GetCollectionStatisticsParam-">getCollectionStatistics</a></span>(<a href="../../../io/milvus/param/collection/GetCollectionStatisticsParam.html" title="class in io.milvus.param.collection">GetCollectionStatisticsParam</a> requestParam)</code>
- <div class="block">Shows the statistics information of a collection.</div>
- </td>
- </tr>
- <tr id="i36" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetCompactionStateResponse></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#getCompactionState-io.milvus.param.control.GetCompactionStateParam-">getCompactionState</a></span>(<a href="../../../io/milvus/param/control/GetCompactionStateParam.html" title="class in io.milvus.param.control">GetCompactionStateParam</a> requestParam)</code>
- <div class="block">Gets the compaction state by id.</div>
- </td>
- </tr>
- <tr id="i37" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetCompactionPlansResponse></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#getCompactionStateWithPlans-io.milvus.param.control.GetCompactionPlansParam-">getCompactionStateWithPlans</a></span>(<a href="../../../io/milvus/param/control/GetCompactionPlansParam.html" title="class in io.milvus.param.control">GetCompactionPlansParam</a> requestParam)</code>
- <div class="block">Gets compaction state with its plan.</div>
- </td>
- </tr>
- <tr id="i38" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetFlushAllStateResponse></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#getFlushAllState-io.milvus.param.control.GetFlushAllStateParam-">getFlushAllState</a></span>(<a href="../../../io/milvus/param/control/GetFlushAllStateParam.html" title="class in io.milvus.param.control">GetFlushAllStateParam</a> requestParam)</code>
- <div class="block">Get flush state of all segments.</div>
- </td>
- </tr>
- <tr id="i39" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetFlushStateResponse></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#getFlushState-io.milvus.param.control.GetFlushStateParam-">getFlushState</a></span>(<a href="../../../io/milvus/param/control/GetFlushStateParam.html" title="class in io.milvus.param.control">GetFlushStateParam</a> requestParam)</code>
- <div class="block">Get flush state of specified collection.</div>
- </td>
- </tr>
- <tr id="i40" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetIndexBuildProgressResponse></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#getIndexBuildProgress-io.milvus.param.index.GetIndexBuildProgressParam-">getIndexBuildProgress</a></span>(<a href="../../../io/milvus/param/index/GetIndexBuildProgressParam.html" title="class in io.milvus.param.index">GetIndexBuildProgressParam</a> requestParam)</code>
- <div class="block">Shows the index building progress, such as how many rows are indexed.</div>
- </td>
- </tr>
- <tr id="i41" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetIndexStateResponse></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#getIndexState-io.milvus.param.index.GetIndexStateParam-">getIndexState</a></span>(<a href="../../../io/milvus/param/index/GetIndexStateParam.html" title="class in io.milvus.param.index">GetIndexStateParam</a> requestParam)</code>
- <div class="block">Shows the index building state(in-progress/finished/failed), and the reason for failure (if any).</div>
- </td>
- </tr>
- <tr id="i42" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetLoadingProgressResponse></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#getLoadingProgress-io.milvus.param.collection.GetLoadingProgressParam-">getLoadingProgress</a></span>(<a href="../../../io/milvus/param/collection/GetLoadingProgressParam.html" title="class in io.milvus.param.collection">GetLoadingProgressParam</a> requestParam)</code>
- <div class="block">Get collection loading progress</div>
- </td>
- </tr>
- <tr id="i43" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetLoadStateResponse></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#getLoadState-io.milvus.param.collection.GetLoadStateParam-">getLoadState</a></span>(<a href="../../../io/milvus/param/collection/GetLoadStateParam.html" title="class in io.milvus.param.collection">GetLoadStateParam</a> requestParam)</code>
- <div class="block">Get collection loading state</div>
- </td>
- </tr>
- <tr id="i44" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetMetricsResponse></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#getMetrics-io.milvus.param.control.GetMetricsParam-">getMetrics</a></span>(<a href="../../../io/milvus/param/control/GetMetricsParam.html" title="class in io.milvus.param.control">GetMetricsParam</a> requestParam)</code>
- <div class="block">Gets the runtime metrics information of Milvus, returns the result in .json format.</div>
- </td>
- </tr>
- <tr id="i45" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetPartitionStatisticsResponse></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#getPartitionStatistics-io.milvus.param.partition.GetPartitionStatisticsParam-">getPartitionStatistics</a></span>(<a href="../../../io/milvus/param/partition/GetPartitionStatisticsParam.html" title="class in io.milvus.param.partition">GetPartitionStatisticsParam</a> requestParam)</code>
- <div class="block">Shows the statistics information of a partition.</div>
- </td>
- </tr>
- <tr id="i46" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetPersistentSegmentInfoResponse></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#getPersistentSegmentInfo-io.milvus.param.control.GetPersistentSegmentInfoParam-">getPersistentSegmentInfo</a></span>(<a href="../../../io/milvus/param/control/GetPersistentSegmentInfoParam.html" title="class in io.milvus.param.control">GetPersistentSegmentInfoParam</a> requestParam)</code>
- <div class="block">Gets the information of persistent segments from data node, including row count,
- persistence state(growing or flushed), etc.</div>
- </td>
- </tr>
- <tr id="i47" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetQuerySegmentInfoResponse></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#getQuerySegmentInfo-io.milvus.param.control.GetQuerySegmentInfoParam-">getQuerySegmentInfo</a></span>(<a href="../../../io/milvus/param/control/GetQuerySegmentInfoParam.html" title="class in io.milvus.param.control">GetQuerySegmentInfoParam</a> requestParam)</code>
- <div class="block">Gets the query information of segments in a collection from query node, including row count,
- memory usage size, index name, etc.</div>
- </td>
- </tr>
- <tr id="i48" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetReplicasResponse></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#getReplicas-io.milvus.param.control.GetReplicasParam-">getReplicas</a></span>(<a href="../../../io/milvus/param/control/GetReplicasParam.html" title="class in io.milvus.param.control">GetReplicasParam</a> requestParam)</code>
- <div class="block">Returns the collection's replica information</div>
- </td>
- </tr>
- <tr id="i49" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetVersionResponse></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#getVersion--">getVersion</a></span>()</code>
- <div class="block">Get server version</div>
- </td>
- </tr>
- <tr id="i50" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#grantRolePrivilege-io.milvus.param.role.GrantRolePrivilegeParam-">grantRolePrivilege</a></span>(<a href="../../../io/milvus/param/role/GrantRolePrivilegeParam.html" title="class in io.milvus.param.role">GrantRolePrivilegeParam</a> requestParam)</code>
- <div class="block">Grant Role Privilege.</div>
- </td>
- </tr>
- <tr id="i51" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><java.lang.Boolean></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#hasCollection-io.milvus.param.collection.HasCollectionParam-">hasCollection</a></span>(<a href="../../../io/milvus/param/collection/HasCollectionParam.html" title="class in io.milvus.param.collection">HasCollectionParam</a> requestParam)</code>
- <div class="block">Checks if a collection exists.</div>
- </td>
- </tr>
- <tr id="i52" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><java.lang.Boolean></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#hasPartition-io.milvus.param.partition.HasPartitionParam-">hasPartition</a></span>(<a href="../../../io/milvus/param/partition/HasPartitionParam.html" title="class in io.milvus.param.partition">HasPartitionParam</a> requestParam)</code>
- <div class="block">Checks if a partition exists in the specified collection.</div>
- </td>
- </tr>
- <tr id="i53" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.SearchResults></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#hybridSearch-io.milvus.param.dml.HybridSearchParam-">hybridSearch</a></span>(<a href="../../../io/milvus/param/dml/HybridSearchParam.html" title="class in io.milvus.param.dml">HybridSearchParam</a> requestParam)</code>
- <div class="block">Conducts multi vector similarity search with a ranker for rearrangement.</div>
- </td>
- </tr>
- <tr id="i54" class="altColor">
- <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<<a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.SearchResults>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#hybridSearchAsync-io.milvus.param.dml.HybridSearchParam-">hybridSearchAsync</a></span>(<a href="../../../io/milvus/param/dml/HybridSearchParam.html" title="class in io.milvus.param.dml">HybridSearchParam</a> requestParam)</code>
- <div class="block">Conducts multi vector similarity search asynchronously with a ranker for rearrangement.</div>
- </td>
- </tr>
- <tr id="i55" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.MutationResult></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#insert-io.milvus.param.dml.InsertParam-">insert</a></span>(<a href="../../../io/milvus/param/dml/InsertParam.html" title="class in io.milvus.param.dml">InsertParam</a> requestParam)</code>
- <div class="block">Inserts entities into a specified collection .</div>
- </td>
- </tr>
- <tr id="i56" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/highlevel/dml/response/InsertResponse.html" title="class in io.milvus.param.highlevel.dml.response">InsertResponse</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#insert-io.milvus.param.highlevel.dml.InsertRowsParam-">insert</a></span>(<a href="../../../io/milvus/param/highlevel/dml/InsertRowsParam.html" title="class in io.milvus.param.highlevel.dml">InsertRowsParam</a> requestParam)</code>
- <div class="block">Inserts rows data into a specified collection .</div>
- </td>
- </tr>
- <tr id="i57" class="rowColor">
- <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<<a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.MutationResult>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#insertAsync-io.milvus.param.dml.InsertParam-">insertAsync</a></span>(<a href="../../../io/milvus/param/dml/InsertParam.html" title="class in io.milvus.param.dml">InsertParam</a> requestParam)</code>
- <div class="block">Inserts entities into a specified collection asynchronously.</div>
- </td>
- </tr>
- <tr id="i58" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ListAliasesResponse></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#listAliases-io.milvus.param.alias.ListAliasesParam-">listAliases</a></span>(<a href="../../../io/milvus/param/alias/ListAliasesParam.html" title="class in io.milvus.param.alias">ListAliasesParam</a> requestParam)</code>
- <div class="block">List all alias for a collection.</div>
- </td>
- </tr>
- <tr id="i59" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ListImportTasksResponse></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#listBulkInsertTasks-io.milvus.param.bulkinsert.ListBulkInsertTasksParam-">listBulkInsertTasks</a></span>(<a href="../../../io/milvus/param/bulkinsert/ListBulkInsertTasksParam.html" title="class in io.milvus.param.bulkinsert">ListBulkInsertTasksParam</a> requestParam)</code>
- <div class="block">List bulk insert tasks</div>
- </td>
- </tr>
- <tr id="i60" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/highlevel/collection/response/ListCollectionsResponse.html" title="class in io.milvus.param.highlevel.collection.response">ListCollectionsResponse</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#listCollections-io.milvus.param.highlevel.collection.ListCollectionsParam-">listCollections</a></span>(<a href="../../../io/milvus/param/highlevel/collection/ListCollectionsParam.html" title="class in io.milvus.param.highlevel.collection">ListCollectionsParam</a> requestParam)</code>
- <div class="block">Lists all collections</div>
- </td>
- </tr>
- <tr id="i61" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ListCredUsersResponse></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#listCredUsers-io.milvus.param.credential.ListCredUsersParam-">listCredUsers</a></span>(<a href="../../../io/milvus/param/credential/ListCredUsersParam.html" title="class in io.milvus.param.credential">ListCredUsersParam</a> requestParam)</code>
- <div class="block">List all user names.</div>
- </td>
- </tr>
- <tr id="i62" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ListDatabasesResponse></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#listDatabases--">listDatabases</a></span>()</code>
- <div class="block">List databases.</div>
- </td>
- </tr>
- <tr id="i63" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ListResourceGroupsResponse></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#listResourceGroups-io.milvus.param.resourcegroup.ListResourceGroupsParam-">listResourceGroups</a></span>(<a href="../../../io/milvus/param/resourcegroup/ListResourceGroupsParam.html" title="class in io.milvus.param.resourcegroup">ListResourceGroupsParam</a> requestParam)</code>
- <div class="block">List resource groups.</div>
- </td>
- </tr>
- <tr id="i64" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#loadBalance-io.milvus.param.control.LoadBalanceParam-">loadBalance</a></span>(<a href="../../../io/milvus/param/control/LoadBalanceParam.html" title="class in io.milvus.param.control">LoadBalanceParam</a> requestParam)</code>
- <div class="block">Moves segment from a query node to another to keep the load balanced.</div>
- </td>
- </tr>
- <tr id="i65" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#loadCollection-io.milvus.param.collection.LoadCollectionParam-">loadCollection</a></span>(<a href="../../../io/milvus/param/collection/LoadCollectionParam.html" title="class in io.milvus.param.collection">LoadCollectionParam</a> requestParam)</code>
- <div class="block">Loads a collection to memory before search or query.</div>
- </td>
- </tr>
- <tr id="i66" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#loadPartitions-io.milvus.param.partition.LoadPartitionsParam-">loadPartitions</a></span>(<a href="../../../io/milvus/param/partition/LoadPartitionsParam.html" title="class in io.milvus.param.partition">LoadPartitionsParam</a> requestParam)</code>
- <div class="block">Loads a partition into memory.</div>
- </td>
- </tr>
- <tr id="i67" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ManualCompactionResponse></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#manualCompact-io.milvus.param.control.ManualCompactParam-">manualCompact</a></span>(<a href="../../../io/milvus/param/control/ManualCompactParam.html" title="class in io.milvus.param.control">ManualCompactParam</a> requestParam)</code>
- <div class="block">Performs a manual compaction.</div>
- </td>
- </tr>
- <tr id="i68" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.QueryResults></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#query-io.milvus.param.dml.QueryParam-">query</a></span>(<a href="../../../io/milvus/param/dml/QueryParam.html" title="class in io.milvus.param.dml">QueryParam</a> requestParam)</code>
- <div class="block">Queries entity(s) based on scalar field(s) filtered by boolean expression.</div>
- </td>
- </tr>
- <tr id="i69" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/highlevel/dml/response/QueryResponse.html" title="class in io.milvus.param.highlevel.dml.response">QueryResponse</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#query-io.milvus.param.highlevel.dml.QuerySimpleParam-">query</a></span>(<a href="../../../io/milvus/param/highlevel/dml/QuerySimpleParam.html" title="class in io.milvus.param.highlevel.dml">QuerySimpleParam</a> requestParam)</code>
- <div class="block">Queries entity(s) based on scalar field(s) filtered by boolean expression.</div>
- </td>
- </tr>
- <tr id="i70" class="altColor">
- <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<<a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.QueryResults>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#queryAsync-io.milvus.param.dml.QueryParam-">queryAsync</a></span>(<a href="../../../io/milvus/param/dml/QueryParam.html" title="class in io.milvus.param.dml">QueryParam</a> requestParam)</code>
- <div class="block">Queries entity(s) asynchronously based on scalar field(s) filtered by boolean expression.</div>
- </td>
- </tr>
- <tr id="i71" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/orm/iterator/QueryIterator.html" title="class in io.milvus.orm.iterator">QueryIterator</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#queryIterator-io.milvus.param.dml.QueryIteratorParam-">queryIterator</a></span>(<a href="../../../io/milvus/param/dml/QueryIteratorParam.html" title="class in io.milvus.param.dml">QueryIteratorParam</a> requestParam)</code>
- <div class="block">Get queryIterator based on scalar field(s) filtered by boolean expression.</div>
- </td>
- </tr>
- <tr id="i72" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#releaseCollection-io.milvus.param.collection.ReleaseCollectionParam-">releaseCollection</a></span>(<a href="../../../io/milvus/param/collection/ReleaseCollectionParam.html" title="class in io.milvus.param.collection">ReleaseCollectionParam</a> requestParam)</code>
- <div class="block">Releases a collection from memory to reduce memory usage.</div>
- </td>
- </tr>
- <tr id="i73" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#releasePartitions-io.milvus.param.partition.ReleasePartitionsParam-">releasePartitions</a></span>(<a href="../../../io/milvus/param/partition/ReleasePartitionsParam.html" title="class in io.milvus.param.partition">ReleasePartitionsParam</a> requestParam)</code>
- <div class="block">Releases a partition from memory.</div>
- </td>
- </tr>
- <tr id="i74" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#removeUserFromRole-io.milvus.param.role.RemoveUserFromRoleParam-">removeUserFromRole</a></span>(<a href="../../../io/milvus/param/role/RemoveUserFromRoleParam.html" title="class in io.milvus.param.role">RemoveUserFromRoleParam</a> requestParam)</code>
- <div class="block">The user will remove permissions that the role are allowed to perform operations.</div>
- </td>
- </tr>
- <tr id="i75" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#renameCollection-io.milvus.param.collection.RenameCollectionParam-">renameCollection</a></span>(<a href="../../../io/milvus/param/collection/RenameCollectionParam.html" title="class in io.milvus.param.collection">RenameCollectionParam</a> requestParam)</code>
- <div class="block">rename a collection</div>
- </td>
- </tr>
- <tr id="i76" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#revokeRolePrivilege-io.milvus.param.role.RevokeRolePrivilegeParam-">revokeRolePrivilege</a></span>(<a href="../../../io/milvus/param/role/RevokeRolePrivilegeParam.html" title="class in io.milvus.param.role">RevokeRolePrivilegeParam</a> requestParam)</code>
- <div class="block">Revoke Role Privilege.</div>
- </td>
- </tr>
- <tr id="i77" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.SearchResults></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#search-io.milvus.param.dml.SearchParam-">search</a></span>(<a href="../../../io/milvus/param/dml/SearchParam.html" title="class in io.milvus.param.dml">SearchParam</a> requestParam)</code>
- <div class="block">Conducts ANN search on a vector field.</div>
- </td>
- </tr>
- <tr id="i78" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/highlevel/dml/response/SearchResponse.html" title="class in io.milvus.param.highlevel.dml.response">SearchResponse</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#search-io.milvus.param.highlevel.dml.SearchSimpleParam-">search</a></span>(<a href="../../../io/milvus/param/highlevel/dml/SearchSimpleParam.html" title="class in io.milvus.param.highlevel.dml">SearchSimpleParam</a> requestParam)</code>
- <div class="block">Conducts ANN search on a vector field.</div>
- </td>
- </tr>
- <tr id="i79" class="rowColor">
- <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<<a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.SearchResults>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#searchAsync-io.milvus.param.dml.SearchParam-">searchAsync</a></span>(<a href="../../../io/milvus/param/dml/SearchParam.html" title="class in io.milvus.param.dml">SearchParam</a> requestParam)</code>
- <div class="block">Conducts ANN search on a vector field asynchronously.</div>
- </td>
- </tr>
- <tr id="i80" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/orm/iterator/SearchIterator.html" title="class in io.milvus.orm.iterator">SearchIterator</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#searchIterator-io.milvus.param.dml.SearchIteratorParam-">searchIterator</a></span>(<a href="../../../io/milvus/param/dml/SearchIteratorParam.html" title="class in io.milvus.param.dml">SearchIteratorParam</a> requestParam)</code>
- <div class="block">Get searchIterator based on a vector field.</div>
- </td>
- </tr>
- <tr id="i81" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.SelectGrantResponse></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#selectGrantForRole-io.milvus.param.role.SelectGrantForRoleParam-">selectGrantForRole</a></span>(<a href="../../../io/milvus/param/role/SelectGrantForRoleParam.html" title="class in io.milvus.param.role">SelectGrantForRoleParam</a> requestParam)</code>
- <div class="block">List a grant info for the role and the specific object</div>
- </td>
- </tr>
- <tr id="i82" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.SelectGrantResponse></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#selectGrantForRoleAndObject-io.milvus.param.role.SelectGrantForRoleAndObjectParam-">selectGrantForRoleAndObject</a></span>(<a href="../../../io/milvus/param/role/SelectGrantForRoleAndObjectParam.html" title="class in io.milvus.param.role">SelectGrantForRoleAndObjectParam</a> requestParam)</code>
- <div class="block">List a grant info for the role</div>
- </td>
- </tr>
- <tr id="i83" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.SelectRoleResponse></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#selectRole-io.milvus.param.role.SelectRoleParam-">selectRole</a></span>(<a href="../../../io/milvus/param/role/SelectRoleParam.html" title="class in io.milvus.param.role">SelectRoleParam</a> requestParam)</code>
- <div class="block">Get all users who are added to the role.</div>
- </td>
- </tr>
- <tr id="i84" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.SelectUserResponse></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#selectUser-io.milvus.param.role.SelectUserParam-">selectUser</a></span>(<a href="../../../io/milvus/param/role/SelectUserParam.html" title="class in io.milvus.param.role">SelectUserParam</a> requestParam)</code>
- <div class="block">Get all roles the user has.</div>
- </td>
- </tr>
- <tr id="i85" class="rowColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#setLogLevel-io.milvus.param.LogLevel-">setLogLevel</a></span>(<a href="../../../io/milvus/param/LogLevel.html" title="enum in io.milvus.param">LogLevel</a> level)</code>
- <div class="block">Set log level in runtime.</div>
- </td>
- </tr>
- <tr id="i86" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ShowCollectionsResponse></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#showCollections-io.milvus.param.collection.ShowCollectionsParam-">showCollections</a></span>(<a href="../../../io/milvus/param/collection/ShowCollectionsParam.html" title="class in io.milvus.param.collection">ShowCollectionsParam</a> requestParam)</code>
- <div class="block">Lists all collections or gets collection loading status.</div>
- </td>
- </tr>
- <tr id="i87" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ShowPartitionsResponse></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#showPartitions-io.milvus.param.partition.ShowPartitionsParam-">showPartitions</a></span>(<a href="../../../io/milvus/param/partition/ShowPartitionsParam.html" title="class in io.milvus.param.partition">ShowPartitionsParam</a> requestParam)</code>
- <div class="block">Shows all partitions in the specified collection.</div>
- </td>
- </tr>
- <tr id="i88" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#transferNode-io.milvus.param.resourcegroup.TransferNodeParam-">transferNode</a></span>(<a href="../../../io/milvus/param/resourcegroup/TransferNodeParam.html" title="class in io.milvus.param.resourcegroup">TransferNodeParam</a> requestParam)</code>
- <div class="block">Transfer a query node from source resource group to target resource_group.</div>
- </td>
- </tr>
- <tr id="i89" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#transferReplica-io.milvus.param.resourcegroup.TransferReplicaParam-">transferReplica</a></span>(<a href="../../../io/milvus/param/resourcegroup/TransferReplicaParam.html" title="class in io.milvus.param.resourcegroup">TransferReplicaParam</a> requestParam)</code>
- <div class="block">Transfer a replica from source resource group to target resource_group.</div>
- </td>
- </tr>
- <tr id="i90" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#updateCredential-io.milvus.param.credential.UpdateCredentialParam-">updateCredential</a></span>(<a href="../../../io/milvus/param/credential/UpdateCredentialParam.html" title="class in io.milvus.param.credential">UpdateCredentialParam</a> requestParam)</code>
- <div class="block">Update credential using the given user and password.</div>
- </td>
- </tr>
- <tr id="i91" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#updateResourceGroups-io.milvus.param.resourcegroup.UpdateResourceGroupsParam-">updateResourceGroups</a></span>(<a href="../../../io/milvus/param/resourcegroup/UpdateResourceGroupsParam.html" title="class in io.milvus.param.resourcegroup">UpdateResourceGroupsParam</a> requestParam)</code>
- <div class="block">Update resource groups.</div>
- </td>
- </tr>
- <tr id="i92" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.MutationResult></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#upsert-io.milvus.param.dml.UpsertParam-">upsert</a></span>(<a href="../../../io/milvus/param/dml/UpsertParam.html" title="class in io.milvus.param.dml">UpsertParam</a> requestParam)</code>
- <div class="block">Insert new entities into a specified collection, replace them if the entities already exist.</div>
- </td>
- </tr>
- <tr id="i93" class="rowColor">
- <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<<a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.MutationResult>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#upsertAsync-io.milvus.param.dml.UpsertParam-">upsertAsync</a></span>(<a href="../../../io/milvus/param/dml/UpsertParam.html" title="class in io.milvus.param.dml">UpsertParam</a> requestParam)</code>
- <div class="block">Insert new entities into a specified collection asynchronously, replace them if the entities already exist.</div>
- </td>
- </tr>
- <tr id="i94" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#withRetry-int-">withRetry</a></span>(int retryTimes)</code>
- <div class="block">Number of retry attempts.</div>
- </td>
- </tr>
- <tr id="i95" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#withRetry-io.milvus.param.RetryParam-">withRetry</a></span>(<a href="../../../io/milvus/param/RetryParam.html" title="class in io.milvus.param">RetryParam</a> retryParam)</code>
- <div class="block">Sets the parameters for retry.</div>
- </td>
- </tr>
- <tr id="i96" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#withRetryInterval-long-java.util.concurrent.TimeUnit-">withRetryInterval</a></span>(long interval,
- java.util.concurrent.TimeUnit timeUnit)</code>
- <div class="block">Time interval between retry attempts.</div>
- </td>
- </tr>
- <tr id="i97" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/client/MilvusMultiServiceClient.html#withTimeout-long-java.util.concurrent.TimeUnit-">withTimeout</a></span>(long timeout,
- java.util.concurrent.TimeUnit timeoutUnit)</code>
- <div class="block">Timeout setting for rpc call.</div>
- </td>
- </tr>
- </table>
- <ul class="blockList">
- <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
- <!-- -->
- </a>
- <h3>Methods inherited from class java.lang.Object</h3>
- <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
- </ul>
- <ul class="blockList">
- <li class="blockList"><a name="methods.inherited.from.class.io.milvus.client.MilvusClient">
- <!-- -->
- </a>
- <h3>Methods inherited from interface io.milvus.client.<a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></h3>
- <code><a href="../../../io/milvus/client/MilvusClient.html#close--">close</a></code></li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- </div>
- <div class="details">
- <ul class="blockList">
- <li class="blockList">
- <!-- ========= CONSTRUCTOR DETAIL ======== -->
- <ul class="blockList">
- <li class="blockList"><a name="constructor.detail">
- <!-- -->
- </a>
- <h3>Constructor Detail</h3>
- <a name="MilvusMultiServiceClient-io.milvus.param.MultiConnectParam-">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>MilvusMultiServiceClient</h4>
- <pre>public MilvusMultiServiceClient(@NonNull
- @NonNull <a href="../../../io/milvus/param/MultiConnectParam.html" title="class in io.milvus.param">MultiConnectParam</a> multiConnectParam)</pre>
- <div class="block">Sets connect param for multi milvus clusters.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>multiConnectParam</code> - multi server connect param</dd>
- </dl>
- </li>
- </ul>
- </li>
- </ul>
- <!-- ============ METHOD DETAIL ========== -->
- <ul class="blockList">
- <li class="blockList"><a name="method.detail">
- <!-- -->
- </a>
- <h3>Method Detail</h3>
- <a name="withTimeout-long-java.util.concurrent.TimeUnit-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>withTimeout</h4>
- <pre>public <a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a> withTimeout(long timeout,
- java.util.concurrent.TimeUnit timeoutUnit)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#withTimeout-long-java.util.concurrent.TimeUnit-">MilvusClient</a></code></span></div>
- <div class="block">Timeout setting for rpc call.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#withTimeout-long-java.util.concurrent.TimeUnit-">withTimeout</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>timeout</code> - set time waiting for a rpc call.</dd>
- <dd><code>timeoutUnit</code> - time unit</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>MilvusClient</code></dd>
- </dl>
- </li>
- </ul>
- <a name="withRetry-io.milvus.param.RetryParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>withRetry</h4>
- <pre>public <a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a> withRetry(<a href="../../../io/milvus/param/RetryParam.html" title="class in io.milvus.param">RetryParam</a> retryParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#withRetry-io.milvus.param.RetryParam-">MilvusClient</a></code></span></div>
- <div class="block">Sets the parameters for retry.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#withRetry-io.milvus.param.RetryParam-">withRetry</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>retryParam</code> - <a href="../../../io/milvus/param/RetryParam.html" title="class in io.milvus.param"><code>RetryParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>MilvusClient</code></dd>
- </dl>
- </li>
- </ul>
- <a name="withRetry-int-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>withRetry</h4>
- <pre>public <a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a> withRetry(int retryTimes)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#withRetry-int-">MilvusClient</a></code></span></div>
- <div class="block">Number of retry attempts.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#withRetry-int-">withRetry</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>retryTimes</code> - number of retry attempts.</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>MilvusClient</code></dd>
- </dl>
- </li>
- </ul>
- <a name="withRetryInterval-long-java.util.concurrent.TimeUnit-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>withRetryInterval</h4>
- <pre>public <a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a> withRetryInterval(long interval,
- java.util.concurrent.TimeUnit timeUnit)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#withRetryInterval-long-java.util.concurrent.TimeUnit-">MilvusClient</a></code></span></div>
- <div class="block">Time interval between retry attempts. Default value is 500ms.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#withRetryInterval-long-java.util.concurrent.TimeUnit-">withRetryInterval</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>interval</code> - time interval between retry attempts.</dd>
- <dd><code>timeUnit</code> - time unit</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>MilvusClient</code></dd>
- </dl>
- </li>
- </ul>
- <a name="close-long-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>close</h4>
- <pre>public void close(long maxWaitSeconds)
- throws java.lang.InterruptedException</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#close-long-">MilvusClient</a></code></span></div>
- <div class="block">Disconnects from a Milvus server with configurable timeout.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#close-long-">close</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>maxWaitSeconds</code> - timeout unit: second</dd>
- <dt><span class="throwsLabel">Throws:</span></dt>
- <dd><code>java.lang.InterruptedException</code> - throw InterruptedException if the client failed to close connection</dd>
- </dl>
- </li>
- </ul>
- <a name="setLogLevel-io.milvus.param.LogLevel-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>setLogLevel</h4>
- <pre>public void setLogLevel(<a href="../../../io/milvus/param/LogLevel.html" title="enum in io.milvus.param">LogLevel</a> level)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#setLogLevel-io.milvus.param.LogLevel-">MilvusClient</a></code></span></div>
- <div class="block">Set log level in runtime.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#setLogLevel-io.milvus.param.LogLevel-">setLogLevel</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>level</code> - <a href="../../../io/milvus/param/LogLevel.html" title="enum in io.milvus.param"><code>LogLevel</code></a></dd>
- </dl>
- </li>
- </ul>
- <a name="hasCollection-io.milvus.param.collection.HasCollectionParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>hasCollection</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><java.lang.Boolean> hasCollection(<a href="../../../io/milvus/param/collection/HasCollectionParam.html" title="class in io.milvus.param.collection">HasCollectionParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#hasCollection-io.milvus.param.collection.HasCollectionParam-">MilvusClient</a></code></span></div>
- <div class="block">Checks if a collection exists.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#hasCollection-io.milvus.param.collection.HasCollectionParam-">hasCollection</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/collection/HasCollectionParam.html" title="class in io.milvus.param.collection"><code>HasCollectionParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data: boolean, whether if has collection or not}</dd>
- </dl>
- </li>
- </ul>
- <a name="createDatabase-io.milvus.param.collection.CreateDatabaseParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>createDatabase</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> createDatabase(<a href="../../../io/milvus/param/collection/CreateDatabaseParam.html" title="class in io.milvus.param.collection">CreateDatabaseParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#createDatabase-io.milvus.param.collection.CreateDatabaseParam-">MilvusClient</a></code></span></div>
- <div class="block">Creates a database in Milvus.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#createDatabase-io.milvus.param.collection.CreateDatabaseParam-">createDatabase</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/collection/CreateDatabaseParam.html" title="class in io.milvus.param.collection"><code>CreateDatabaseParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
- </dl>
- </li>
- </ul>
- <a name="dropDatabase-io.milvus.param.collection.DropDatabaseParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>dropDatabase</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> dropDatabase(<a href="../../../io/milvus/param/collection/DropDatabaseParam.html" title="class in io.milvus.param.collection">DropDatabaseParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#dropDatabase-io.milvus.param.collection.DropDatabaseParam-">MilvusClient</a></code></span></div>
- <div class="block">Drops a database. Note that this method drops all data in the database.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#dropDatabase-io.milvus.param.collection.DropDatabaseParam-">dropDatabase</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/collection/DropDatabaseParam.html" title="class in io.milvus.param.collection"><code>DropDatabaseParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
- </dl>
- </li>
- </ul>
- <a name="listDatabases--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>listDatabases</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ListDatabasesResponse> listDatabases()</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#listDatabases--">MilvusClient</a></code></span></div>
- <div class="block">List databases. Note that this method list all database in the cluster.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#listDatabases--">listDatabases</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
- </dl>
- </li>
- </ul>
- <a name="alterDatabase-io.milvus.param.collection.AlterDatabaseParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>alterDatabase</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> alterDatabase(<a href="../../../io/milvus/param/collection/AlterDatabaseParam.html" title="class in io.milvus.param.collection">AlterDatabaseParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#alterDatabase-io.milvus.param.collection.AlterDatabaseParam-">MilvusClient</a></code></span></div>
- <div class="block">Alter database with key value pair. (Available from Milvus v2.4.4)</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#alterDatabase-io.milvus.param.collection.AlterDatabaseParam-">alterDatabase</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/collection/AlterDatabaseParam.html" title="class in io.milvus.param.collection"><code>AlterDatabaseParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
- </dl>
- </li>
- </ul>
- <a name="describeDatabase-io.milvus.param.collection.DescribeDatabaseParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>describeDatabase</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.DescribeDatabaseResponse> describeDatabase(<a href="../../../io/milvus/param/collection/DescribeDatabaseParam.html" title="class in io.milvus.param.collection">DescribeDatabaseParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#describeDatabase-io.milvus.param.collection.DescribeDatabaseParam-">MilvusClient</a></code></span></div>
- <div class="block">Show detail of database base, such as replica number and resource groups. (Available from Milvus v2.4.4)</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#describeDatabase-io.milvus.param.collection.DescribeDatabaseParam-">describeDatabase</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/collection/DescribeDatabaseParam.html" title="class in io.milvus.param.collection"><code>DescribeDatabaseParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:DescribeDatabaseResponse{replica_number,resource_groups}}</dd>
- </dl>
- </li>
- </ul>
- <a name="createCollection-io.milvus.param.collection.CreateCollectionParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>createCollection</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> createCollection(<a href="../../../io/milvus/param/collection/CreateCollectionParam.html" title="class in io.milvus.param.collection">CreateCollectionParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#createCollection-io.milvus.param.collection.CreateCollectionParam-">MilvusClient</a></code></span></div>
- <div class="block">Creates a collection in Milvus.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#createCollection-io.milvus.param.collection.CreateCollectionParam-">createCollection</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/collection/CreateCollectionParam.html" title="class in io.milvus.param.collection"><code>CreateCollectionParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
- </dl>
- </li>
- </ul>
- <a name="dropCollection-io.milvus.param.collection.DropCollectionParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>dropCollection</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> dropCollection(<a href="../../../io/milvus/param/collection/DropCollectionParam.html" title="class in io.milvus.param.collection">DropCollectionParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#dropCollection-io.milvus.param.collection.DropCollectionParam-">MilvusClient</a></code></span></div>
- <div class="block">Drops a collection. Note that this method drops all data in the collection.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#dropCollection-io.milvus.param.collection.DropCollectionParam-">dropCollection</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/collection/DropCollectionParam.html" title="class in io.milvus.param.collection"><code>DropCollectionParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
- </dl>
- </li>
- </ul>
- <a name="loadCollection-io.milvus.param.collection.LoadCollectionParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>loadCollection</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> loadCollection(<a href="../../../io/milvus/param/collection/LoadCollectionParam.html" title="class in io.milvus.param.collection">LoadCollectionParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#loadCollection-io.milvus.param.collection.LoadCollectionParam-">MilvusClient</a></code></span></div>
- <div class="block">Loads a collection to memory before search or query.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#loadCollection-io.milvus.param.collection.LoadCollectionParam-">loadCollection</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/collection/LoadCollectionParam.html" title="class in io.milvus.param.collection"><code>LoadCollectionParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
- </dl>
- </li>
- </ul>
- <a name="releaseCollection-io.milvus.param.collection.ReleaseCollectionParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>releaseCollection</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> releaseCollection(<a href="../../../io/milvus/param/collection/ReleaseCollectionParam.html" title="class in io.milvus.param.collection">ReleaseCollectionParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#releaseCollection-io.milvus.param.collection.ReleaseCollectionParam-">MilvusClient</a></code></span></div>
- <div class="block">Releases a collection from memory to reduce memory usage. Note that you
- cannot search while the corresponding collection is released from memory.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#releaseCollection-io.milvus.param.collection.ReleaseCollectionParam-">releaseCollection</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/collection/ReleaseCollectionParam.html" title="class in io.milvus.param.collection"><code>ReleaseCollectionParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
- </dl>
- </li>
- </ul>
- <a name="renameCollection-io.milvus.param.collection.RenameCollectionParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>renameCollection</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> renameCollection(<a href="../../../io/milvus/param/collection/RenameCollectionParam.html" title="class in io.milvus.param.collection">RenameCollectionParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#renameCollection-io.milvus.param.collection.RenameCollectionParam-">MilvusClient</a></code></span></div>
- <div class="block">rename a collection</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#renameCollection-io.milvus.param.collection.RenameCollectionParam-">renameCollection</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/collection/RenameCollectionParam.html" title="class in io.milvus.param.collection"><code>RenameCollectionParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
- </dl>
- </li>
- </ul>
- <a name="describeCollection-io.milvus.param.collection.DescribeCollectionParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>describeCollection</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.DescribeCollectionResponse> describeCollection(<a href="../../../io/milvus/param/collection/DescribeCollectionParam.html" title="class in io.milvus.param.collection">DescribeCollectionParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#describeCollection-io.milvus.param.collection.DescribeCollectionParam-">MilvusClient</a></code></span></div>
- <div class="block">Shows the details of a collection, e.g. name, schema.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#describeCollection-io.milvus.param.collection.DescribeCollectionParam-">describeCollection</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/collection/DescribeCollectionParam.html" title="class in io.milvus.param.collection"><code>DescribeCollectionParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:DescribeCollectionResponse{schema,collectionID}}</dd>
- </dl>
- </li>
- </ul>
- <a name="getCollectionStatistics-io.milvus.param.collection.GetCollectionStatisticsParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getCollectionStatistics</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetCollectionStatisticsResponse> getCollectionStatistics(<a href="../../../io/milvus/param/collection/GetCollectionStatisticsParam.html" title="class in io.milvus.param.collection">GetCollectionStatisticsParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#getCollectionStatistics-io.milvus.param.collection.GetCollectionStatisticsParam-">MilvusClient</a></code></span></div>
- <div class="block">Shows the statistics information of a collection.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#getCollectionStatistics-io.milvus.param.collection.GetCollectionStatisticsParam-">getCollectionStatistics</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/collection/GetCollectionStatisticsParam.html" title="class in io.milvus.param.collection"><code>GetCollectionStatisticsParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data: GetCollectionStatisticsResponse{status,stats}}</dd>
- </dl>
- </li>
- </ul>
- <a name="showCollections-io.milvus.param.collection.ShowCollectionsParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>showCollections</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ShowCollectionsResponse> showCollections(<a href="../../../io/milvus/param/collection/ShowCollectionsParam.html" title="class in io.milvus.param.collection">ShowCollectionsParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#showCollections-io.milvus.param.collection.ShowCollectionsParam-">MilvusClient</a></code></span></div>
- <div class="block">Lists all collections or gets collection loading status.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#showCollections-io.milvus.param.collection.ShowCollectionsParam-">showCollections</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/collection/ShowCollectionsParam.html" title="class in io.milvus.param.collection"><code>ShowCollectionsParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data: ShowCollectionsResponse{status,collection_names,collection_ids,created_timestamps,created_utc_timestamps}}</dd>
- </dl>
- </li>
- </ul>
- <a name="alterCollection-io.milvus.param.collection.AlterCollectionParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>alterCollection</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> alterCollection(<a href="../../../io/milvus/param/collection/AlterCollectionParam.html" title="class in io.milvus.param.collection">AlterCollectionParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#alterCollection-io.milvus.param.collection.AlterCollectionParam-">MilvusClient</a></code></span></div>
- <div class="block">Alter collection with key-value properties.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#alterCollection-io.milvus.param.collection.AlterCollectionParam-">alterCollection</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/collection/AlterCollectionParam.html" title="class in io.milvus.param.collection"><code>AlterCollectionParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
- </dl>
- </li>
- </ul>
- <a name="flush-io.milvus.param.collection.FlushParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>flush</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.FlushResponse> flush(<a href="../../../io/milvus/param/collection/FlushParam.html" title="class in io.milvus.param.collection">FlushParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#flush-io.milvus.param.collection.FlushParam-">MilvusClient</a></code></span></div>
- <div class="block">Flushes inserted data in buffer into storage.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#flush-io.milvus.param.collection.FlushParam-">flush</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/collection/FlushParam.html" title="class in io.milvus.param.collection"><code>FlushParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code,data: FlushResponse{flush segment ids}}</dd>
- </dl>
- </li>
- </ul>
- <a name="flushAll-boolean-long-long-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>flushAll</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.FlushAllResponse> flushAll(boolean syncFlushAll,
- long syncFlushAllWaitingInterval,
- long syncFlushAllTimeout)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#flushAll-boolean-long-long-">MilvusClient</a></code></span></div>
- <div class="block">Flush all collections. All insertions, deletions, and upserts before `flushAll` will be synced.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#flushAll-boolean-long-long-">flushAll</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>syncFlushAll</code> - {flushAll synchronously or asynchronously}</dd>
- <dd><code>syncFlushAllWaitingInterval</code> - {wait intervel when flushAll synchronously}</dd>
- <dd><code>syncFlushAllTimeout</code> - {timeout when flushAll synchronously}</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code,data: FlushAllResponse{flushAllTs}}</dd>
- </dl>
- </li>
- </ul>
- <a name="createPartition-io.milvus.param.partition.CreatePartitionParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>createPartition</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> createPartition(<a href="../../../io/milvus/param/partition/CreatePartitionParam.html" title="class in io.milvus.param.partition">CreatePartitionParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#createPartition-io.milvus.param.partition.CreatePartitionParam-">MilvusClient</a></code></span></div>
- <div class="block">Creates a partition in the specified collection.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#createPartition-io.milvus.param.partition.CreatePartitionParam-">createPartition</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/partition/CreatePartitionParam.html" title="class in io.milvus.param.partition"><code>CreatePartitionParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
- </dl>
- </li>
- </ul>
- <a name="dropPartition-io.milvus.param.partition.DropPartitionParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>dropPartition</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> dropPartition(<a href="../../../io/milvus/param/partition/DropPartitionParam.html" title="class in io.milvus.param.partition">DropPartitionParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#dropPartition-io.milvus.param.partition.DropPartitionParam-">MilvusClient</a></code></span></div>
- <div class="block">Drops a partition. Note that this method drops all data in this partition
- and the _default partition cannot be dropped.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#dropPartition-io.milvus.param.partition.DropPartitionParam-">dropPartition</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/partition/DropPartitionParam.html" title="class in io.milvus.param.partition"><code>DropPartitionParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
- </dl>
- </li>
- </ul>
- <a name="hasPartition-io.milvus.param.partition.HasPartitionParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>hasPartition</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><java.lang.Boolean> hasPartition(<a href="../../../io/milvus/param/partition/HasPartitionParam.html" title="class in io.milvus.param.partition">HasPartitionParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#hasPartition-io.milvus.param.partition.HasPartitionParam-">MilvusClient</a></code></span></div>
- <div class="block">Checks if a partition exists in the specified collection.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#hasPartition-io.milvus.param.partition.HasPartitionParam-">hasPartition</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/partition/HasPartitionParam.html" title="class in io.milvus.param.partition"><code>HasPartitionParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data: boolean, whether if has collection or not}</dd>
- </dl>
- </li>
- </ul>
- <a name="loadPartitions-io.milvus.param.partition.LoadPartitionsParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>loadPartitions</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> loadPartitions(<a href="../../../io/milvus/param/partition/LoadPartitionsParam.html" title="class in io.milvus.param.partition">LoadPartitionsParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#loadPartitions-io.milvus.param.partition.LoadPartitionsParam-">MilvusClient</a></code></span></div>
- <div class="block">Loads a partition into memory.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#loadPartitions-io.milvus.param.partition.LoadPartitionsParam-">loadPartitions</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/partition/LoadPartitionsParam.html" title="class in io.milvus.param.partition"><code>LoadPartitionsParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
- </dl>
- </li>
- </ul>
- <a name="releasePartitions-io.milvus.param.partition.ReleasePartitionsParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>releasePartitions</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> releasePartitions(<a href="../../../io/milvus/param/partition/ReleasePartitionsParam.html" title="class in io.milvus.param.partition">ReleasePartitionsParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#releasePartitions-io.milvus.param.partition.ReleasePartitionsParam-">MilvusClient</a></code></span></div>
- <div class="block">Releases a partition from memory.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#releasePartitions-io.milvus.param.partition.ReleasePartitionsParam-">releasePartitions</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/partition/ReleasePartitionsParam.html" title="class in io.milvus.param.partition"><code>ReleasePartitionsParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
- </dl>
- </li>
- </ul>
- <a name="getPartitionStatistics-io.milvus.param.partition.GetPartitionStatisticsParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getPartitionStatistics</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetPartitionStatisticsResponse> getPartitionStatistics(<a href="../../../io/milvus/param/partition/GetPartitionStatisticsParam.html" title="class in io.milvus.param.partition">GetPartitionStatisticsParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#getPartitionStatistics-io.milvus.param.partition.GetPartitionStatisticsParam-">MilvusClient</a></code></span></div>
- <div class="block">Shows the statistics information of a partition.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#getPartitionStatistics-io.milvus.param.partition.GetPartitionStatisticsParam-">getPartitionStatistics</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/partition/GetPartitionStatisticsParam.html" title="class in io.milvus.param.partition"><code>GetPartitionStatisticsParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code,data:GetPartitionStatisticsResponse{status,stats}}</dd>
- </dl>
- </li>
- </ul>
- <a name="showPartitions-io.milvus.param.partition.ShowPartitionsParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>showPartitions</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ShowPartitionsResponse> showPartitions(<a href="../../../io/milvus/param/partition/ShowPartitionsParam.html" title="class in io.milvus.param.partition">ShowPartitionsParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#showPartitions-io.milvus.param.partition.ShowPartitionsParam-">MilvusClient</a></code></span></div>
- <div class="block">Shows all partitions in the specified collection.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#showPartitions-io.milvus.param.partition.ShowPartitionsParam-">showPartitions</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/partition/ShowPartitionsParam.html" title="class in io.milvus.param.partition"><code>ShowPartitionsParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:ShowPartitionsResponse{partition_names,partitionIDs,created_timestamps,created_utc_timestamps}}</dd>
- </dl>
- </li>
- </ul>
- <a name="createAlias-io.milvus.param.alias.CreateAliasParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>createAlias</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> createAlias(<a href="../../../io/milvus/param/alias/CreateAliasParam.html" title="class in io.milvus.param.alias">CreateAliasParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#createAlias-io.milvus.param.alias.CreateAliasParam-">MilvusClient</a></code></span></div>
- <div class="block">Creates an alias for a collection.
- Alias can be used in search or query to replace the collection name</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#createAlias-io.milvus.param.alias.CreateAliasParam-">createAlias</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/alias/CreateAliasParam.html" title="class in io.milvus.param.alias"><code>CreateAliasParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
- </dl>
- </li>
- </ul>
- <a name="dropAlias-io.milvus.param.alias.DropAliasParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>dropAlias</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> dropAlias(<a href="../../../io/milvus/param/alias/DropAliasParam.html" title="class in io.milvus.param.alias">DropAliasParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#dropAlias-io.milvus.param.alias.DropAliasParam-">MilvusClient</a></code></span></div>
- <div class="block">Drops an alias for the specified collection.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#dropAlias-io.milvus.param.alias.DropAliasParam-">dropAlias</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/alias/DropAliasParam.html" title="class in io.milvus.param.alias"><code>DropAliasParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
- </dl>
- </li>
- </ul>
- <a name="alterAlias-io.milvus.param.alias.AlterAliasParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>alterAlias</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> alterAlias(<a href="../../../io/milvus/param/alias/AlterAliasParam.html" title="class in io.milvus.param.alias">AlterAliasParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#alterAlias-io.milvus.param.alias.AlterAliasParam-">MilvusClient</a></code></span></div>
- <div class="block">Alters alias from a collection to another.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#alterAlias-io.milvus.param.alias.AlterAliasParam-">alterAlias</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/alias/AlterAliasParam.html" title="class in io.milvus.param.alias"><code>AlterAliasParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
- </dl>
- </li>
- </ul>
- <a name="listAliases-io.milvus.param.alias.ListAliasesParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>listAliases</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ListAliasesResponse> listAliases(<a href="../../../io/milvus/param/alias/ListAliasesParam.html" title="class in io.milvus.param.alias">ListAliasesParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#listAliases-io.milvus.param.alias.ListAliasesParam-">MilvusClient</a></code></span></div>
- <div class="block">List all alias for a collection.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#listAliases-io.milvus.param.alias.ListAliasesParam-">listAliases</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/alias/ListAliasesParam.html" title="class in io.milvus.param.alias"><code>ListAliasesParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:ListAliasesResponse{status, aliases}}</dd>
- </dl>
- </li>
- </ul>
- <a name="createIndex-io.milvus.param.index.CreateIndexParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>createIndex</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> createIndex(<a href="../../../io/milvus/param/index/CreateIndexParam.html" title="class in io.milvus.param.index">CreateIndexParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#createIndex-io.milvus.param.index.CreateIndexParam-">MilvusClient</a></code></span></div>
- <div class="block">Creates an index on a vector field in the specified collection.
- Note that index building is an async progress.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#createIndex-io.milvus.param.index.CreateIndexParam-">createIndex</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/index/CreateIndexParam.html" title="class in io.milvus.param.index"><code>CreateIndexParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
- </dl>
- </li>
- </ul>
- <a name="dropIndex-io.milvus.param.index.DropIndexParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>dropIndex</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> dropIndex(<a href="../../../io/milvus/param/index/DropIndexParam.html" title="class in io.milvus.param.index">DropIndexParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#dropIndex-io.milvus.param.index.DropIndexParam-">MilvusClient</a></code></span></div>
- <div class="block">Drops the index on a vector field in the specified collection.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#dropIndex-io.milvus.param.index.DropIndexParam-">dropIndex</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/index/DropIndexParam.html" title="class in io.milvus.param.index"><code>DropIndexParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
- </dl>
- </li>
- </ul>
- <a name="describeIndex-io.milvus.param.index.DescribeIndexParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>describeIndex</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.DescribeIndexResponse> describeIndex(<a href="../../../io/milvus/param/index/DescribeIndexParam.html" title="class in io.milvus.param.index">DescribeIndexParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#describeIndex-io.milvus.param.index.DescribeIndexParam-">MilvusClient</a></code></span></div>
- <div class="block">Shows the information of the specified index. Current release of Milvus
- only supports showing latest built index.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#describeIndex-io.milvus.param.index.DescribeIndexParam-">describeIndex</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/index/DescribeIndexParam.html" title="class in io.milvus.param.index"><code>DescribeIndexParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:DescribeIndexResponse{status,index_descriptions}}</dd>
- </dl>
- </li>
- </ul>
- <a name="getIndexState-io.milvus.param.index.GetIndexStateParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getIndexState</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetIndexStateResponse> getIndexState(<a href="../../../io/milvus/param/index/GetIndexStateParam.html" title="class in io.milvus.param.index">GetIndexStateParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#getIndexState-io.milvus.param.index.GetIndexStateParam-">MilvusClient</a></code></span></div>
- <div class="block">Shows the index building state(in-progress/finished/failed), and the reason for failure (if any).</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#getIndexState-io.milvus.param.index.GetIndexStateParam-">getIndexState</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/index/GetIndexStateParam.html" title="class in io.milvus.param.index"><code>GetIndexStateParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:GetIndexStateResponse{status,state}}</dd>
- </dl>
- </li>
- </ul>
- <a name="getIndexBuildProgress-io.milvus.param.index.GetIndexBuildProgressParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getIndexBuildProgress</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetIndexBuildProgressResponse> getIndexBuildProgress(<a href="../../../io/milvus/param/index/GetIndexBuildProgressParam.html" title="class in io.milvus.param.index">GetIndexBuildProgressParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#getIndexBuildProgress-io.milvus.param.index.GetIndexBuildProgressParam-">MilvusClient</a></code></span></div>
- <div class="block">Shows the index building progress, such as how many rows are indexed.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#getIndexBuildProgress-io.milvus.param.index.GetIndexBuildProgressParam-">getIndexBuildProgress</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/index/GetIndexBuildProgressParam.html" title="class in io.milvus.param.index"><code>GetIndexBuildProgressParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:GetIndexBuildProgressResponse{status,indexed_rows}}</dd>
- </dl>
- </li>
- </ul>
- <a name="alterIndex-io.milvus.param.index.AlterIndexParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>alterIndex</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> alterIndex(<a href="../../../io/milvus/param/index/AlterIndexParam.html" title="class in io.milvus.param.index">AlterIndexParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#alterIndex-io.milvus.param.index.AlterIndexParam-">MilvusClient</a></code></span></div>
- <div class="block">Alter index with key value properties.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#alterIndex-io.milvus.param.index.AlterIndexParam-">alterIndex</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/index/AlterIndexParam.html" title="class in io.milvus.param.index"><code>AlterIndexParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
- </dl>
- </li>
- </ul>
- <a name="insert-io.milvus.param.dml.InsertParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>insert</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.MutationResult> insert(<a href="../../../io/milvus/param/dml/InsertParam.html" title="class in io.milvus.param.dml">InsertParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#insert-io.milvus.param.dml.InsertParam-">MilvusClient</a></code></span></div>
- <div class="block">Inserts entities into a specified collection . Note that you don't need to
- input primary key field if auto_id is enabled.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#insert-io.milvus.param.dml.InsertParam-">insert</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/dml/InsertParam.html" title="class in io.milvus.param.dml"><code>InsertParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data: MutationResult{insert results}}</dd>
- </dl>
- </li>
- </ul>
- <a name="insertAsync-io.milvus.param.dml.InsertParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>insertAsync</h4>
- <pre>public com.google.common.util.concurrent.ListenableFuture<<a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.MutationResult>> insertAsync(<a href="../../../io/milvus/param/dml/InsertParam.html" title="class in io.milvus.param.dml">InsertParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#insertAsync-io.milvus.param.dml.InsertParam-">MilvusClient</a></code></span></div>
- <div class="block">Inserts entities into a specified collection asynchronously. Note that you don't need to
- input primary key field if auto_id is enabled.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#insertAsync-io.milvus.param.dml.InsertParam-">insertAsync</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/dml/InsertParam.html" title="class in io.milvus.param.dml"><code>InsertParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>a <code>ListenableFuture</code> object which holds the object {status:result code, data: MutationResult{insert results}}</dd>
- </dl>
- </li>
- </ul>
- <a name="upsert-io.milvus.param.dml.UpsertParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>upsert</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.MutationResult> upsert(<a href="../../../io/milvus/param/dml/UpsertParam.html" title="class in io.milvus.param.dml">UpsertParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#upsert-io.milvus.param.dml.UpsertParam-">MilvusClient</a></code></span></div>
- <div class="block">Insert new entities into a specified collection, replace them if the entities already exist.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#upsert-io.milvus.param.dml.UpsertParam-">upsert</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/dml/UpsertParam.html" title="class in io.milvus.param.dml"><code>UpsertParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data: MutationResult{insert results}}</dd>
- </dl>
- </li>
- </ul>
- <a name="upsertAsync-io.milvus.param.dml.UpsertParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>upsertAsync</h4>
- <pre>public com.google.common.util.concurrent.ListenableFuture<<a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.MutationResult>> upsertAsync(<a href="../../../io/milvus/param/dml/UpsertParam.html" title="class in io.milvus.param.dml">UpsertParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#upsertAsync-io.milvus.param.dml.UpsertParam-">MilvusClient</a></code></span></div>
- <div class="block">Insert new entities into a specified collection asynchronously, replace them if the entities already exist.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#upsertAsync-io.milvus.param.dml.UpsertParam-">upsertAsync</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/dml/UpsertParam.html" title="class in io.milvus.param.dml"><code>UpsertParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>a <code>ListenableFuture</code> object which holds the object {status:result code, data: MutationResult{insert results}}</dd>
- </dl>
- </li>
- </ul>
- <a name="delete-io.milvus.param.dml.DeleteParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>delete</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.MutationResult> delete(<a href="../../../io/milvus/param/dml/DeleteParam.html" title="class in io.milvus.param.dml">DeleteParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#delete-io.milvus.param.dml.DeleteParam-">MilvusClient</a></code></span></div>
- <div class="block">Deletes entity(s) based on primary key(s) filtered by boolean expression. Current release
- of Milvus only supports expression in the format "pk_field in [1, 2, ...]"</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#delete-io.milvus.param.dml.DeleteParam-">delete</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/dml/DeleteParam.html" title="class in io.milvus.param.dml"><code>DeleteParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data: MutationResult{delete results}}</dd>
- </dl>
- </li>
- </ul>
- <a name="search-io.milvus.param.dml.SearchParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>search</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.SearchResults> search(<a href="../../../io/milvus/param/dml/SearchParam.html" title="class in io.milvus.param.dml">SearchParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#search-io.milvus.param.dml.SearchParam-">MilvusClient</a></code></span></div>
- <div class="block">Conducts ANN search on a vector field. Use expression to do filtering before search.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#search-io.milvus.param.dml.SearchParam-">search</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/dml/SearchParam.html" title="class in io.milvus.param.dml"><code>SearchParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data: SearchResults{topK results}}</dd>
- </dl>
- </li>
- </ul>
- <a name="searchAsync-io.milvus.param.dml.SearchParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>searchAsync</h4>
- <pre>public com.google.common.util.concurrent.ListenableFuture<<a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.SearchResults>> searchAsync(<a href="../../../io/milvus/param/dml/SearchParam.html" title="class in io.milvus.param.dml">SearchParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#searchAsync-io.milvus.param.dml.SearchParam-">MilvusClient</a></code></span></div>
- <div class="block">Conducts ANN search on a vector field asynchronously. Use expression to do filtering before search.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#searchAsync-io.milvus.param.dml.SearchParam-">searchAsync</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/dml/SearchParam.html" title="class in io.milvus.param.dml"><code>SearchParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>a <code>ListenableFuture</code> object which holds the object {status:result code, data: SearchResults{topK results}}</dd>
- </dl>
- </li>
- </ul>
- <a name="hybridSearch-io.milvus.param.dml.HybridSearchParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>hybridSearch</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.SearchResults> hybridSearch(<a href="../../../io/milvus/param/dml/HybridSearchParam.html" title="class in io.milvus.param.dml">HybridSearchParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#hybridSearch-io.milvus.param.dml.HybridSearchParam-">MilvusClient</a></code></span></div>
- <div class="block">Conducts multi vector similarity search with a ranker for rearrangement.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#hybridSearch-io.milvus.param.dml.HybridSearchParam-">hybridSearch</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/dml/HybridSearchParam.html" title="class in io.milvus.param.dml"><code>HybridSearchParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data: SearchResults{topK results}}</dd>
- </dl>
- </li>
- </ul>
- <a name="hybridSearchAsync-io.milvus.param.dml.HybridSearchParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>hybridSearchAsync</h4>
- <pre>public com.google.common.util.concurrent.ListenableFuture<<a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.SearchResults>> hybridSearchAsync(<a href="../../../io/milvus/param/dml/HybridSearchParam.html" title="class in io.milvus.param.dml">HybridSearchParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#hybridSearchAsync-io.milvus.param.dml.HybridSearchParam-">MilvusClient</a></code></span></div>
- <div class="block">Conducts multi vector similarity search asynchronously with a ranker for rearrangement.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#hybridSearchAsync-io.milvus.param.dml.HybridSearchParam-">hybridSearchAsync</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/dml/HybridSearchParam.html" title="class in io.milvus.param.dml"><code>HybridSearchParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>a <code>ListenableFuture</code> object which holds the object {status:result code, data: SearchResults{topK results}}</dd>
- </dl>
- </li>
- </ul>
- <a name="query-io.milvus.param.dml.QueryParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>query</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.QueryResults> query(<a href="../../../io/milvus/param/dml/QueryParam.html" title="class in io.milvus.param.dml">QueryParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#query-io.milvus.param.dml.QueryParam-">MilvusClient</a></code></span></div>
- <div class="block">Queries entity(s) based on scalar field(s) filtered by boolean expression.
- Note that the order of the returned entities cannot be guaranteed.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#query-io.milvus.param.dml.QueryParam-">query</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/dml/QueryParam.html" title="class in io.milvus.param.dml"><code>QueryParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code,data: QueryResults{filter results}}</dd>
- </dl>
- </li>
- </ul>
- <a name="queryAsync-io.milvus.param.dml.QueryParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>queryAsync</h4>
- <pre>public com.google.common.util.concurrent.ListenableFuture<<a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.QueryResults>> queryAsync(<a href="../../../io/milvus/param/dml/QueryParam.html" title="class in io.milvus.param.dml">QueryParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#queryAsync-io.milvus.param.dml.QueryParam-">MilvusClient</a></code></span></div>
- <div class="block">Queries entity(s) asynchronously based on scalar field(s) filtered by boolean expression.
- Note that the order of the returned entities cannot be guaranteed.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#queryAsync-io.milvus.param.dml.QueryParam-">queryAsync</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/dml/QueryParam.html" title="class in io.milvus.param.dml"><code>QueryParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code,data: QueryResults{filter results}}</dd>
- </dl>
- </li>
- </ul>
- <a name="getMetrics-io.milvus.param.control.GetMetricsParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getMetrics</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetMetricsResponse> getMetrics(<a href="../../../io/milvus/param/control/GetMetricsParam.html" title="class in io.milvus.param.control">GetMetricsParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#getMetrics-io.milvus.param.control.GetMetricsParam-">MilvusClient</a></code></span></div>
- <div class="block">Gets the runtime metrics information of Milvus, returns the result in .json format.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#getMetrics-io.milvus.param.control.GetMetricsParam-">getMetrics</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/control/GetMetricsParam.html" title="class in io.milvus.param.control"><code>GetMetricsParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:GetMetricsResponse{status,metrics}}</dd>
- </dl>
- </li>
- </ul>
- <a name="getFlushState-io.milvus.param.control.GetFlushStateParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getFlushState</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetFlushStateResponse> getFlushState(<a href="../../../io/milvus/param/control/GetFlushStateParam.html" title="class in io.milvus.param.control">GetFlushStateParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#getFlushState-io.milvus.param.control.GetFlushStateParam-">MilvusClient</a></code></span></div>
- <div class="block">Get flush state of specified collection.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#getFlushState-io.milvus.param.control.GetFlushStateParam-">getFlushState</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/control/GetFlushStateParam.html" title="class in io.milvus.param.control"><code>GetFlushStateParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:GetMetricsResponse{status,metrics}}</dd>
- </dl>
- </li>
- </ul>
- <a name="getFlushAllState-io.milvus.param.control.GetFlushAllStateParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getFlushAllState</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetFlushAllStateResponse> getFlushAllState(<a href="../../../io/milvus/param/control/GetFlushAllStateParam.html" title="class in io.milvus.param.control">GetFlushAllStateParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#getFlushAllState-io.milvus.param.control.GetFlushAllStateParam-">MilvusClient</a></code></span></div>
- <div class="block">Get flush state of all segments.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#getFlushAllState-io.milvus.param.control.GetFlushAllStateParam-">getFlushAllState</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/control/GetFlushAllStateParam.html" title="class in io.milvus.param.control"><code>GetFlushAllStateParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:GetMetricsResponse{status,metrics}}</dd>
- </dl>
- </li>
- </ul>
- <a name="getPersistentSegmentInfo-io.milvus.param.control.GetPersistentSegmentInfoParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getPersistentSegmentInfo</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetPersistentSegmentInfoResponse> getPersistentSegmentInfo(<a href="../../../io/milvus/param/control/GetPersistentSegmentInfoParam.html" title="class in io.milvus.param.control">GetPersistentSegmentInfoParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#getPersistentSegmentInfo-io.milvus.param.control.GetPersistentSegmentInfoParam-">MilvusClient</a></code></span></div>
- <div class="block">Gets the information of persistent segments from data node, including row count,
- persistence state(growing or flushed), etc.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#getPersistentSegmentInfo-io.milvus.param.control.GetPersistentSegmentInfoParam-">getPersistentSegmentInfo</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/control/GetPersistentSegmentInfoParam.html" title="class in io.milvus.param.control"><code>GetPersistentSegmentInfoParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:GetPersistentSegmentInfoResponse{status,info}}</dd>
- </dl>
- </li>
- </ul>
- <a name="getQuerySegmentInfo-io.milvus.param.control.GetQuerySegmentInfoParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getQuerySegmentInfo</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetQuerySegmentInfoResponse> getQuerySegmentInfo(<a href="../../../io/milvus/param/control/GetQuerySegmentInfoParam.html" title="class in io.milvus.param.control">GetQuerySegmentInfoParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#getQuerySegmentInfo-io.milvus.param.control.GetQuerySegmentInfoParam-">MilvusClient</a></code></span></div>
- <div class="block">Gets the query information of segments in a collection from query node, including row count,
- memory usage size, index name, etc.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#getQuerySegmentInfo-io.milvus.param.control.GetQuerySegmentInfoParam-">getQuerySegmentInfo</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/control/GetQuerySegmentInfoParam.html" title="class in io.milvus.param.control"><code>GetQuerySegmentInfoParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:GetQuerySegmentInfoResponse{status,info}}</dd>
- </dl>
- </li>
- </ul>
- <a name="getReplicas-io.milvus.param.control.GetReplicasParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getReplicas</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetReplicasResponse> getReplicas(<a href="../../../io/milvus/param/control/GetReplicasParam.html" title="class in io.milvus.param.control">GetReplicasParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#getReplicas-io.milvus.param.control.GetReplicasParam-">MilvusClient</a></code></span></div>
- <div class="block">Returns the collection's replica information</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#getReplicas-io.milvus.param.control.GetReplicasParam-">getReplicas</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/control/GetReplicasParam.html" title="class in io.milvus.param.control"><code>GetReplicasParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:GetReplicasResponse{status,info}}</dd>
- </dl>
- </li>
- </ul>
- <a name="loadBalance-io.milvus.param.control.LoadBalanceParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>loadBalance</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> loadBalance(<a href="../../../io/milvus/param/control/LoadBalanceParam.html" title="class in io.milvus.param.control">LoadBalanceParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#loadBalance-io.milvus.param.control.LoadBalanceParam-">MilvusClient</a></code></span></div>
- <div class="block">Moves segment from a query node to another to keep the load balanced.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#loadBalance-io.milvus.param.control.LoadBalanceParam-">loadBalance</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/control/LoadBalanceParam.html" title="class in io.milvus.param.control"><code>LoadBalanceParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
- </dl>
- </li>
- </ul>
- <a name="getCompactionState-io.milvus.param.control.GetCompactionStateParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getCompactionState</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetCompactionStateResponse> getCompactionState(<a href="../../../io/milvus/param/control/GetCompactionStateParam.html" title="class in io.milvus.param.control">GetCompactionStateParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#getCompactionState-io.milvus.param.control.GetCompactionStateParam-">MilvusClient</a></code></span></div>
- <div class="block">Gets the compaction state by id.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#getCompactionState-io.milvus.param.control.GetCompactionStateParam-">getCompactionState</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/control/GetCompactionStateParam.html" title="class in io.milvus.param.control"><code>GetCompactionStateParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:GetCompactionStateResponse{status,info}}</dd>
- </dl>
- </li>
- </ul>
- <a name="manualCompact-io.milvus.param.control.ManualCompactParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>manualCompact</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ManualCompactionResponse> manualCompact(<a href="../../../io/milvus/param/control/ManualCompactParam.html" title="class in io.milvus.param.control">ManualCompactParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#manualCompact-io.milvus.param.control.ManualCompactParam-">MilvusClient</a></code></span></div>
- <div class="block">Performs a manual compaction.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#manualCompact-io.milvus.param.control.ManualCompactParam-">manualCompact</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/control/ManualCompactParam.html" title="class in io.milvus.param.control"><code>ManualCompactParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:ManualCompactionResponse{status,info}}</dd>
- </dl>
- </li>
- </ul>
- <a name="getCompactionStateWithPlans-io.milvus.param.control.GetCompactionPlansParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getCompactionStateWithPlans</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetCompactionPlansResponse> getCompactionStateWithPlans(<a href="../../../io/milvus/param/control/GetCompactionPlansParam.html" title="class in io.milvus.param.control">GetCompactionPlansParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#getCompactionStateWithPlans-io.milvus.param.control.GetCompactionPlansParam-">MilvusClient</a></code></span></div>
- <div class="block">Gets compaction state with its plan.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#getCompactionStateWithPlans-io.milvus.param.control.GetCompactionPlansParam-">getCompactionStateWithPlans</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/control/GetCompactionPlansParam.html" title="class in io.milvus.param.control"><code>GetCompactionPlansParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:GetCompactionPlansResponse{status,info}}</dd>
- </dl>
- </li>
- </ul>
- <a name="createCredential-io.milvus.param.credential.CreateCredentialParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>createCredential</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> createCredential(<a href="../../../io/milvus/param/credential/CreateCredentialParam.html" title="class in io.milvus.param.credential">CreateCredentialParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#createCredential-io.milvus.param.credential.CreateCredentialParam-">MilvusClient</a></code></span></div>
- <div class="block">Create credential using the given user and password.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#createCredential-io.milvus.param.credential.CreateCredentialParam-">createCredential</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/credential/CreateCredentialParam.html" title="class in io.milvus.param.credential"><code>CreateCredentialParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
- </dl>
- </li>
- </ul>
- <a name="updateCredential-io.milvus.param.credential.UpdateCredentialParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>updateCredential</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> updateCredential(<a href="../../../io/milvus/param/credential/UpdateCredentialParam.html" title="class in io.milvus.param.credential">UpdateCredentialParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#updateCredential-io.milvus.param.credential.UpdateCredentialParam-">MilvusClient</a></code></span></div>
- <div class="block">Update credential using the given user and password.
- You must provide the original password to check if the operation is valid.
- Note: after this operation, client won't change the related header of this connection.
- So if you update credential for this connection, the connection may be invalid.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#updateCredential-io.milvus.param.credential.UpdateCredentialParam-">updateCredential</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/credential/UpdateCredentialParam.html" title="class in io.milvus.param.credential"><code>UpdateCredentialParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
- </dl>
- </li>
- </ul>
- <a name="deleteCredential-io.milvus.param.credential.DeleteCredentialParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>deleteCredential</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> deleteCredential(<a href="../../../io/milvus/param/credential/DeleteCredentialParam.html" title="class in io.milvus.param.credential">DeleteCredentialParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#deleteCredential-io.milvus.param.credential.DeleteCredentialParam-">MilvusClient</a></code></span></div>
- <div class="block">Delete credential corresponding to the user.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#deleteCredential-io.milvus.param.credential.DeleteCredentialParam-">deleteCredential</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/credential/DeleteCredentialParam.html" title="class in io.milvus.param.credential"><code>DeleteCredentialParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
- </dl>
- </li>
- </ul>
- <a name="listCredUsers-io.milvus.param.credential.ListCredUsersParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>listCredUsers</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ListCredUsersResponse> listCredUsers(<a href="../../../io/milvus/param/credential/ListCredUsersParam.html" title="class in io.milvus.param.credential">ListCredUsersParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#listCredUsers-io.milvus.param.credential.ListCredUsersParam-">MilvusClient</a></code></span></div>
- <div class="block">List all user names.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#listCredUsers-io.milvus.param.credential.ListCredUsersParam-">listCredUsers</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/credential/ListCredUsersParam.html" title="class in io.milvus.param.credential"><code>ListCredUsersParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:ListCredUsersResponse{status,info}}</dd>
- </dl>
- </li>
- </ul>
- <a name="createRole-io.milvus.param.role.CreateRoleParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>createRole</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> createRole(<a href="../../../io/milvus/param/role/CreateRoleParam.html" title="class in io.milvus.param.role">CreateRoleParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#createRole-io.milvus.param.role.CreateRoleParam-">MilvusClient</a></code></span></div>
- <div class="block">It will success if the role isn't existed, otherwise fail.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#createRole-io.milvus.param.role.CreateRoleParam-">createRole</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/role/CreateRoleParam.html" title="class in io.milvus.param.role"><code>CreateRoleParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
- </dl>
- </li>
- </ul>
- <a name="dropRole-io.milvus.param.role.DropRoleParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>dropRole</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> dropRole(<a href="../../../io/milvus/param/role/DropRoleParam.html" title="class in io.milvus.param.role">DropRoleParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#dropRole-io.milvus.param.role.DropRoleParam-">MilvusClient</a></code></span></div>
- <div class="block">It will success if the role is existed, otherwise fail.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#dropRole-io.milvus.param.role.DropRoleParam-">dropRole</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/role/DropRoleParam.html" title="class in io.milvus.param.role"><code>DropRoleParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
- </dl>
- </li>
- </ul>
- <a name="addUserToRole-io.milvus.param.role.AddUserToRoleParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>addUserToRole</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> addUserToRole(<a href="../../../io/milvus/param/role/AddUserToRoleParam.html" title="class in io.milvus.param.role">AddUserToRoleParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#addUserToRole-io.milvus.param.role.AddUserToRoleParam-">MilvusClient</a></code></span></div>
- <div class="block">The user will get permissions that the role are allowed to perform operations.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#addUserToRole-io.milvus.param.role.AddUserToRoleParam-">addUserToRole</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/role/AddUserToRoleParam.html" title="class in io.milvus.param.role"><code>AddUserToRoleParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
- </dl>
- </li>
- </ul>
- <a name="removeUserFromRole-io.milvus.param.role.RemoveUserFromRoleParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>removeUserFromRole</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> removeUserFromRole(<a href="../../../io/milvus/param/role/RemoveUserFromRoleParam.html" title="class in io.milvus.param.role">RemoveUserFromRoleParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#removeUserFromRole-io.milvus.param.role.RemoveUserFromRoleParam-">MilvusClient</a></code></span></div>
- <div class="block">The user will remove permissions that the role are allowed to perform operations.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#removeUserFromRole-io.milvus.param.role.RemoveUserFromRoleParam-">removeUserFromRole</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/role/AddUserToRoleParam.html" title="class in io.milvus.param.role"><code>AddUserToRoleParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
- </dl>
- </li>
- </ul>
- <a name="selectRole-io.milvus.param.role.SelectRoleParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>selectRole</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.SelectRoleResponse> selectRole(<a href="../../../io/milvus/param/role/SelectRoleParam.html" title="class in io.milvus.param.role">SelectRoleParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#selectRole-io.milvus.param.role.SelectRoleParam-">MilvusClient</a></code></span></div>
- <div class="block">Get all users who are added to the role.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#selectRole-io.milvus.param.role.SelectRoleParam-">selectRole</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/role/SelectRoleParam.html" title="class in io.milvus.param.role"><code>SelectRoleParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:SelectRoleResponse{status,info}}</dd>
- </dl>
- </li>
- </ul>
- <a name="selectUser-io.milvus.param.role.SelectUserParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>selectUser</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.SelectUserResponse> selectUser(<a href="../../../io/milvus/param/role/SelectUserParam.html" title="class in io.milvus.param.role">SelectUserParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#selectUser-io.milvus.param.role.SelectUserParam-">MilvusClient</a></code></span></div>
- <div class="block">Get all roles the user has.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#selectUser-io.milvus.param.role.SelectUserParam-">selectUser</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/role/SelectUserParam.html" title="class in io.milvus.param.role"><code>SelectUserParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:SelectUserResponse{status,info}}</dd>
- </dl>
- </li>
- </ul>
- <a name="grantRolePrivilege-io.milvus.param.role.GrantRolePrivilegeParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>grantRolePrivilege</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> grantRolePrivilege(<a href="../../../io/milvus/param/role/GrantRolePrivilegeParam.html" title="class in io.milvus.param.role">GrantRolePrivilegeParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#grantRolePrivilege-io.milvus.param.role.GrantRolePrivilegeParam-">MilvusClient</a></code></span></div>
- <div class="block">Grant Role Privilege.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#grantRolePrivilege-io.milvus.param.role.GrantRolePrivilegeParam-">grantRolePrivilege</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/role/GrantRolePrivilegeParam.html" title="class in io.milvus.param.role"><code>GrantRolePrivilegeParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
- </dl>
- </li>
- </ul>
- <a name="revokeRolePrivilege-io.milvus.param.role.RevokeRolePrivilegeParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>revokeRolePrivilege</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> revokeRolePrivilege(<a href="../../../io/milvus/param/role/RevokeRolePrivilegeParam.html" title="class in io.milvus.param.role">RevokeRolePrivilegeParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#revokeRolePrivilege-io.milvus.param.role.RevokeRolePrivilegeParam-">MilvusClient</a></code></span></div>
- <div class="block">Revoke Role Privilege.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#revokeRolePrivilege-io.milvus.param.role.RevokeRolePrivilegeParam-">revokeRolePrivilege</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/role/RevokeRolePrivilegeParam.html" title="class in io.milvus.param.role"><code>RevokeRolePrivilegeParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
- </dl>
- </li>
- </ul>
- <a name="selectGrantForRole-io.milvus.param.role.SelectGrantForRoleParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>selectGrantForRole</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.SelectGrantResponse> selectGrantForRole(<a href="../../../io/milvus/param/role/SelectGrantForRoleParam.html" title="class in io.milvus.param.role">SelectGrantForRoleParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#selectGrantForRole-io.milvus.param.role.SelectGrantForRoleParam-">MilvusClient</a></code></span></div>
- <div class="block">List a grant info for the role and the specific object</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#selectGrantForRole-io.milvus.param.role.SelectGrantForRoleParam-">selectGrantForRole</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/role/SelectGrantForRoleParam.html" title="class in io.milvus.param.role"><code>SelectGrantForRoleParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:SelectRoleResponse{status,info}}</dd>
- </dl>
- </li>
- </ul>
- <a name="selectGrantForRoleAndObject-io.milvus.param.role.SelectGrantForRoleAndObjectParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>selectGrantForRoleAndObject</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.SelectGrantResponse> selectGrantForRoleAndObject(<a href="../../../io/milvus/param/role/SelectGrantForRoleAndObjectParam.html" title="class in io.milvus.param.role">SelectGrantForRoleAndObjectParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#selectGrantForRoleAndObject-io.milvus.param.role.SelectGrantForRoleAndObjectParam-">MilvusClient</a></code></span></div>
- <div class="block">List a grant info for the role</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#selectGrantForRoleAndObject-io.milvus.param.role.SelectGrantForRoleAndObjectParam-">selectGrantForRoleAndObject</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/role/SelectGrantForRoleAndObjectParam.html" title="class in io.milvus.param.role"><code>SelectGrantForRoleAndObjectParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:SelectRoleResponse{status,info}}</dd>
- </dl>
- </li>
- </ul>
- <a name="bulkInsert-io.milvus.param.bulkinsert.BulkInsertParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>bulkInsert</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ImportResponse> bulkInsert(<a href="../../../io/milvus/param/bulkinsert/BulkInsertParam.html" title="class in io.milvus.param.bulkinsert">BulkInsertParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#bulkInsert-io.milvus.param.bulkinsert.BulkInsertParam-">MilvusClient</a></code></span></div>
- <div class="block">Import data from external files, currently support JSON format</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#bulkInsert-io.milvus.param.bulkinsert.BulkInsertParam-">bulkInsert</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/bulkinsert/BulkInsertParam.html" title="class in io.milvus.param.bulkinsert"><code>BulkInsertParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:ImportResponse{status,info}}</dd>
- </dl>
- </li>
- </ul>
- <a name="getBulkInsertState-io.milvus.param.bulkinsert.GetBulkInsertStateParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getBulkInsertState</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetImportStateResponse> getBulkInsertState(<a href="../../../io/milvus/param/bulkinsert/GetBulkInsertStateParam.html" title="class in io.milvus.param.bulkinsert">GetBulkInsertStateParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#getBulkInsertState-io.milvus.param.bulkinsert.GetBulkInsertStateParam-">MilvusClient</a></code></span></div>
- <div class="block">Get state of bulk insert task</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#getBulkInsertState-io.milvus.param.bulkinsert.GetBulkInsertStateParam-">getBulkInsertState</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/bulkinsert/GetBulkInsertStateParam.html" title="class in io.milvus.param.bulkinsert"><code>GetBulkInsertStateParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:GetImportStateResponse{status,info}}</dd>
- </dl>
- </li>
- </ul>
- <a name="listBulkInsertTasks-io.milvus.param.bulkinsert.ListBulkInsertTasksParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>listBulkInsertTasks</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ListImportTasksResponse> listBulkInsertTasks(<a href="../../../io/milvus/param/bulkinsert/ListBulkInsertTasksParam.html" title="class in io.milvus.param.bulkinsert">ListBulkInsertTasksParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#listBulkInsertTasks-io.milvus.param.bulkinsert.ListBulkInsertTasksParam-">MilvusClient</a></code></span></div>
- <div class="block">List bulk insert tasks</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#listBulkInsertTasks-io.milvus.param.bulkinsert.ListBulkInsertTasksParam-">listBulkInsertTasks</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/bulkinsert/ListBulkInsertTasksParam.html" title="class in io.milvus.param.bulkinsert"><code>ListBulkInsertTasksParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:ListImportTasksResponse{status,info}}</dd>
- </dl>
- </li>
- </ul>
- <a name="checkHealth--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>checkHealth</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.CheckHealthResponse> checkHealth()</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#checkHealth--">MilvusClient</a></code></span></div>
- <div class="block">Check server health</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#checkHealth--">checkHealth</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:CheckHealthResponse{status,info}}</dd>
- </dl>
- </li>
- </ul>
- <a name="getVersion--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getVersion</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetVersionResponse> getVersion()</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#getVersion--">MilvusClient</a></code></span></div>
- <div class="block">Get server version</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#getVersion--">getVersion</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:GetVersionResponse{status,info}}</dd>
- </dl>
- </li>
- </ul>
- <a name="getLoadingProgress-io.milvus.param.collection.GetLoadingProgressParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getLoadingProgress</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetLoadingProgressResponse> getLoadingProgress(<a href="../../../io/milvus/param/collection/GetLoadingProgressParam.html" title="class in io.milvus.param.collection">GetLoadingProgressParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#getLoadingProgress-io.milvus.param.collection.GetLoadingProgressParam-">MilvusClient</a></code></span></div>
- <div class="block">Get collection loading progress</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#getLoadingProgress-io.milvus.param.collection.GetLoadingProgressParam-">getLoadingProgress</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/collection/GetLoadingProgressParam.html" title="class in io.milvus.param.collection"><code>GetLoadingProgressParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:GetLoadingProgressResponse{status}}</dd>
- </dl>
- </li>
- </ul>
- <a name="getLoadState-io.milvus.param.collection.GetLoadStateParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getLoadState</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetLoadStateResponse> getLoadState(<a href="../../../io/milvus/param/collection/GetLoadStateParam.html" title="class in io.milvus.param.collection">GetLoadStateParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#getLoadState-io.milvus.param.collection.GetLoadStateParam-">MilvusClient</a></code></span></div>
- <div class="block">Get collection loading state</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#getLoadState-io.milvus.param.collection.GetLoadStateParam-">getLoadState</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/collection/GetLoadStateParam.html" title="class in io.milvus.param.collection"><code>GetLoadStateParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:GetLoadStateResponse{status}}</dd>
- </dl>
- </li>
- </ul>
- <a name="createResourceGroup-io.milvus.param.resourcegroup.CreateResourceGroupParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>createResourceGroup</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> createResourceGroup(<a href="../../../io/milvus/param/resourcegroup/CreateResourceGroupParam.html" title="class in io.milvus.param.resourcegroup">CreateResourceGroupParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#createResourceGroup-io.milvus.param.resourcegroup.CreateResourceGroupParam-">MilvusClient</a></code></span></div>
- <div class="block">Create a resource group.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#createResourceGroup-io.milvus.param.resourcegroup.CreateResourceGroupParam-">createResourceGroup</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/resourcegroup/CreateResourceGroupParam.html" title="class in io.milvus.param.resourcegroup"><code>CreateResourceGroupParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
- </dl>
- </li>
- </ul>
- <a name="updateResourceGroups-io.milvus.param.resourcegroup.UpdateResourceGroupsParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>updateResourceGroups</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> updateResourceGroups(<a href="../../../io/milvus/param/resourcegroup/UpdateResourceGroupsParam.html" title="class in io.milvus.param.resourcegroup">UpdateResourceGroupsParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#updateResourceGroups-io.milvus.param.resourcegroup.UpdateResourceGroupsParam-">MilvusClient</a></code></span></div>
- <div class="block">Update resource groups.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#updateResourceGroups-io.milvus.param.resourcegroup.UpdateResourceGroupsParam-">updateResourceGroups</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/resourcegroup/UpdateResourceGroupsParam.html" title="class in io.milvus.param.resourcegroup"><code>UpdateResourceGroupsParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
- </dl>
- </li>
- </ul>
- <a name="dropResourceGroup-io.milvus.param.resourcegroup.DropResourceGroupParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>dropResourceGroup</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> dropResourceGroup(<a href="../../../io/milvus/param/resourcegroup/DropResourceGroupParam.html" title="class in io.milvus.param.resourcegroup">DropResourceGroupParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#dropResourceGroup-io.milvus.param.resourcegroup.DropResourceGroupParam-">MilvusClient</a></code></span></div>
- <div class="block">Drop a resource group.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#dropResourceGroup-io.milvus.param.resourcegroup.DropResourceGroupParam-">dropResourceGroup</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/resourcegroup/DropResourceGroupParam.html" title="class in io.milvus.param.resourcegroup"><code>DropResourceGroupParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
- </dl>
- </li>
- </ul>
- <a name="listResourceGroups-io.milvus.param.resourcegroup.ListResourceGroupsParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>listResourceGroups</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ListResourceGroupsResponse> listResourceGroups(<a href="../../../io/milvus/param/resourcegroup/ListResourceGroupsParam.html" title="class in io.milvus.param.resourcegroup">ListResourceGroupsParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#listResourceGroups-io.milvus.param.resourcegroup.ListResourceGroupsParam-">MilvusClient</a></code></span></div>
- <div class="block">List resource groups.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#listResourceGroups-io.milvus.param.resourcegroup.ListResourceGroupsParam-">listResourceGroups</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/resourcegroup/ListResourceGroupsParam.html" title="class in io.milvus.param.resourcegroup"><code>ListResourceGroupsParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:ListResourceGroupsResponse{status}}</dd>
- </dl>
- </li>
- </ul>
- <a name="describeResourceGroup-io.milvus.param.resourcegroup.DescribeResourceGroupParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>describeResourceGroup</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.DescribeResourceGroupResponse> describeResourceGroup(<a href="../../../io/milvus/param/resourcegroup/DescribeResourceGroupParam.html" title="class in io.milvus.param.resourcegroup">DescribeResourceGroupParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#describeResourceGroup-io.milvus.param.resourcegroup.DescribeResourceGroupParam-">MilvusClient</a></code></span></div>
- <div class="block">Describe a resource group.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#describeResourceGroup-io.milvus.param.resourcegroup.DescribeResourceGroupParam-">describeResourceGroup</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/resourcegroup/DescribeResourceGroupParam.html" title="class in io.milvus.param.resourcegroup"><code>DescribeResourceGroupParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:DescribeResourceGroupResponse{status}}</dd>
- </dl>
- </li>
- </ul>
- <a name="transferNode-io.milvus.param.resourcegroup.TransferNodeParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>transferNode</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> transferNode(<a href="../../../io/milvus/param/resourcegroup/TransferNodeParam.html" title="class in io.milvus.param.resourcegroup">TransferNodeParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#transferNode-io.milvus.param.resourcegroup.TransferNodeParam-">MilvusClient</a></code></span></div>
- <div class="block">Transfer a query node from source resource group to target resource_group.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#transferNode-io.milvus.param.resourcegroup.TransferNodeParam-">transferNode</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/resourcegroup/TransferNodeParam.html" title="class in io.milvus.param.resourcegroup"><code>TransferNodeParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
- </dl>
- </li>
- </ul>
- <a name="transferReplica-io.milvus.param.resourcegroup.TransferReplicaParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>transferReplica</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> transferReplica(<a href="../../../io/milvus/param/resourcegroup/TransferReplicaParam.html" title="class in io.milvus.param.resourcegroup">TransferReplicaParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#transferReplica-io.milvus.param.resourcegroup.TransferReplicaParam-">MilvusClient</a></code></span></div>
- <div class="block">Transfer a replica from source resource group to target resource_group.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#transferReplica-io.milvus.param.resourcegroup.TransferReplicaParam-">transferReplica</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/resourcegroup/TransferReplicaParam.html" title="class in io.milvus.param.resourcegroup"><code>TransferReplicaParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
- </dl>
- </li>
- </ul>
- <a name="createCollection-io.milvus.param.highlevel.collection.CreateSimpleCollectionParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>createCollection</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> createCollection(<a href="../../../io/milvus/param/highlevel/collection/CreateSimpleCollectionParam.html" title="class in io.milvus.param.highlevel.collection">CreateSimpleCollectionParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#createCollection-io.milvus.param.highlevel.collection.CreateSimpleCollectionParam-">MilvusClient</a></code></span></div>
- <div class="block">Creates a collection in Milvus.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#createCollection-io.milvus.param.highlevel.collection.CreateSimpleCollectionParam-">createCollection</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <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>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
- </dl>
- </li>
- </ul>
- <a name="listCollections-io.milvus.param.highlevel.collection.ListCollectionsParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>listCollections</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/highlevel/collection/response/ListCollectionsResponse.html" title="class in io.milvus.param.highlevel.collection.response">ListCollectionsResponse</a>> listCollections(<a href="../../../io/milvus/param/highlevel/collection/ListCollectionsParam.html" title="class in io.milvus.param.highlevel.collection">ListCollectionsParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#listCollections-io.milvus.param.highlevel.collection.ListCollectionsParam-">MilvusClient</a></code></span></div>
- <div class="block">Lists all collections</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#listCollections-io.milvus.param.highlevel.collection.ListCollectionsParam-">listCollections</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <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>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data: ListCollectionsResponse{collection_names}}</dd>
- </dl>
- </li>
- </ul>
- <a name="insert-io.milvus.param.highlevel.dml.InsertRowsParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>insert</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/highlevel/dml/response/InsertResponse.html" title="class in io.milvus.param.highlevel.dml.response">InsertResponse</a>> insert(<a href="../../../io/milvus/param/highlevel/dml/InsertRowsParam.html" title="class in io.milvus.param.highlevel.dml">InsertRowsParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#insert-io.milvus.param.highlevel.dml.InsertRowsParam-">MilvusClient</a></code></span></div>
- <div class="block">Inserts rows data into a specified collection . Note that you don't need to
- input primary key field if auto_id is enabled.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#insert-io.milvus.param.highlevel.dml.InsertRowsParam-">insert</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <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>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data: MutationResult{insert results}}</dd>
- </dl>
- </li>
- </ul>
- <a name="delete-io.milvus.param.highlevel.dml.DeleteIdsParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>delete</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/highlevel/dml/response/DeleteResponse.html" title="class in io.milvus.param.highlevel.dml.response">DeleteResponse</a>> delete(<a href="../../../io/milvus/param/highlevel/dml/DeleteIdsParam.html" title="class in io.milvus.param.highlevel.dml">DeleteIdsParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#delete-io.milvus.param.highlevel.dml.DeleteIdsParam-">MilvusClient</a></code></span></div>
- <div class="block">Deletes entity(s) based on the value of primary key.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#delete-io.milvus.param.highlevel.dml.DeleteIdsParam-">delete</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <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>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data: MutationResult{delete results}}</dd>
- </dl>
- </li>
- </ul>
- <a name="get-io.milvus.param.highlevel.dml.GetIdsParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>get</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/highlevel/dml/response/GetResponse.html" title="class in io.milvus.param.highlevel.dml.response">GetResponse</a>> get(<a href="../../../io/milvus/param/highlevel/dml/GetIdsParam.html" title="class in io.milvus.param.highlevel.dml">GetIdsParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#get-io.milvus.param.highlevel.dml.GetIdsParam-">MilvusClient</a></code></span></div>
- <div class="block">Get entity(s) based on the value of primary key.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#get-io.milvus.param.highlevel.dml.GetIdsParam-">get</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <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>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data: QueryResults{query results}}</dd>
- </dl>
- </li>
- </ul>
- <a name="query-io.milvus.param.highlevel.dml.QuerySimpleParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>query</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/highlevel/dml/response/QueryResponse.html" title="class in io.milvus.param.highlevel.dml.response">QueryResponse</a>> query(<a href="../../../io/milvus/param/highlevel/dml/QuerySimpleParam.html" title="class in io.milvus.param.highlevel.dml">QuerySimpleParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#query-io.milvus.param.highlevel.dml.QuerySimpleParam-">MilvusClient</a></code></span></div>
- <div class="block">Queries entity(s) based on scalar field(s) filtered by boolean expression.
- Note that the order of the returned entities cannot be guaranteed.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#query-io.milvus.param.highlevel.dml.QuerySimpleParam-">query</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <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>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code,data: QueryResults{filter results}}</dd>
- </dl>
- </li>
- </ul>
- <a name="search-io.milvus.param.highlevel.dml.SearchSimpleParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>search</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/param/highlevel/dml/response/SearchResponse.html" title="class in io.milvus.param.highlevel.dml.response">SearchResponse</a>> search(<a href="../../../io/milvus/param/highlevel/dml/SearchSimpleParam.html" title="class in io.milvus.param.highlevel.dml">SearchSimpleParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#search-io.milvus.param.highlevel.dml.SearchSimpleParam-">MilvusClient</a></code></span></div>
- <div class="block">Conducts ANN search on a vector field. Use expression to do filtering before search.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#search-io.milvus.param.highlevel.dml.SearchSimpleParam-">search</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <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>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data: SearchResults{topK results}}</dd>
- </dl>
- </li>
- </ul>
- <a name="queryIterator-io.milvus.param.dml.QueryIteratorParam-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>queryIterator</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/orm/iterator/QueryIterator.html" title="class in io.milvus.orm.iterator">QueryIterator</a>> queryIterator(<a href="../../../io/milvus/param/dml/QueryIteratorParam.html" title="class in io.milvus.param.dml">QueryIteratorParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#queryIterator-io.milvus.param.dml.QueryIteratorParam-">MilvusClient</a></code></span></div>
- <div class="block">Get queryIterator based on scalar field(s) filtered by boolean expression.
- Note that the order of the returned entities cannot be guaranteed.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#queryIterator-io.milvus.param.dml.QueryIteratorParam-">queryIterator</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/dml/QueryIteratorParam.html" title="class in io.milvus.param.dml"><code>QueryIteratorParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code,data: QueryIterator}</dd>
- </dl>
- </li>
- </ul>
- <a name="searchIterator-io.milvus.param.dml.SearchIteratorParam-">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>searchIterator</h4>
- <pre>public <a href="../../../io/milvus/param/R.html" title="class in io.milvus.param">R</a><<a href="../../../io/milvus/orm/iterator/SearchIterator.html" title="class in io.milvus.orm.iterator">SearchIterator</a>> searchIterator(<a href="../../../io/milvus/param/dml/SearchIteratorParam.html" title="class in io.milvus.param.dml">SearchIteratorParam</a> requestParam)</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../io/milvus/client/MilvusClient.html#searchIterator-io.milvus.param.dml.SearchIteratorParam-">MilvusClient</a></code></span></div>
- <div class="block">Get searchIterator based on a vector field. Use expression to do filtering before search.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="../../../io/milvus/client/MilvusClient.html#searchIterator-io.milvus.param.dml.SearchIteratorParam-">searchIterator</a></code> in interface <code><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>requestParam</code> - <a href="../../../io/milvus/param/dml/SearchIteratorParam.html" title="class in io.milvus.param.dml"><code>SearchIteratorParam</code></a></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>{status:result code, data: SearchIterator}</dd>
- </dl>
- </li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- </div>
- </div>
- <!-- ========= END OF CLASS DATA ========= -->
- <!-- ======= START OF BOTTOM NAVBAR ====== -->
- <div class="bottomNav"><a name="navbar.bottom">
- <!-- -->
- </a>
- <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
- <a name="navbar.bottom.firstrow">
- <!-- -->
- </a>
- <ul class="navList" title="Navigation">
- <li><a href="../../../overview-summary.html">Overview</a></li>
- <li><a href="package-summary.html">Package</a></li>
- <li class="navBarCell1Rev">Class</li>
- <li><a href="package-tree.html">Tree</a></li>
- <li><a href="../../../deprecated-list.html">Deprecated</a></li>
- <li><a href="../../../index-files/index-1.html">Index</a></li>
- <li><a href="../../../help-doc.html">Help</a></li>
- </ul>
- </div>
- <div class="subNav">
- <ul class="navList">
- <li><a href="../../../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client"><span class="typeNameLink">Prev Class</span></a></li>
- <li><a href="../../../io/milvus/client/MilvusServiceClient.html" title="class in io.milvus.client"><span class="typeNameLink">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../../../index.html?io/milvus/client/MilvusMultiServiceClient.html" target="_top">Frames</a></li>
- <li><a href="MilvusMultiServiceClient.html" target="_top">No Frames</a></li>
- </ul>
- <ul class="navList" id="allclasses_navbar_bottom">
- <li><a href="../../../allclasses-noframe.html">All Classes</a></li>
- </ul>
- <div>
- <script type="text/javascript"><!--
- allClassesLink = document.getElementById("allclasses_navbar_bottom");
- if(window==top) {
- allClassesLink.style.display = "block";
- }
- else {
- allClassesLink.style.display = "none";
- }
- //-->
- </script>
- </div>
- <div>
- <ul class="subNavList">
- <li>Summary: </li>
- <li>Nested | </li>
- <li>Field | </li>
- <li><a href="#constructor.summary">Constr</a> | </li>
- <li><a href="#method.summary">Method</a></li>
- </ul>
- <ul class="subNavList">
- <li>Detail: </li>
- <li>Field | </li>
- <li><a href="#constructor.detail">Constr</a> | </li>
- <li><a href="#method.detail">Method</a></li>
- </ul>
- </div>
- <a name="skip.navbar.bottom">
- <!-- -->
- </a></div>
- <!-- ======== END OF BOTTOM NAVBAR ======= -->
- </body>
- </html>
|