1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566 |
- <!DOCTYPE HTML>
- <!-- NewPage -->
- <html lang="en">
- <head>
- <!-- Generated by javadoc (11.0.18) on Wed Nov 08 17:48:37 CST 2023 -->
- <title>MilvusMultiServiceClient</title>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
- <meta name="dc.created" content="2023-11-08">
- <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
- <link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.min.css" title="Style">
- <link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style">
- <script type="text/javascript" src="../../../script.js"></script>
- <script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
- <script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
- <!--[if IE]>
- <script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
- <![endif]-->
- <script type="text/javascript" src="../../../jquery/jquery-3.6.0.min.js"></script>
- <script type="text/javascript" src="../../../jquery/jquery-ui.min.js"></script>
- </head>
- <body>
- <script type="text/javascript"><!--
- try {
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="MilvusMultiServiceClient";
- }
- }
- catch(err) {
- }
- //-->
- var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10,"i57":10,"i58":10,"i59":10,"i60":10,"i61":10,"i62":10,"i63":10,"i64":10,"i65":10,"i66":10,"i67":10,"i68":10,"i69":10,"i70":10,"i71":10,"i72":10,"i73":10,"i74":10,"i75":10,"i76":10,"i77":10,"i78":10,"i79":10,"i80":10,"i81":10,"i82":10,"i83":10,"i84":10,"i85":10};
- 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";
- var pathtoroot = "../../../";
- var useModuleDirectories = true;
- loadScripts(document, 'script');</script>
- <noscript>
- <div>JavaScript is disabled on your browser.</div>
- </noscript>
- <header role="banner">
- <nav role="navigation">
- <div class="fixedNav">
- <!-- ========= START OF TOP NAVBAR ======= -->
- <div class="topNav"><a id="navbar.top">
- <!-- -->
- </a>
- <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
- <a id="navbar.top.firstrow">
- <!-- -->
- </a>
- <ul class="navList" title="Navigation">
- <li><a href="../../../index.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" id="allclasses_navbar_top">
- <li><a href="../../../allclasses.html">All Classes</a></li>
- </ul>
- <ul class="navListSearch">
- <li><label for="search">SEARCH:</label>
- <input type="text" id="search" value="search" disabled="disabled">
- <input type="reset" id="reset" value="reset" disabled="disabled">
- </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>
- <noscript>
- <div>JavaScript is disabled on your browser.</div>
- </noscript>
- </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 id="skip.navbar.top">
- <!-- -->
- </a></div>
- <!-- ========= END OF TOP NAVBAR ========= -->
- </div>
- <div class="navPadding"> </div>
- <script type="text/javascript"><!--
- $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
- //-->
- </script>
- </nav>
- </header>
- <!-- ======== START OF CLASS DATA ======== -->
- <main role="main">
- <div class="header">
- <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">io.milvus.client</a></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><code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
- </dl>
- <hr>
- <pre>public class <span class="typeNameLabel">MilvusMultiServiceClient</span>
- extends java.lang.Object
- implements <a href="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 ======== -->
- <section>
- <ul class="blockList">
- <li class="blockList"><a id="constructor.summary">
- <!-- -->
- </a>
- <h3>Constructor Summary</h3>
- <table class="memberSummary">
- <caption><span>Constructors</span><span class="tabEnd"> </span></caption>
- <tr>
- <th class="colFirst" scope="col">Constructor</th>
- <th class="colLast" scope="col">Description</th>
- </tr>
- <tr class="altColor">
- <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(io.milvus.param.MultiConnectParam)">MilvusMultiServiceClient</a></span>​(@NonNull <a href="../param/MultiConnectParam.html" title="class in io.milvus.param">MultiConnectParam</a> multiConnectParam)</code></th>
- <td class="colLast">
- <div class="block">Sets connect param for multi milvus clusters.</div>
- </td>
- </tr>
- </table>
- </li>
- </ul>
- </section>
- <!-- ========== METHOD SUMMARY =========== -->
- <section>
- <ul class="blockList">
- <li class="blockList"><a id="method.summary">
- <!-- -->
- </a>
- <h3>Method Summary</h3>
- <table class="memberSummary">
- <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="colSecond" scope="col">Method</th>
- <th class="colLast" scope="col">Description</th>
- </tr>
- <tr id="i0" class="altColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addUserToRole(io.milvus.param.role.AddUserToRoleParam)">addUserToRole</a></span>​(<a href="../param/role/AddUserToRoleParam.html" title="class in io.milvus.param.role">AddUserToRoleParam</a> requestParam)</code></th>
- <td class="colLast">
- <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="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#alterAlias(io.milvus.param.alias.AlterAliasParam)">alterAlias</a></span>​(<a href="../param/alias/AlterAliasParam.html" title="class in io.milvus.param.alias">AlterAliasParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Alters alias from a collection to another.</div>
- </td>
- </tr>
- <tr id="i2" class="altColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#alterCollection(io.milvus.param.collection.AlterCollectionParam)">alterCollection</a></span>​(<a href="../param/collection/AlterCollectionParam.html" title="class in io.milvus.param.collection">AlterCollectionParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Alter collection.</div>
- </td>
- </tr>
- <tr id="i3" class="rowColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ImportResponse></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#bulkInsert(io.milvus.param.bulkinsert.BulkInsertParam)">bulkInsert</a></span>​(<a href="../param/bulkinsert/BulkInsertParam.html" title="class in io.milvus.param.bulkinsert">BulkInsertParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Import data from external files, currently support JSON format</div>
- </td>
- </tr>
- <tr id="i4" class="altColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.CheckHealthResponse></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkHealth()">checkHealth</a></span>()</code></th>
- <td class="colLast">
- <div class="block">Check server health</div>
- </td>
- </tr>
- <tr id="i5" class="rowColor">
- <td class="colFirst"><code>void</code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close(long)">close</a></span>​(long maxWaitSeconds)</code></th>
- <td class="colLast">
- <div class="block">Disconnects from a Milvus server with configurable timeout.</div>
- </td>
- </tr>
- <tr id="i6" class="altColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createAlias(io.milvus.param.alias.CreateAliasParam)">createAlias</a></span>​(<a href="../param/alias/CreateAliasParam.html" title="class in io.milvus.param.alias">CreateAliasParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Creates an alias for a collection.</div>
- </td>
- </tr>
- <tr id="i7" class="rowColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createCollection(io.milvus.param.collection.CreateCollectionParam)">createCollection</a></span>​(<a href="../param/collection/CreateCollectionParam.html" title="class in io.milvus.param.collection">CreateCollectionParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Creates a collection in Milvus.</div>
- </td>
- </tr>
- <tr id="i8" class="altColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createCollection(io.milvus.param.highlevel.collection.CreateSimpleCollectionParam)">createCollection</a></span>​(<a href="../param/highlevel/collection/CreateSimpleCollectionParam.html" title="class in io.milvus.param.highlevel.collection">CreateSimpleCollectionParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Creates a collection in Milvus.</div>
- </td>
- </tr>
- <tr id="i9" class="rowColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createCredential(io.milvus.param.credential.CreateCredentialParam)">createCredential</a></span>​(<a href="../param/credential/CreateCredentialParam.html" title="class in io.milvus.param.credential">CreateCredentialParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Create credential using the given user and password.</div>
- </td>
- </tr>
- <tr id="i10" class="altColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createDatabase(io.milvus.param.collection.CreateDatabaseParam)">createDatabase</a></span>​(<a href="../param/collection/CreateDatabaseParam.html" title="class in io.milvus.param.collection">CreateDatabaseParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Creates a database in Milvus.</div>
- </td>
- </tr>
- <tr id="i11" class="rowColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createIndex(io.milvus.param.index.CreateIndexParam)">createIndex</a></span>​(<a href="../param/index/CreateIndexParam.html" title="class in io.milvus.param.index">CreateIndexParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Creates an index on a vector field in the specified collection.</div>
- </td>
- </tr>
- <tr id="i12" class="altColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createPartition(io.milvus.param.partition.CreatePartitionParam)">createPartition</a></span>​(<a href="../param/partition/CreatePartitionParam.html" title="class in io.milvus.param.partition">CreatePartitionParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Creates a partition in the specified collection.</div>
- </td>
- </tr>
- <tr id="i13" class="rowColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createResourceGroup(io.milvus.param.resourcegroup.CreateResourceGroupParam)">createResourceGroup</a></span>​(<a href="../param/resourcegroup/CreateResourceGroupParam.html" title="class in io.milvus.param.resourcegroup">CreateResourceGroupParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Create a resource group.</div>
- </td>
- </tr>
- <tr id="i14" class="altColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createRole(io.milvus.param.role.CreateRoleParam)">createRole</a></span>​(<a href="../param/role/CreateRoleParam.html" title="class in io.milvus.param.role">CreateRoleParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">It will success if the role isn't existed, otherwise fail.</div>
- </td>
- </tr>
- <tr id="i15" class="rowColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.MutationResult></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#delete(io.milvus.param.dml.DeleteParam)">delete</a></span>​(<a href="../param/dml/DeleteParam.html" title="class in io.milvus.param.dml">DeleteParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Deletes entity(s) based on primary key(s) filtered by boolean expression.</div>
- </td>
- </tr>
- <tr id="i16" class="altColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/highlevel/dml/response/DeleteResponse.html" title="class in io.milvus.param.highlevel.dml.response">DeleteResponse</a>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#delete(io.milvus.param.highlevel.dml.DeleteIdsParam)">delete</a></span>​(<a href="../param/highlevel/dml/DeleteIdsParam.html" title="class in io.milvus.param.highlevel.dml">DeleteIdsParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Deletes entity(s) based on the value of primary key.</div>
- </td>
- </tr>
- <tr id="i17" class="rowColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deleteCredential(io.milvus.param.credential.DeleteCredentialParam)">deleteCredential</a></span>​(<a href="../param/credential/DeleteCredentialParam.html" title="class in io.milvus.param.credential">DeleteCredentialParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Delete credential corresponding to the user.</div>
- </td>
- </tr>
- <tr id="i18" class="altColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.DescribeCollectionResponse></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#describeCollection(io.milvus.param.collection.DescribeCollectionParam)">describeCollection</a></span>​(<a href="../param/collection/DescribeCollectionParam.html" title="class in io.milvus.param.collection">DescribeCollectionParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Shows the details of a collection, e.g.</div>
- </td>
- </tr>
- <tr id="i19" class="rowColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.DescribeIndexResponse></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#describeIndex(io.milvus.param.index.DescribeIndexParam)">describeIndex</a></span>​(<a href="../param/index/DescribeIndexParam.html" title="class in io.milvus.param.index">DescribeIndexParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Shows the information of the specified index.</div>
- </td>
- </tr>
- <tr id="i20" class="altColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.DescribeResourceGroupResponse></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#describeResourceGroup(io.milvus.param.resourcegroup.DescribeResourceGroupParam)">describeResourceGroup</a></span>​(<a href="../param/resourcegroup/DescribeResourceGroupParam.html" title="class in io.milvus.param.resourcegroup">DescribeResourceGroupParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Describe a resource group.</div>
- </td>
- </tr>
- <tr id="i21" class="rowColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropAlias(io.milvus.param.alias.DropAliasParam)">dropAlias</a></span>​(<a href="../param/alias/DropAliasParam.html" title="class in io.milvus.param.alias">DropAliasParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Drops an alias for the specified collection.</div>
- </td>
- </tr>
- <tr id="i22" class="altColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropCollection(io.milvus.param.collection.DropCollectionParam)">dropCollection</a></span>​(<a href="../param/collection/DropCollectionParam.html" title="class in io.milvus.param.collection">DropCollectionParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Drops a collection.</div>
- </td>
- </tr>
- <tr id="i23" class="rowColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropDatabase(io.milvus.param.collection.DropDatabaseParam)">dropDatabase</a></span>​(<a href="../param/collection/DropDatabaseParam.html" title="class in io.milvus.param.collection">DropDatabaseParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Drops a database.</div>
- </td>
- </tr>
- <tr id="i24" class="altColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropIndex(io.milvus.param.index.DropIndexParam)">dropIndex</a></span>​(<a href="../param/index/DropIndexParam.html" title="class in io.milvus.param.index">DropIndexParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Drops the index on a vector field in the specified collection.</div>
- </td>
- </tr>
- <tr id="i25" class="rowColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropPartition(io.milvus.param.partition.DropPartitionParam)">dropPartition</a></span>​(<a href="../param/partition/DropPartitionParam.html" title="class in io.milvus.param.partition">DropPartitionParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Drops a partition.</div>
- </td>
- </tr>
- <tr id="i26" class="altColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropResourceGroup(io.milvus.param.resourcegroup.DropResourceGroupParam)">dropResourceGroup</a></span>​(<a href="../param/resourcegroup/DropResourceGroupParam.html" title="class in io.milvus.param.resourcegroup">DropResourceGroupParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Drop a resource group.</div>
- </td>
- </tr>
- <tr id="i27" class="rowColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropRole(io.milvus.param.role.DropRoleParam)">dropRole</a></span>​(<a href="../param/role/DropRoleParam.html" title="class in io.milvus.param.role">DropRoleParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">It will success if the role is existed, otherwise fail.</div>
- </td>
- </tr>
- <tr id="i28" class="altColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.FlushResponse></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#flush(io.milvus.param.collection.FlushParam)">flush</a></span>​(<a href="../param/collection/FlushParam.html" title="class in io.milvus.param.collection">FlushParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Flushes inserted data in buffer into storage.</div>
- </td>
- </tr>
- <tr id="i29" class="rowColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.FlushAllResponse></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#flushAll(boolean,long,long)">flushAll</a></span>​(boolean syncFlushAll,
- long syncFlushAllWaitingInterval,
- long syncFlushAllTimeout)</code></th>
- <td class="colLast">
- <div class="block">Flush all collections.</div>
- </td>
- </tr>
- <tr id="i30" class="altColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/highlevel/dml/response/GetResponse.html" title="class in io.milvus.param.highlevel.dml.response">GetResponse</a>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#get(io.milvus.param.highlevel.dml.GetIdsParam)">get</a></span>​(<a href="../param/highlevel/dml/GetIdsParam.html" title="class in io.milvus.param.highlevel.dml">GetIdsParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Get entity(s) based on the value of primary key.</div>
- </td>
- </tr>
- <tr id="i31" class="rowColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetImportStateResponse></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBulkInsertState(io.milvus.param.bulkinsert.GetBulkInsertStateParam)">getBulkInsertState</a></span>​(<a href="../param/bulkinsert/GetBulkInsertStateParam.html" title="class in io.milvus.param.bulkinsert">GetBulkInsertStateParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Get state of bulk insert task</div>
- </td>
- </tr>
- <tr id="i32" class="altColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetCollectionStatisticsResponse></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCollectionStatistics(io.milvus.param.collection.GetCollectionStatisticsParam)">getCollectionStatistics</a></span>​(<a href="../param/collection/GetCollectionStatisticsParam.html" title="class in io.milvus.param.collection">GetCollectionStatisticsParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Shows the statistics information of a collection.</div>
- </td>
- </tr>
- <tr id="i33" class="rowColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetCompactionStateResponse></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCompactionState(io.milvus.param.control.GetCompactionStateParam)">getCompactionState</a></span>​(<a href="../param/control/GetCompactionStateParam.html" title="class in io.milvus.param.control">GetCompactionStateParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Gets the compaction state by id.</div>
- </td>
- </tr>
- <tr id="i34" class="altColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetCompactionPlansResponse></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCompactionStateWithPlans(io.milvus.param.control.GetCompactionPlansParam)">getCompactionStateWithPlans</a></span>​(<a href="../param/control/GetCompactionPlansParam.html" title="class in io.milvus.param.control">GetCompactionPlansParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Gets compaction state with its plan.</div>
- </td>
- </tr>
- <tr id="i35" class="rowColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetFlushAllStateResponse></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFlushAllState(io.milvus.param.control.GetFlushAllStateParam)">getFlushAllState</a></span>​(<a href="../param/control/GetFlushAllStateParam.html" title="class in io.milvus.param.control">GetFlushAllStateParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Get flush state of all segments.</div>
- </td>
- </tr>
- <tr id="i36" class="altColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetFlushStateResponse></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFlushState(io.milvus.param.control.GetFlushStateParam)">getFlushState</a></span>​(<a href="../param/control/GetFlushStateParam.html" title="class in io.milvus.param.control">GetFlushStateParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Get flush state of specified segments.</div>
- </td>
- </tr>
- <tr id="i37" class="rowColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetIndexBuildProgressResponse></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIndexBuildProgress(io.milvus.param.index.GetIndexBuildProgressParam)">getIndexBuildProgress</a></span>​(<a href="../param/index/GetIndexBuildProgressParam.html" title="class in io.milvus.param.index">GetIndexBuildProgressParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Shows the index building progress, such as how many rows are indexed.</div>
- </td>
- </tr>
- <tr id="i38" class="altColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetIndexStateResponse></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIndexState(io.milvus.param.index.GetIndexStateParam)">getIndexState</a></span>​(<a href="../param/index/GetIndexStateParam.html" title="class in io.milvus.param.index">GetIndexStateParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Shows the index building state(in-progress/finished/failed), and the reason for failure (if any).</div>
- </td>
- </tr>
- <tr id="i39" class="rowColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetLoadingProgressResponse></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLoadingProgress(io.milvus.param.collection.GetLoadingProgressParam)">getLoadingProgress</a></span>​(<a href="../param/collection/GetLoadingProgressParam.html" title="class in io.milvus.param.collection">GetLoadingProgressParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Get collection loading progress</div>
- </td>
- </tr>
- <tr id="i40" class="altColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetLoadStateResponse></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLoadState(io.milvus.param.collection.GetLoadStateParam)">getLoadState</a></span>​(<a href="../param/collection/GetLoadStateParam.html" title="class in io.milvus.param.collection">GetLoadStateParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Get collection loading state</div>
- </td>
- </tr>
- <tr id="i41" class="rowColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetMetricsResponse></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMetrics(io.milvus.param.control.GetMetricsParam)">getMetrics</a></span>​(<a href="../param/control/GetMetricsParam.html" title="class in io.milvus.param.control">GetMetricsParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Gets the runtime metrics information of Milvus, returns the result in .json format.</div>
- </td>
- </tr>
- <tr id="i42" class="altColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetPartitionStatisticsResponse></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPartitionStatistics(io.milvus.param.partition.GetPartitionStatisticsParam)">getPartitionStatistics</a></span>​(<a href="../param/partition/GetPartitionStatisticsParam.html" title="class in io.milvus.param.partition">GetPartitionStatisticsParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Shows the statistics information of a partition.</div>
- </td>
- </tr>
- <tr id="i43" class="rowColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetPersistentSegmentInfoResponse></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPersistentSegmentInfo(io.milvus.param.control.GetPersistentSegmentInfoParam)">getPersistentSegmentInfo</a></span>​(<a href="../param/control/GetPersistentSegmentInfoParam.html" title="class in io.milvus.param.control">GetPersistentSegmentInfoParam</a> requestParam)</code></th>
- <td class="colLast">
- <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="i44" class="altColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetQuerySegmentInfoResponse></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getQuerySegmentInfo(io.milvus.param.control.GetQuerySegmentInfoParam)">getQuerySegmentInfo</a></span>​(<a href="../param/control/GetQuerySegmentInfoParam.html" title="class in io.milvus.param.control">GetQuerySegmentInfoParam</a> requestParam)</code></th>
- <td class="colLast">
- <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="i45" class="rowColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetReplicasResponse></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReplicas(io.milvus.param.control.GetReplicasParam)">getReplicas</a></span>​(<a href="../param/control/GetReplicasParam.html" title="class in io.milvus.param.control">GetReplicasParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Returns the collection's replica information</div>
- </td>
- </tr>
- <tr id="i46" class="altColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetVersionResponse></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getVersion()">getVersion</a></span>()</code></th>
- <td class="colLast">
- <div class="block">Get server version</div>
- </td>
- </tr>
- <tr id="i47" class="rowColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#grantRolePrivilege(io.milvus.param.role.GrantRolePrivilegeParam)">grantRolePrivilege</a></span>​(<a href="../param/role/GrantRolePrivilegeParam.html" title="class in io.milvus.param.role">GrantRolePrivilegeParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Grant Role Privilege.</div>
- </td>
- </tr>
- <tr id="i48" class="altColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><java.lang.Boolean></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasCollection(io.milvus.param.collection.HasCollectionParam)">hasCollection</a></span>​(<a href="../param/collection/HasCollectionParam.html" title="class in io.milvus.param.collection">HasCollectionParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Checks if a collection exists.</div>
- </td>
- </tr>
- <tr id="i49" class="rowColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><java.lang.Boolean></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasPartition(io.milvus.param.partition.HasPartitionParam)">hasPartition</a></span>​(<a href="../param/partition/HasPartitionParam.html" title="class in io.milvus.param.partition">HasPartitionParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Checks if a partition exists in the specified collection.</div>
- </td>
- </tr>
- <tr id="i50" class="altColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.MutationResult></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#insert(io.milvus.param.dml.InsertParam)">insert</a></span>​(<a href="../param/dml/InsertParam.html" title="class in io.milvus.param.dml">InsertParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Inserts entities into a specified collection .</div>
- </td>
- </tr>
- <tr id="i51" class="rowColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/highlevel/dml/response/InsertResponse.html" title="class in io.milvus.param.highlevel.dml.response">InsertResponse</a>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#insert(io.milvus.param.highlevel.dml.InsertRowsParam)">insert</a></span>​(<a href="../param/highlevel/dml/InsertRowsParam.html" title="class in io.milvus.param.highlevel.dml">InsertRowsParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Inserts rows data into a specified collection .</div>
- </td>
- </tr>
- <tr id="i52" class="altColor">
- <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<<a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.MutationResult>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#insertAsync(io.milvus.param.dml.InsertParam)">insertAsync</a></span>​(<a href="../param/dml/InsertParam.html" title="class in io.milvus.param.dml">InsertParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Inserts entities into a specified collection asynchronously.</div>
- </td>
- </tr>
- <tr id="i53" class="rowColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ListImportTasksResponse></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listBulkInsertTasks(io.milvus.param.bulkinsert.ListBulkInsertTasksParam)">listBulkInsertTasks</a></span>​(<a href="../param/bulkinsert/ListBulkInsertTasksParam.html" title="class in io.milvus.param.bulkinsert">ListBulkInsertTasksParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">List bulk insert tasks</div>
- </td>
- </tr>
- <tr id="i54" class="altColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/highlevel/collection/response/ListCollectionsResponse.html" title="class in io.milvus.param.highlevel.collection.response">ListCollectionsResponse</a>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listCollections(io.milvus.param.highlevel.collection.ListCollectionsParam)">listCollections</a></span>​(<a href="../param/highlevel/collection/ListCollectionsParam.html" title="class in io.milvus.param.highlevel.collection">ListCollectionsParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Lists all collections</div>
- </td>
- </tr>
- <tr id="i55" class="rowColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ListCredUsersResponse></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listCredUsers(io.milvus.param.credential.ListCredUsersParam)">listCredUsers</a></span>​(<a href="../param/credential/ListCredUsersParam.html" title="class in io.milvus.param.credential">ListCredUsersParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">List all user names.</div>
- </td>
- </tr>
- <tr id="i56" class="altColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ListDatabasesResponse></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listDatabases()">listDatabases</a></span>()</code></th>
- <td class="colLast">
- <div class="block">List databases.</div>
- </td>
- </tr>
- <tr id="i57" class="rowColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ListResourceGroupsResponse></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listResourceGroups(io.milvus.param.resourcegroup.ListResourceGroupsParam)">listResourceGroups</a></span>​(<a href="../param/resourcegroup/ListResourceGroupsParam.html" title="class in io.milvus.param.resourcegroup">ListResourceGroupsParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">List resource groups.</div>
- </td>
- </tr>
- <tr id="i58" class="altColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#loadBalance(io.milvus.param.control.LoadBalanceParam)">loadBalance</a></span>​(<a href="../param/control/LoadBalanceParam.html" title="class in io.milvus.param.control">LoadBalanceParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Moves segment from a query node to another to keep the load balanced.</div>
- </td>
- </tr>
- <tr id="i59" class="rowColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#loadCollection(io.milvus.param.collection.LoadCollectionParam)">loadCollection</a></span>​(<a href="../param/collection/LoadCollectionParam.html" title="class in io.milvus.param.collection">LoadCollectionParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Loads a collection to memory before search or query.</div>
- </td>
- </tr>
- <tr id="i60" class="altColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#loadPartitions(io.milvus.param.partition.LoadPartitionsParam)">loadPartitions</a></span>​(<a href="../param/partition/LoadPartitionsParam.html" title="class in io.milvus.param.partition">LoadPartitionsParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Loads a partition into memory.</div>
- </td>
- </tr>
- <tr id="i61" class="rowColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ManualCompactionResponse></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#manualCompact(io.milvus.param.control.ManualCompactParam)">manualCompact</a></span>​(<a href="../param/control/ManualCompactParam.html" title="class in io.milvus.param.control">ManualCompactParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Performs a manual compaction.</div>
- </td>
- </tr>
- <tr id="i62" class="altColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.QueryResults></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#query(io.milvus.param.dml.QueryParam)">query</a></span>​(<a href="../param/dml/QueryParam.html" title="class in io.milvus.param.dml">QueryParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Queries entity(s) based on scalar field(s) filtered by boolean expression.</div>
- </td>
- </tr>
- <tr id="i63" class="rowColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/highlevel/dml/response/QueryResponse.html" title="class in io.milvus.param.highlevel.dml.response">QueryResponse</a>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#query(io.milvus.param.highlevel.dml.QuerySimpleParam)">query</a></span>​(<a href="../param/highlevel/dml/QuerySimpleParam.html" title="class in io.milvus.param.highlevel.dml">QuerySimpleParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Queries entity(s) based on scalar field(s) filtered by boolean expression.</div>
- </td>
- </tr>
- <tr id="i64" class="altColor">
- <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<<a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.QueryResults>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#queryAsync(io.milvus.param.dml.QueryParam)">queryAsync</a></span>​(<a href="../param/dml/QueryParam.html" title="class in io.milvus.param.dml">QueryParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Queries entity(s) asynchronously based on scalar field(s) filtered by boolean expression.</div>
- </td>
- </tr>
- <tr id="i65" class="rowColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#releaseCollection(io.milvus.param.collection.ReleaseCollectionParam)">releaseCollection</a></span>​(<a href="../param/collection/ReleaseCollectionParam.html" title="class in io.milvus.param.collection">ReleaseCollectionParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Releases a collection from memory to reduce memory usage.</div>
- </td>
- </tr>
- <tr id="i66" class="altColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#releasePartitions(io.milvus.param.partition.ReleasePartitionsParam)">releasePartitions</a></span>​(<a href="../param/partition/ReleasePartitionsParam.html" title="class in io.milvus.param.partition">ReleasePartitionsParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Releases a partition from memory.</div>
- </td>
- </tr>
- <tr id="i67" class="rowColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeUserFromRole(io.milvus.param.role.RemoveUserFromRoleParam)">removeUserFromRole</a></span>​(<a href="../param/role/RemoveUserFromRoleParam.html" title="class in io.milvus.param.role">RemoveUserFromRoleParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">The user will remove permissions that the role are allowed to perform operations.</div>
- </td>
- </tr>
- <tr id="i68" class="altColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#renameCollection(io.milvus.param.collection.RenameCollectionParam)">renameCollection</a></span>​(<a href="../param/collection/RenameCollectionParam.html" title="class in io.milvus.param.collection">RenameCollectionParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">rename a collection</div>
- </td>
- </tr>
- <tr id="i69" class="rowColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#revokeRolePrivilege(io.milvus.param.role.RevokeRolePrivilegeParam)">revokeRolePrivilege</a></span>​(<a href="../param/role/RevokeRolePrivilegeParam.html" title="class in io.milvus.param.role">RevokeRolePrivilegeParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Revoke Role Privilege.</div>
- </td>
- </tr>
- <tr id="i70" class="altColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.SearchResults></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#search(io.milvus.param.dml.SearchParam)">search</a></span>​(<a href="../param/dml/SearchParam.html" title="class in io.milvus.param.dml">SearchParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Conducts ANN search on a vector field.</div>
- </td>
- </tr>
- <tr id="i71" class="rowColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/highlevel/dml/response/SearchResponse.html" title="class in io.milvus.param.highlevel.dml.response">SearchResponse</a>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#search(io.milvus.param.highlevel.dml.SearchSimpleParam)">search</a></span>​(<a href="../param/highlevel/dml/SearchSimpleParam.html" title="class in io.milvus.param.highlevel.dml">SearchSimpleParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Conducts ANN search on a vector field.</div>
- </td>
- </tr>
- <tr id="i72" class="altColor">
- <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<<a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.SearchResults>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#searchAsync(io.milvus.param.dml.SearchParam)">searchAsync</a></span>​(<a href="../param/dml/SearchParam.html" title="class in io.milvus.param.dml">SearchParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Conducts ANN search on a vector field asynchronously.</div>
- </td>
- </tr>
- <tr id="i73" class="rowColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.SelectGrantResponse></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#selectGrantForRole(io.milvus.param.role.SelectGrantForRoleParam)">selectGrantForRole</a></span>​(<a href="../param/role/SelectGrantForRoleParam.html" title="class in io.milvus.param.role">SelectGrantForRoleParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">List a grant info for the role and the specific object</div>
- </td>
- </tr>
- <tr id="i74" class="altColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.SelectGrantResponse></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#selectGrantForRoleAndObject(io.milvus.param.role.SelectGrantForRoleAndObjectParam)">selectGrantForRoleAndObject</a></span>​(<a href="../param/role/SelectGrantForRoleAndObjectParam.html" title="class in io.milvus.param.role">SelectGrantForRoleAndObjectParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">List a grant info for the role</div>
- </td>
- </tr>
- <tr id="i75" class="rowColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.SelectRoleResponse></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#selectRole(io.milvus.param.role.SelectRoleParam)">selectRole</a></span>​(<a href="../param/role/SelectRoleParam.html" title="class in io.milvus.param.role">SelectRoleParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Get all users who are added to the role.</div>
- </td>
- </tr>
- <tr id="i76" class="altColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.SelectUserResponse></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#selectUser(io.milvus.param.role.SelectUserParam)">selectUser</a></span>​(<a href="../param/role/SelectUserParam.html" title="class in io.milvus.param.role">SelectUserParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Get all roles the user has.</div>
- </td>
- </tr>
- <tr id="i77" class="rowColor">
- <td class="colFirst"><code>void</code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLogLevel(io.milvus.param.LogLevel)">setLogLevel</a></span>​(<a href="../param/LogLevel.html" title="enum in io.milvus.param">LogLevel</a> level)</code></th>
- <td class="colLast">
- <div class="block">Set log level in runtime.</div>
- </td>
- </tr>
- <tr id="i78" class="altColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ShowCollectionsResponse></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#showCollections(io.milvus.param.collection.ShowCollectionsParam)">showCollections</a></span>​(<a href="../param/collection/ShowCollectionsParam.html" title="class in io.milvus.param.collection">ShowCollectionsParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Lists all collections or gets collection loading status.</div>
- </td>
- </tr>
- <tr id="i79" class="rowColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ShowPartitionsResponse></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#showPartitions(io.milvus.param.partition.ShowPartitionsParam)">showPartitions</a></span>​(<a href="../param/partition/ShowPartitionsParam.html" title="class in io.milvus.param.partition">ShowPartitionsParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Shows all partitions in the specified collection.</div>
- </td>
- </tr>
- <tr id="i80" class="altColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#transferNode(io.milvus.param.resourcegroup.TransferNodeParam)">transferNode</a></span>​(<a href="../param/resourcegroup/TransferNodeParam.html" title="class in io.milvus.param.resourcegroup">TransferNodeParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Transfer a query node from source resource group to target resource_group.</div>
- </td>
- </tr>
- <tr id="i81" class="rowColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#transferReplica(io.milvus.param.resourcegroup.TransferReplicaParam)">transferReplica</a></span>​(<a href="../param/resourcegroup/TransferReplicaParam.html" title="class in io.milvus.param.resourcegroup">TransferReplicaParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Transfer a replica from source resource group to target resource_group.</div>
- </td>
- </tr>
- <tr id="i82" class="altColor">
- <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updateCredential(io.milvus.param.credential.UpdateCredentialParam)">updateCredential</a></span>​(<a href="../param/credential/UpdateCredentialParam.html" title="class in io.milvus.param.credential">UpdateCredentialParam</a> requestParam)</code></th>
- <td class="colLast">
- <div class="block">Update credential using the given user and password.</div>
- </td>
- </tr>
- <tr id="i83" class="rowColor">
- <td class="colFirst"><code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withRetry(int)">withRetry</a></span>​(int retryTimes)</code></th>
- <td class="colLast">
- <div class="block">Number of retry attempts.</div>
- </td>
- </tr>
- <tr id="i84" class="altColor">
- <td class="colFirst"><code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withRetryInterval(long,java.util.concurrent.TimeUnit)">withRetryInterval</a></span>​(long interval,
- java.util.concurrent.TimeUnit timeUnit)</code></th>
- <td class="colLast">
- <div class="block">Time interval between retry attempts.</div>
- </td>
- </tr>
- <tr id="i85" class="rowColor">
- <td class="colFirst"><code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></td>
- <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withTimeout(long,java.util.concurrent.TimeUnit)">withTimeout</a></span>​(long timeout,
- java.util.concurrent.TimeUnit timeoutUnit)</code></th>
- <td class="colLast">
- <div class="block">Timeout setting for rpc call.</div>
- </td>
- </tr>
- </table>
- <ul class="blockList">
- <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
- <!-- -->
- </a>
- <h3>Methods inherited from class java.lang.Object</h3>
- <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
- </ul>
- <ul class="blockList">
- <li class="blockList"><a id="methods.inherited.from.class.io.milvus.client.MilvusClient">
- <!-- -->
- </a>
- <h3>Methods inherited from interface io.milvus.client.<a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></h3>
- <code><a href="MilvusClient.html#close()">close</a></code></li>
- </ul>
- </li>
- </ul>
- </section>
- </li>
- </ul>
- </div>
- <div class="details">
- <ul class="blockList">
- <li class="blockList">
- <!-- ========= CONSTRUCTOR DETAIL ======== -->
- <section>
- <ul class="blockList">
- <li class="blockList"><a id="constructor.detail">
- <!-- -->
- </a>
- <h3>Constructor Detail</h3>
- <a id="<init>(io.milvus.param.MultiConnectParam)">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>MilvusMultiServiceClient</h4>
- <pre>public MilvusMultiServiceClient​(@NonNull
- @NonNull <a href="../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>
- </section>
- <!-- ============ METHOD DETAIL ========== -->
- <section>
- <ul class="blockList">
- <li class="blockList"><a id="method.detail">
- <!-- -->
- </a>
- <h3>Method Detail</h3>
- <a id="withTimeout(long,java.util.concurrent.TimeUnit)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>withTimeout</h4>
- <pre class="methodSignature">public <a href="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="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="MilvusClient.html#withTimeout(long,java.util.concurrent.TimeUnit)">withTimeout</a></code> in interface <code><a href="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>
- </dl>
- </li>
- </ul>
- <a id="withRetry(int)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>withRetry</h4>
- <pre class="methodSignature">public <a href="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="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="MilvusClient.html#withRetry(int)">withRetry</a></code> in interface <code><a href="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>
- </dl>
- </li>
- </ul>
- <a id="withRetryInterval(long,java.util.concurrent.TimeUnit)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>withRetryInterval</h4>
- <pre class="methodSignature">public <a href="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="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="MilvusClient.html#withRetryInterval(long,java.util.concurrent.TimeUnit)">withRetryInterval</a></code> in interface <code><a href="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>
- </dl>
- </li>
- </ul>
- <a id="close(long)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>close</h4>
- <pre class="methodSignature">public void close​(long maxWaitSeconds)
- throws java.lang.InterruptedException</pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="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="MilvusClient.html#close(long)">close</a></code> in interface <code><a href="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></dd>
- </dl>
- </li>
- </ul>
- <a id="setLogLevel(io.milvus.param.LogLevel)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>setLogLevel</h4>
- <pre class="methodSignature">public void setLogLevel​(<a href="../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="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="MilvusClient.html#setLogLevel(io.milvus.param.LogLevel)">setLogLevel</a></code> in interface <code><a href="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="../param/LogLevel.html" title="enum in io.milvus.param"><code>LogLevel</code></a></dd>
- </dl>
- </li>
- </ul>
- <a id="hasCollection(io.milvus.param.collection.HasCollectionParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>hasCollection</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><java.lang.Boolean> hasCollection​(<a href="../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="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="MilvusClient.html#hasCollection(io.milvus.param.collection.HasCollectionParam)">hasCollection</a></code> in interface <code><a href="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="../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 id="createDatabase(io.milvus.param.collection.CreateDatabaseParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>createDatabase</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> createDatabase​(<a href="../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="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="MilvusClient.html#createDatabase(io.milvus.param.collection.CreateDatabaseParam)">createDatabase</a></code> in interface <code><a href="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="../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 id="dropDatabase(io.milvus.param.collection.DropDatabaseParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>dropDatabase</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> dropDatabase​(<a href="../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="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="MilvusClient.html#dropDatabase(io.milvus.param.collection.DropDatabaseParam)">dropDatabase</a></code> in interface <code><a href="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="../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 id="listDatabases()">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>listDatabases</h4>
- <pre class="methodSignature">public <a href="../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="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="MilvusClient.html#listDatabases()">listDatabases</a></code> in interface <code><a href="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 id="createCollection(io.milvus.param.collection.CreateCollectionParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>createCollection</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> createCollection​(<a href="../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="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="MilvusClient.html#createCollection(io.milvus.param.collection.CreateCollectionParam)">createCollection</a></code> in interface <code><a href="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="../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 id="dropCollection(io.milvus.param.collection.DropCollectionParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>dropCollection</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> dropCollection​(<a href="../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="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="MilvusClient.html#dropCollection(io.milvus.param.collection.DropCollectionParam)">dropCollection</a></code> in interface <code><a href="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="../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 id="loadCollection(io.milvus.param.collection.LoadCollectionParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>loadCollection</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> loadCollection​(<a href="../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="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="MilvusClient.html#loadCollection(io.milvus.param.collection.LoadCollectionParam)">loadCollection</a></code> in interface <code><a href="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="../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 id="releaseCollection(io.milvus.param.collection.ReleaseCollectionParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>releaseCollection</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> releaseCollection​(<a href="../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="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="MilvusClient.html#releaseCollection(io.milvus.param.collection.ReleaseCollectionParam)">releaseCollection</a></code> in interface <code><a href="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="../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 id="renameCollection(io.milvus.param.collection.RenameCollectionParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>renameCollection</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> renameCollection​(<a href="../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="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="MilvusClient.html#renameCollection(io.milvus.param.collection.RenameCollectionParam)">renameCollection</a></code> in interface <code><a href="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="../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 id="describeCollection(io.milvus.param.collection.DescribeCollectionParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>describeCollection</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.DescribeCollectionResponse> describeCollection​(<a href="../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="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="MilvusClient.html#describeCollection(io.milvus.param.collection.DescribeCollectionParam)">describeCollection</a></code> in interface <code><a href="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="../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 id="getCollectionStatistics(io.milvus.param.collection.GetCollectionStatisticsParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getCollectionStatistics</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetCollectionStatisticsResponse> getCollectionStatistics​(<a href="../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="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="MilvusClient.html#getCollectionStatistics(io.milvus.param.collection.GetCollectionStatisticsParam)">getCollectionStatistics</a></code> in interface <code><a href="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="../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 id="showCollections(io.milvus.param.collection.ShowCollectionsParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>showCollections</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ShowCollectionsResponse> showCollections​(<a href="../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="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="MilvusClient.html#showCollections(io.milvus.param.collection.ShowCollectionsParam)">showCollections</a></code> in interface <code><a href="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="../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 id="alterCollection(io.milvus.param.collection.AlterCollectionParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>alterCollection</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> alterCollection​(<a href="../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="MilvusClient.html#alterCollection(io.milvus.param.collection.AlterCollectionParam)">MilvusClient</a></code></span></div>
- <div class="block">Alter collection.
- Currently, only support setting collection TTL with key `collection.ttl.seconds`</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="MilvusClient.html#alterCollection(io.milvus.param.collection.AlterCollectionParam)">alterCollection</a></code> in interface <code><a href="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="../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 id="flush(io.milvus.param.collection.FlushParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>flush</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.FlushResponse> flush​(<a href="../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="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="MilvusClient.html#flush(io.milvus.param.collection.FlushParam)">flush</a></code> in interface <code><a href="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="../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 id="flushAll(boolean,long,long)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>flushAll</h4>
- <pre class="methodSignature">public <a href="../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="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="MilvusClient.html#flushAll(boolean,long,long)">flushAll</a></code> in interface <code><a href="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 id="createPartition(io.milvus.param.partition.CreatePartitionParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>createPartition</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> createPartition​(<a href="../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="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="MilvusClient.html#createPartition(io.milvus.param.partition.CreatePartitionParam)">createPartition</a></code> in interface <code><a href="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="../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 id="dropPartition(io.milvus.param.partition.DropPartitionParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>dropPartition</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> dropPartition​(<a href="../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="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="MilvusClient.html#dropPartition(io.milvus.param.partition.DropPartitionParam)">dropPartition</a></code> in interface <code><a href="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="../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 id="hasPartition(io.milvus.param.partition.HasPartitionParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>hasPartition</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><java.lang.Boolean> hasPartition​(<a href="../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="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="MilvusClient.html#hasPartition(io.milvus.param.partition.HasPartitionParam)">hasPartition</a></code> in interface <code><a href="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="../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 id="loadPartitions(io.milvus.param.partition.LoadPartitionsParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>loadPartitions</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> loadPartitions​(<a href="../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="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="MilvusClient.html#loadPartitions(io.milvus.param.partition.LoadPartitionsParam)">loadPartitions</a></code> in interface <code><a href="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="../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 id="releasePartitions(io.milvus.param.partition.ReleasePartitionsParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>releasePartitions</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> releasePartitions​(<a href="../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="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="MilvusClient.html#releasePartitions(io.milvus.param.partition.ReleasePartitionsParam)">releasePartitions</a></code> in interface <code><a href="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="../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 id="getPartitionStatistics(io.milvus.param.partition.GetPartitionStatisticsParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getPartitionStatistics</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetPartitionStatisticsResponse> getPartitionStatistics​(<a href="../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="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="MilvusClient.html#getPartitionStatistics(io.milvus.param.partition.GetPartitionStatisticsParam)">getPartitionStatistics</a></code> in interface <code><a href="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="../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 id="showPartitions(io.milvus.param.partition.ShowPartitionsParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>showPartitions</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ShowPartitionsResponse> showPartitions​(<a href="../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="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="MilvusClient.html#showPartitions(io.milvus.param.partition.ShowPartitionsParam)">showPartitions</a></code> in interface <code><a href="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="../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 id="createAlias(io.milvus.param.alias.CreateAliasParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>createAlias</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> createAlias​(<a href="../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="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="MilvusClient.html#createAlias(io.milvus.param.alias.CreateAliasParam)">createAlias</a></code> in interface <code><a href="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="../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 id="dropAlias(io.milvus.param.alias.DropAliasParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>dropAlias</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> dropAlias​(<a href="../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="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="MilvusClient.html#dropAlias(io.milvus.param.alias.DropAliasParam)">dropAlias</a></code> in interface <code><a href="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="../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 id="alterAlias(io.milvus.param.alias.AlterAliasParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>alterAlias</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> alterAlias​(<a href="../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="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="MilvusClient.html#alterAlias(io.milvus.param.alias.AlterAliasParam)">alterAlias</a></code> in interface <code><a href="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="../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 id="createIndex(io.milvus.param.index.CreateIndexParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>createIndex</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> createIndex​(<a href="../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="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="MilvusClient.html#createIndex(io.milvus.param.index.CreateIndexParam)">createIndex</a></code> in interface <code><a href="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="../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 id="dropIndex(io.milvus.param.index.DropIndexParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>dropIndex</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> dropIndex​(<a href="../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="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="MilvusClient.html#dropIndex(io.milvus.param.index.DropIndexParam)">dropIndex</a></code> in interface <code><a href="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="../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 id="describeIndex(io.milvus.param.index.DescribeIndexParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>describeIndex</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.DescribeIndexResponse> describeIndex​(<a href="../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="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="MilvusClient.html#describeIndex(io.milvus.param.index.DescribeIndexParam)">describeIndex</a></code> in interface <code><a href="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="../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 id="getIndexState(io.milvus.param.index.GetIndexStateParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getIndexState</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetIndexStateResponse> getIndexState​(<a href="../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="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="MilvusClient.html#getIndexState(io.milvus.param.index.GetIndexStateParam)">getIndexState</a></code> in interface <code><a href="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="../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 id="getIndexBuildProgress(io.milvus.param.index.GetIndexBuildProgressParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getIndexBuildProgress</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetIndexBuildProgressResponse> getIndexBuildProgress​(<a href="../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="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="MilvusClient.html#getIndexBuildProgress(io.milvus.param.index.GetIndexBuildProgressParam)">getIndexBuildProgress</a></code> in interface <code><a href="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="../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 id="insert(io.milvus.param.dml.InsertParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>insert</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.MutationResult> insert​(<a href="../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="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="MilvusClient.html#insert(io.milvus.param.dml.InsertParam)">insert</a></code> in interface <code><a href="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="../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 id="insertAsync(io.milvus.param.dml.InsertParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>insertAsync</h4>
- <pre class="methodSignature">public com.google.common.util.concurrent.ListenableFuture<<a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.MutationResult>> insertAsync​(<a href="../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="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="MilvusClient.html#insertAsync(io.milvus.param.dml.InsertParam)">insertAsync</a></code> in interface <code><a href="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="../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 id="delete(io.milvus.param.dml.DeleteParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>delete</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.MutationResult> delete​(<a href="../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="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="MilvusClient.html#delete(io.milvus.param.dml.DeleteParam)">delete</a></code> in interface <code><a href="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="../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 id="search(io.milvus.param.dml.SearchParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>search</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.SearchResults> search​(<a href="../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="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="MilvusClient.html#search(io.milvus.param.dml.SearchParam)">search</a></code> in interface <code><a href="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="../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 id="searchAsync(io.milvus.param.dml.SearchParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>searchAsync</h4>
- <pre class="methodSignature">public com.google.common.util.concurrent.ListenableFuture<<a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.SearchResults>> searchAsync​(<a href="../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="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="MilvusClient.html#searchAsync(io.milvus.param.dml.SearchParam)">searchAsync</a></code> in interface <code><a href="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="../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 id="query(io.milvus.param.dml.QueryParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>query</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.QueryResults> query​(<a href="../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="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="MilvusClient.html#query(io.milvus.param.dml.QueryParam)">query</a></code> in interface <code><a href="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="../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 id="queryAsync(io.milvus.param.dml.QueryParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>queryAsync</h4>
- <pre class="methodSignature">public com.google.common.util.concurrent.ListenableFuture<<a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.QueryResults>> queryAsync​(<a href="../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="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="MilvusClient.html#queryAsync(io.milvus.param.dml.QueryParam)">queryAsync</a></code> in interface <code><a href="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="../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 id="getMetrics(io.milvus.param.control.GetMetricsParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getMetrics</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetMetricsResponse> getMetrics​(<a href="../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="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="MilvusClient.html#getMetrics(io.milvus.param.control.GetMetricsParam)">getMetrics</a></code> in interface <code><a href="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="../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 id="getFlushState(io.milvus.param.control.GetFlushStateParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getFlushState</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetFlushStateResponse> getFlushState​(<a href="../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="MilvusClient.html#getFlushState(io.milvus.param.control.GetFlushStateParam)">MilvusClient</a></code></span></div>
- <div class="block">Get flush state of specified segments.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="MilvusClient.html#getFlushState(io.milvus.param.control.GetFlushStateParam)">getFlushState</a></code> in interface <code><a href="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="../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 id="getFlushAllState(io.milvus.param.control.GetFlushAllStateParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getFlushAllState</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetFlushAllStateResponse> getFlushAllState​(<a href="../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="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="MilvusClient.html#getFlushAllState(io.milvus.param.control.GetFlushAllStateParam)">getFlushAllState</a></code> in interface <code><a href="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="../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 id="getPersistentSegmentInfo(io.milvus.param.control.GetPersistentSegmentInfoParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getPersistentSegmentInfo</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetPersistentSegmentInfoResponse> getPersistentSegmentInfo​(<a href="../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="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="MilvusClient.html#getPersistentSegmentInfo(io.milvus.param.control.GetPersistentSegmentInfoParam)">getPersistentSegmentInfo</a></code> in interface <code><a href="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="../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 id="getQuerySegmentInfo(io.milvus.param.control.GetQuerySegmentInfoParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getQuerySegmentInfo</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetQuerySegmentInfoResponse> getQuerySegmentInfo​(<a href="../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="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="MilvusClient.html#getQuerySegmentInfo(io.milvus.param.control.GetQuerySegmentInfoParam)">getQuerySegmentInfo</a></code> in interface <code><a href="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="../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 id="getReplicas(io.milvus.param.control.GetReplicasParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getReplicas</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetReplicasResponse> getReplicas​(<a href="../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="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="MilvusClient.html#getReplicas(io.milvus.param.control.GetReplicasParam)">getReplicas</a></code> in interface <code><a href="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="../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 id="loadBalance(io.milvus.param.control.LoadBalanceParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>loadBalance</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> loadBalance​(<a href="../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="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="MilvusClient.html#loadBalance(io.milvus.param.control.LoadBalanceParam)">loadBalance</a></code> in interface <code><a href="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="../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 id="getCompactionState(io.milvus.param.control.GetCompactionStateParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getCompactionState</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetCompactionStateResponse> getCompactionState​(<a href="../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="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="MilvusClient.html#getCompactionState(io.milvus.param.control.GetCompactionStateParam)">getCompactionState</a></code> in interface <code><a href="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="../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 id="manualCompact(io.milvus.param.control.ManualCompactParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>manualCompact</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ManualCompactionResponse> manualCompact​(<a href="../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="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="MilvusClient.html#manualCompact(io.milvus.param.control.ManualCompactParam)">manualCompact</a></code> in interface <code><a href="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="../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 id="getCompactionStateWithPlans(io.milvus.param.control.GetCompactionPlansParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getCompactionStateWithPlans</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetCompactionPlansResponse> getCompactionStateWithPlans​(<a href="../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="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="MilvusClient.html#getCompactionStateWithPlans(io.milvus.param.control.GetCompactionPlansParam)">getCompactionStateWithPlans</a></code> in interface <code><a href="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="../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 id="createCredential(io.milvus.param.credential.CreateCredentialParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>createCredential</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> createCredential​(<a href="../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="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="MilvusClient.html#createCredential(io.milvus.param.credential.CreateCredentialParam)">createCredential</a></code> in interface <code><a href="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="../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 id="updateCredential(io.milvus.param.credential.UpdateCredentialParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>updateCredential</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> updateCredential​(<a href="../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="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="MilvusClient.html#updateCredential(io.milvus.param.credential.UpdateCredentialParam)">updateCredential</a></code> in interface <code><a href="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="../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 id="deleteCredential(io.milvus.param.credential.DeleteCredentialParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>deleteCredential</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> deleteCredential​(<a href="../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="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="MilvusClient.html#deleteCredential(io.milvus.param.credential.DeleteCredentialParam)">deleteCredential</a></code> in interface <code><a href="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="../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 id="listCredUsers(io.milvus.param.credential.ListCredUsersParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>listCredUsers</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ListCredUsersResponse> listCredUsers​(<a href="../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="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="MilvusClient.html#listCredUsers(io.milvus.param.credential.ListCredUsersParam)">listCredUsers</a></code> in interface <code><a href="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="../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 id="createRole(io.milvus.param.role.CreateRoleParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>createRole</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> createRole​(<a href="../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="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="MilvusClient.html#createRole(io.milvus.param.role.CreateRoleParam)">createRole</a></code> in interface <code><a href="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="../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 id="dropRole(io.milvus.param.role.DropRoleParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>dropRole</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> dropRole​(<a href="../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="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="MilvusClient.html#dropRole(io.milvus.param.role.DropRoleParam)">dropRole</a></code> in interface <code><a href="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="../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 id="addUserToRole(io.milvus.param.role.AddUserToRoleParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>addUserToRole</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> addUserToRole​(<a href="../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="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="MilvusClient.html#addUserToRole(io.milvus.param.role.AddUserToRoleParam)">addUserToRole</a></code> in interface <code><a href="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="../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 id="removeUserFromRole(io.milvus.param.role.RemoveUserFromRoleParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>removeUserFromRole</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> removeUserFromRole​(<a href="../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="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="MilvusClient.html#removeUserFromRole(io.milvus.param.role.RemoveUserFromRoleParam)">removeUserFromRole</a></code> in interface <code><a href="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="../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 id="selectRole(io.milvus.param.role.SelectRoleParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>selectRole</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.SelectRoleResponse> selectRole​(<a href="../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="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="MilvusClient.html#selectRole(io.milvus.param.role.SelectRoleParam)">selectRole</a></code> in interface <code><a href="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="../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 id="selectUser(io.milvus.param.role.SelectUserParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>selectUser</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.SelectUserResponse> selectUser​(<a href="../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="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="MilvusClient.html#selectUser(io.milvus.param.role.SelectUserParam)">selectUser</a></code> in interface <code><a href="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="../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 id="grantRolePrivilege(io.milvus.param.role.GrantRolePrivilegeParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>grantRolePrivilege</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> grantRolePrivilege​(<a href="../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="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="MilvusClient.html#grantRolePrivilege(io.milvus.param.role.GrantRolePrivilegeParam)">grantRolePrivilege</a></code> in interface <code><a href="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="../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 id="revokeRolePrivilege(io.milvus.param.role.RevokeRolePrivilegeParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>revokeRolePrivilege</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> revokeRolePrivilege​(<a href="../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="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="MilvusClient.html#revokeRolePrivilege(io.milvus.param.role.RevokeRolePrivilegeParam)">revokeRolePrivilege</a></code> in interface <code><a href="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="../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 id="selectGrantForRole(io.milvus.param.role.SelectGrantForRoleParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>selectGrantForRole</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.SelectGrantResponse> selectGrantForRole​(<a href="../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="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="MilvusClient.html#selectGrantForRole(io.milvus.param.role.SelectGrantForRoleParam)">selectGrantForRole</a></code> in interface <code><a href="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="../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 id="selectGrantForRoleAndObject(io.milvus.param.role.SelectGrantForRoleAndObjectParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>selectGrantForRoleAndObject</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.SelectGrantResponse> selectGrantForRoleAndObject​(<a href="../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="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="MilvusClient.html#selectGrantForRoleAndObject(io.milvus.param.role.SelectGrantForRoleAndObjectParam)">selectGrantForRoleAndObject</a></code> in interface <code><a href="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="../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 id="bulkInsert(io.milvus.param.bulkinsert.BulkInsertParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>bulkInsert</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ImportResponse> bulkInsert​(<a href="../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="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="MilvusClient.html#bulkInsert(io.milvus.param.bulkinsert.BulkInsertParam)">bulkInsert</a></code> in interface <code><a href="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="../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 id="getBulkInsertState(io.milvus.param.bulkinsert.GetBulkInsertStateParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getBulkInsertState</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetImportStateResponse> getBulkInsertState​(<a href="../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="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="MilvusClient.html#getBulkInsertState(io.milvus.param.bulkinsert.GetBulkInsertStateParam)">getBulkInsertState</a></code> in interface <code><a href="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="../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 id="listBulkInsertTasks(io.milvus.param.bulkinsert.ListBulkInsertTasksParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>listBulkInsertTasks</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ListImportTasksResponse> listBulkInsertTasks​(<a href="../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="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="MilvusClient.html#listBulkInsertTasks(io.milvus.param.bulkinsert.ListBulkInsertTasksParam)">listBulkInsertTasks</a></code> in interface <code><a href="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="../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 id="checkHealth()">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>checkHealth</h4>
- <pre class="methodSignature">public <a href="../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="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="MilvusClient.html#checkHealth()">checkHealth</a></code> in interface <code><a href="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 id="getVersion()">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getVersion</h4>
- <pre class="methodSignature">public <a href="../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="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="MilvusClient.html#getVersion()">getVersion</a></code> in interface <code><a href="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 id="getLoadingProgress(io.milvus.param.collection.GetLoadingProgressParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getLoadingProgress</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetLoadingProgressResponse> getLoadingProgress​(<a href="../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="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="MilvusClient.html#getLoadingProgress(io.milvus.param.collection.GetLoadingProgressParam)">getLoadingProgress</a></code> in interface <code><a href="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="../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 id="getLoadState(io.milvus.param.collection.GetLoadStateParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getLoadState</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetLoadStateResponse> getLoadState​(<a href="../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="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="MilvusClient.html#getLoadState(io.milvus.param.collection.GetLoadStateParam)">getLoadState</a></code> in interface <code><a href="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="../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 id="createResourceGroup(io.milvus.param.resourcegroup.CreateResourceGroupParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>createResourceGroup</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> createResourceGroup​(<a href="../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="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="MilvusClient.html#createResourceGroup(io.milvus.param.resourcegroup.CreateResourceGroupParam)">createResourceGroup</a></code> in interface <code><a href="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="../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 id="dropResourceGroup(io.milvus.param.resourcegroup.DropResourceGroupParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>dropResourceGroup</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> dropResourceGroup​(<a href="../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="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="MilvusClient.html#dropResourceGroup(io.milvus.param.resourcegroup.DropResourceGroupParam)">dropResourceGroup</a></code> in interface <code><a href="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="../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 id="listResourceGroups(io.milvus.param.resourcegroup.ListResourceGroupsParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>listResourceGroups</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ListResourceGroupsResponse> listResourceGroups​(<a href="../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="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="MilvusClient.html#listResourceGroups(io.milvus.param.resourcegroup.ListResourceGroupsParam)">listResourceGroups</a></code> in interface <code><a href="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="../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 id="describeResourceGroup(io.milvus.param.resourcegroup.DescribeResourceGroupParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>describeResourceGroup</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.DescribeResourceGroupResponse> describeResourceGroup​(<a href="../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="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="MilvusClient.html#describeResourceGroup(io.milvus.param.resourcegroup.DescribeResourceGroupParam)">describeResourceGroup</a></code> in interface <code><a href="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="../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 id="transferNode(io.milvus.param.resourcegroup.TransferNodeParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>transferNode</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> transferNode​(<a href="../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="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="MilvusClient.html#transferNode(io.milvus.param.resourcegroup.TransferNodeParam)">transferNode</a></code> in interface <code><a href="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="../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 id="transferReplica(io.milvus.param.resourcegroup.TransferReplicaParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>transferReplica</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> transferReplica​(<a href="../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="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="MilvusClient.html#transferReplica(io.milvus.param.resourcegroup.TransferReplicaParam)">transferReplica</a></code> in interface <code><a href="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="../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 id="createCollection(io.milvus.param.highlevel.collection.CreateSimpleCollectionParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>createCollection</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> createCollection​(<a href="../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="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="MilvusClient.html#createCollection(io.milvus.param.highlevel.collection.CreateSimpleCollectionParam)">createCollection</a></code> in interface <code><a href="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="../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 id="listCollections(io.milvus.param.highlevel.collection.ListCollectionsParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>listCollections</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/highlevel/collection/response/ListCollectionsResponse.html" title="class in io.milvus.param.highlevel.collection.response">ListCollectionsResponse</a>> listCollections​(<a href="../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="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="MilvusClient.html#listCollections(io.milvus.param.highlevel.collection.ListCollectionsParam)">listCollections</a></code> in interface <code><a href="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="../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 id="insert(io.milvus.param.highlevel.dml.InsertRowsParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>insert</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/highlevel/dml/response/InsertResponse.html" title="class in io.milvus.param.highlevel.dml.response">InsertResponse</a>> insert​(<a href="../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="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="MilvusClient.html#insert(io.milvus.param.highlevel.dml.InsertRowsParam)">insert</a></code> in interface <code><a href="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="../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 id="delete(io.milvus.param.highlevel.dml.DeleteIdsParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>delete</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/highlevel/dml/response/DeleteResponse.html" title="class in io.milvus.param.highlevel.dml.response">DeleteResponse</a>> delete​(<a href="../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="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="MilvusClient.html#delete(io.milvus.param.highlevel.dml.DeleteIdsParam)">delete</a></code> in interface <code><a href="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="../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 id="get(io.milvus.param.highlevel.dml.GetIdsParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>get</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/highlevel/dml/response/GetResponse.html" title="class in io.milvus.param.highlevel.dml.response">GetResponse</a>> get​(<a href="../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="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="MilvusClient.html#get(io.milvus.param.highlevel.dml.GetIdsParam)">get</a></code> in interface <code><a href="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="../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 id="query(io.milvus.param.highlevel.dml.QuerySimpleParam)">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>query</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/highlevel/dml/response/QueryResponse.html" title="class in io.milvus.param.highlevel.dml.response">QueryResponse</a>> query​(<a href="../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="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="MilvusClient.html#query(io.milvus.param.highlevel.dml.QuerySimpleParam)">query</a></code> in interface <code><a href="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="../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 id="search(io.milvus.param.highlevel.dml.SearchSimpleParam)">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>search</h4>
- <pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/highlevel/dml/response/SearchResponse.html" title="class in io.milvus.param.highlevel.dml.response">SearchResponse</a>> search​(<a href="../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="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="MilvusClient.html#search(io.milvus.param.highlevel.dml.SearchSimpleParam)">search</a></code> in interface <code><a href="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="../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>
- </li>
- </ul>
- </section>
- </li>
- </ul>
- </div>
- </div>
- </main>
- <!-- ========= END OF CLASS DATA ========= -->
- <footer role="contentinfo">
- <nav role="navigation">
- <!-- ======= START OF BOTTOM NAVBAR ====== -->
- <div class="bottomNav"><a id="navbar.bottom">
- <!-- -->
- </a>
- <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
- <a id="navbar.bottom.firstrow">
- <!-- -->
- </a>
- <ul class="navList" title="Navigation">
- <li><a href="../../../index.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" id="allclasses_navbar_bottom">
- <li><a href="../../../allclasses.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>
- <noscript>
- <div>JavaScript is disabled on your browser.</div>
- </noscript>
- </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 id="skip.navbar.bottom">
- <!-- -->
- </a></div>
- <!-- ======== END OF BOTTOM NAVBAR ======= -->
- </nav>
- </footer>
- </body>
- </html>
|