index-7.html 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466
  1. <!DOCTYPE HTML>
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (11.0.13) on Thu Jan 27 13:56:42 CST 2022 -->
  6. <title>G-Index</title>
  7. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  8. <meta name="dc.created" content="2022-01-27">
  9. <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
  10. <link rel="stylesheet" type="text/css" href="../jquery/jquery-ui.css" title="Style">
  11. <script type="text/javascript" src="../script.js"></script>
  12. <script type="text/javascript" src="../jquery/jszip/dist/jszip.min.js"></script>
  13. <script type="text/javascript" src="../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
  14. <!--[if IE]>
  15. <script type="text/javascript" src="../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
  16. <![endif]-->
  17. <script type="text/javascript" src="../jquery/jquery-3.5.1.js"></script>
  18. <script type="text/javascript" src="../jquery/jquery-ui.js"></script>
  19. </head>
  20. <body>
  21. <script type="text/javascript"><!--
  22. try {
  23. if (location.href.indexOf('is-external=true') == -1) {
  24. parent.document.title="G-Index";
  25. }
  26. }
  27. catch(err) {
  28. }
  29. //-->
  30. var pathtoroot = "../";
  31. var useModuleDirectories = true;
  32. loadScripts(document, 'script');</script>
  33. <noscript>
  34. <div>JavaScript is disabled on your browser.</div>
  35. </noscript>
  36. <header role="banner">
  37. <nav role="navigation">
  38. <div class="fixedNav">
  39. <!-- ========= START OF TOP NAVBAR ======= -->
  40. <div class="topNav"><a id="navbar.top">
  41. <!-- -->
  42. </a>
  43. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  44. <a id="navbar.top.firstrow">
  45. <!-- -->
  46. </a>
  47. <ul class="navList" title="Navigation">
  48. <li><a href="../index.html">Overview</a></li>
  49. <li>Package</li>
  50. <li>Class</li>
  51. <li><a href="../overview-tree.html">Tree</a></li>
  52. <li><a href="../deprecated-list.html">Deprecated</a></li>
  53. <li class="navBarCell1Rev">Index</li>
  54. <li><a href="../help-doc.html">Help</a></li>
  55. </ul>
  56. </div>
  57. <div class="subNav">
  58. <ul class="navList" id="allclasses_navbar_top">
  59. <li><a href="../allclasses.html">All&nbsp;Classes</a></li>
  60. </ul>
  61. <ul class="navListSearch">
  62. <li><label for="search">SEARCH:</label>
  63. <input type="text" id="search" value="search" disabled="disabled">
  64. <input type="reset" id="reset" value="reset" disabled="disabled">
  65. </li>
  66. </ul>
  67. <div>
  68. <script type="text/javascript"><!--
  69. allClassesLink = document.getElementById("allclasses_navbar_top");
  70. if(window==top) {
  71. allClassesLink.style.display = "block";
  72. }
  73. else {
  74. allClassesLink.style.display = "none";
  75. }
  76. //-->
  77. </script>
  78. <noscript>
  79. <div>JavaScript is disabled on your browser.</div>
  80. </noscript>
  81. </div>
  82. <a id="skip.navbar.top">
  83. <!-- -->
  84. </a></div>
  85. <!-- ========= END OF TOP NAVBAR ========= -->
  86. </div>
  87. <div class="navPadding">&nbsp;</div>
  88. <script type="text/javascript"><!--
  89. $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
  90. //-->
  91. </script>
  92. </nav>
  93. </header>
  94. <main role="main">
  95. <div class="contentContainer"><a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">J</a>&nbsp;<a href="index-11.html">K</a>&nbsp;<a href="index-12.html">L</a>&nbsp;<a href="index-13.html">M</a>&nbsp;<a href="index-14.html">N</a>&nbsp;<a href="index-15.html">O</a>&nbsp;<a href="index-16.html">P</a>&nbsp;<a href="index-17.html">Q</a>&nbsp;<a href="index-18.html">R</a>&nbsp;<a href="index-19.html">S</a>&nbsp;<a href="index-20.html">T</a>&nbsp;<a href="index-21.html">U</a>&nbsp;<a href="index-22.html">V</a>&nbsp;<a href="index-23.html">W</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes</a>&nbsp;<a href="../allpackages-index.html">All&nbsp;Packages</a><a id="I:G">
  96. <!-- -->
  97. </a>
  98. <h2 class="title">G</h2>
  99. <dl>
  100. <dt><span class="memberNameLink"><a href="../io/milvus/response/DescCollResponseWrapper.html#getAliases()">getAliases()</a></span> - Method in class io.milvus.response.<a href="../io/milvus/response/DescCollResponseWrapper.html" title="class in io.milvus.response">DescCollResponseWrapper</a></dt>
  101. <dd>
  102. <div class="block">Get aliases of the collection.</div>
  103. </dd>
  104. <dt><span class="memberNameLink"><a href="../io/milvus/param/R.Status.html#getCode()">getCode()</a></span> - Method in enum io.milvus.param.<a href="../io/milvus/param/R.Status.html" title="enum in io.milvus.param">R.Status</a></dt>
  105. <dd>&nbsp;</dd>
  106. <dt><span class="memberNameLink"><a href="../io/milvus/response/DescCollResponseWrapper.html#getCollectionDescription()">getCollectionDescription()</a></span> - Method in class io.milvus.response.<a href="../io/milvus/response/DescCollResponseWrapper.html" title="class in io.milvus.response">DescCollResponseWrapper</a></dt>
  107. <dd>
  108. <div class="block">Get description of the collection.</div>
  109. </dd>
  110. <dt><span class="memberNameLink"><a href="../io/milvus/response/DescCollResponseWrapper.html#getCollectionID()">getCollectionID()</a></span> - Method in class io.milvus.response.<a href="../io/milvus/response/DescCollResponseWrapper.html" title="class in io.milvus.response">DescCollResponseWrapper</a></dt>
  111. <dd>
  112. <div class="block">Get internal id of the collection.</div>
  113. </dd>
  114. <dt><span class="memberNameLink"><a href="../io/milvus/response/ShowCollResponseWrapper.html#getCollectionInfoByName(java.lang.String)">getCollectionInfoByName(String)</a></span> - Method in class io.milvus.response.<a href="../io/milvus/response/ShowCollResponseWrapper.html" title="class in io.milvus.response">ShowCollResponseWrapper</a></dt>
  115. <dd>
  116. <div class="block">Get information of one collection by name.</div>
  117. </dd>
  118. <dt><span class="memberNameLink"><a href="../io/milvus/response/DescCollResponseWrapper.html#getCollectionName()">getCollectionName()</a></span> - Method in class io.milvus.response.<a href="../io/milvus/response/DescCollResponseWrapper.html" title="class in io.milvus.response">DescCollResponseWrapper</a></dt>
  119. <dd>
  120. <div class="block">Get name of the collection.</div>
  121. </dd>
  122. <dt><span class="memberNameLink"><a href="../io/milvus/response/ShowCollResponseWrapper.html#getCollectionsInfo()">getCollectionsInfo()</a></span> - Method in class io.milvus.response.<a href="../io/milvus/response/ShowCollResponseWrapper.html" title="class in io.milvus.response">ShowCollResponseWrapper</a></dt>
  123. <dd>
  124. <div class="block">Get information of the collections.</div>
  125. </dd>
  126. <dt><span class="memberNameLink"><a href="../io/milvus/client/AbstractMilvusGrpcClient.html#getCollectionStatistics(io.milvus.param.collection.GetCollectionStatisticsParam)">getCollectionStatistics(GetCollectionStatisticsParam)</a></span> - Method in class io.milvus.client.<a href="../io/milvus/client/AbstractMilvusGrpcClient.html" title="class in io.milvus.client">AbstractMilvusGrpcClient</a></dt>
  127. <dd>&nbsp;</dd>
  128. <dt><span class="memberNameLink"><a href="../io/milvus/client/MilvusClient.html#getCollectionStatistics(io.milvus.param.collection.GetCollectionStatisticsParam)">getCollectionStatistics(GetCollectionStatisticsParam)</a></span> - Method in interface io.milvus.client.<a href="../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></dt>
  129. <dd>
  130. <div class="block">Shows the statistics information of a collection.</div>
  131. </dd>
  132. <dt><a href="../io/milvus/param/collection/GetCollectionStatisticsParam.html" title="class in io.milvus.param.collection"><span class="typeNameLink">GetCollectionStatisticsParam</span></a> - Class in <a href="../io/milvus/param/collection/package-summary.html">io.milvus.param.collection</a></dt>
  133. <dd>
  134. <div class="block">Parameters for <code>getCollectionStatistics</code> interface.</div>
  135. </dd>
  136. <dt><a href="../io/milvus/param/collection/GetCollectionStatisticsParam.Builder.html" title="class in io.milvus.param.collection"><span class="typeNameLink">GetCollectionStatisticsParam.Builder</span></a> - Class in <a href="../io/milvus/param/collection/package-summary.html">io.milvus.param.collection</a></dt>
  137. <dd>
  138. <div class="block">Builder for <code>GetCollectionStatisticsParam</code> class.</div>
  139. </dd>
  140. <dt><a href="../io/milvus/response/GetCollStatResponseWrapper.html" title="class in io.milvus.response"><span class="typeNameLink">GetCollStatResponseWrapper</span></a> - Class in <a href="../io/milvus/response/package-summary.html">io.milvus.response</a></dt>
  141. <dd>
  142. <div class="block">Utility class to wrap response of <code>getCollectionStatistics</code> interface.</div>
  143. </dd>
  144. <dt><span class="memberNameLink"><a href="../io/milvus/response/GetCollStatResponseWrapper.html#%3Cinit%3E(io.milvus.grpc.GetCollectionStatisticsResponse)">GetCollStatResponseWrapper(GetCollectionStatisticsResponse)</a></span> - Constructor for class io.milvus.response.<a href="../io/milvus/response/GetCollStatResponseWrapper.html" title="class in io.milvus.response">GetCollStatResponseWrapper</a></dt>
  145. <dd>&nbsp;</dd>
  146. <dt><a href="../io/milvus/param/control/GetCompactionPlansParam.html" title="class in io.milvus.param.control"><span class="typeNameLink">GetCompactionPlansParam</span></a> - Class in <a href="../io/milvus/param/control/package-summary.html">io.milvus.param.control</a></dt>
  147. <dd>
  148. <div class="block">Parameters for <code>getCompactionStateWithPlans</code> interface.</div>
  149. </dd>
  150. <dt><a href="../io/milvus/param/control/GetCompactionPlansParam.Builder.html" title="class in io.milvus.param.control"><span class="typeNameLink">GetCompactionPlansParam.Builder</span></a> - Class in <a href="../io/milvus/param/control/package-summary.html">io.milvus.param.control</a></dt>
  151. <dd>
  152. <div class="block">Builder for <code>GetCompactionPlansParam</code> class.</div>
  153. </dd>
  154. <dt><span class="memberNameLink"><a href="../io/milvus/client/AbstractMilvusGrpcClient.html#getCompactionState(io.milvus.param.control.GetCompactionStateParam)">getCompactionState(GetCompactionStateParam)</a></span> - Method in class io.milvus.client.<a href="../io/milvus/client/AbstractMilvusGrpcClient.html" title="class in io.milvus.client">AbstractMilvusGrpcClient</a></dt>
  155. <dd>&nbsp;</dd>
  156. <dt><span class="memberNameLink"><a href="../io/milvus/client/MilvusClient.html#getCompactionState(io.milvus.param.control.GetCompactionStateParam)">getCompactionState(GetCompactionStateParam)</a></span> - Method in interface io.milvus.client.<a href="../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></dt>
  157. <dd>
  158. <div class="block">Gets the compaction state by id.</div>
  159. </dd>
  160. <dt><a href="../io/milvus/param/control/GetCompactionStateParam.html" title="class in io.milvus.param.control"><span class="typeNameLink">GetCompactionStateParam</span></a> - Class in <a href="../io/milvus/param/control/package-summary.html">io.milvus.param.control</a></dt>
  161. <dd>
  162. <div class="block">Parameters for <code>getCompactionState</code> interface.</div>
  163. </dd>
  164. <dt><a href="../io/milvus/param/control/GetCompactionStateParam.Builder.html" title="class in io.milvus.param.control"><span class="typeNameLink">GetCompactionStateParam.Builder</span></a> - Class in <a href="../io/milvus/param/control/package-summary.html">io.milvus.param.control</a></dt>
  165. <dd>
  166. <div class="block">Builder for <code>GetCompactionStateParam</code> class.</div>
  167. </dd>
  168. <dt><span class="memberNameLink"><a href="../io/milvus/client/AbstractMilvusGrpcClient.html#getCompactionStateWithPlans(io.milvus.param.control.GetCompactionPlansParam)">getCompactionStateWithPlans(GetCompactionPlansParam)</a></span> - Method in class io.milvus.client.<a href="../io/milvus/client/AbstractMilvusGrpcClient.html" title="class in io.milvus.client">AbstractMilvusGrpcClient</a></dt>
  169. <dd>&nbsp;</dd>
  170. <dt><span class="memberNameLink"><a href="../io/milvus/client/MilvusClient.html#getCompactionStateWithPlans(io.milvus.param.control.GetCompactionPlansParam)">getCompactionStateWithPlans(GetCompactionPlansParam)</a></span> - Method in interface io.milvus.client.<a href="../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></dt>
  171. <dd>
  172. <div class="block">Gets compaction state with its plan.</div>
  173. </dd>
  174. <dt><span class="memberNameLink"><a href="../io/milvus/param/ConnectParam.html#getConnectTimeoutMs()">getConnectTimeoutMs()</a></span> - Method in class io.milvus.param.<a href="../io/milvus/param/ConnectParam.html" title="class in io.milvus.param">ConnectParam</a></dt>
  175. <dd>&nbsp;</dd>
  176. <dt><span class="memberNameLink"><a href="../io/milvus/response/DescCollResponseWrapper.html#getCreatedUtcTimestamp()">getCreatedUtcTimestamp()</a></span> - Method in class io.milvus.response.<a href="../io/milvus/response/DescCollResponseWrapper.html" title="class in io.milvus.response">DescCollResponseWrapper</a></dt>
  177. <dd>
  178. <div class="block">Get utc timestamp when collection created.</div>
  179. </dd>
  180. <dt><span class="memberNameLink"><a href="../io/milvus/param/R.html#getData()">getData()</a></span> - Method in class io.milvus.param.<a href="../io/milvus/param/R.html" title="class in io.milvus.param">R</a></dt>
  181. <dd>&nbsp;</dd>
  182. <dt><span class="memberNameLink"><a href="../io/milvus/response/MutationResultWrapper.html#getDeleteCount()">getDeleteCount()</a></span> - Method in class io.milvus.response.<a href="../io/milvus/response/MutationResultWrapper.html" title="class in io.milvus.response">MutationResultWrapper</a></dt>
  183. <dd>
  184. <div class="block">Gets the row count of the deleted entities.</div>
  185. </dd>
  186. <dt><span class="memberNameLink"><a href="../io/milvus/response/FieldDataWrapper.html#getDim()">getDim()</a></span> - Method in class io.milvus.response.<a href="../io/milvus/response/FieldDataWrapper.html" title="class in io.milvus.response">FieldDataWrapper</a></dt>
  187. <dd>
  188. <div class="block">Gets the dimension value of a vector field.</div>
  189. </dd>
  190. <dt><span class="memberNameLink"><a href="../io/milvus/param/collection/FieldType.html#getDimension()">getDimension()</a></span> - Method in class io.milvus.param.collection.<a href="../io/milvus/param/collection/FieldType.html" title="class in io.milvus.param.collection">FieldType</a></dt>
  191. <dd>&nbsp;</dd>
  192. <dt><span class="memberNameLink"><a href="../io/milvus/param/R.html#getException()">getException()</a></span> - Method in class io.milvus.param.<a href="../io/milvus/param/R.html" title="class in io.milvus.param">R</a></dt>
  193. <dd>&nbsp;</dd>
  194. <dt><span class="memberNameLink"><a href="../io/milvus/response/DescIndexResponseWrapper.IndexDesc.html#getExtraParam()">getExtraParam()</a></span> - Method in class io.milvus.response.<a href="../io/milvus/response/DescIndexResponseWrapper.IndexDesc.html" title="class in io.milvus.response">DescIndexResponseWrapper.IndexDesc</a></dt>
  195. <dd>&nbsp;</dd>
  196. <dt><span class="memberNameLink"><a href="../io/milvus/response/DescCollResponseWrapper.html#getFieldByName(java.lang.String)">getFieldByName(String)</a></span> - Method in class io.milvus.response.<a href="../io/milvus/response/DescCollResponseWrapper.html" title="class in io.milvus.response">DescCollResponseWrapper</a></dt>
  197. <dd>
  198. <div class="block">Get schema of a field by name.</div>
  199. </dd>
  200. <dt><span class="memberNameLink"><a href="../io/milvus/response/FieldDataWrapper.html#getFieldData()">getFieldData()</a></span> - Method in class io.milvus.response.<a href="../io/milvus/response/FieldDataWrapper.html" title="class in io.milvus.response">FieldDataWrapper</a></dt>
  201. <dd>
  202. <div class="block">Returns the field data according to its type:
  203. float vector field return List&lt;List&lt;Float&gt;&gt;,
  204. binary vector field return List&lt;ByteBuffer&gt;,
  205. int64 field return List&lt;Long&gt;,
  206. boolean field return List&lt;Boolean&gt;,
  207. etc.</div>
  208. </dd>
  209. <dt><span class="memberNameLink"><a href="../io/milvus/response/SearchResultsWrapper.html#getFieldData(java.lang.String,int)">getFieldData(String, int)</a></span> - Method in class io.milvus.response.<a href="../io/milvus/response/SearchResultsWrapper.html" title="class in io.milvus.response">SearchResultsWrapper</a></dt>
  210. <dd>
  211. <div class="block">Gets data for an output field which is specified by search request.</div>
  212. </dd>
  213. <dt><span class="memberNameLink"><a href="../io/milvus/response/DescCollResponseWrapper.html#getFields()">getFields()</a></span> - Method in class io.milvus.response.<a href="../io/milvus/response/DescCollResponseWrapper.html" title="class in io.milvus.response">DescCollResponseWrapper</a></dt>
  214. <dd>
  215. <div class="block">Get schema of the collection's fields.</div>
  216. </dd>
  217. <dt><span class="memberNameLink"><a href="../io/milvus/response/QueryResultsWrapper.html#getFieldWrapper(java.lang.String)">getFieldWrapper(String)</a></span> - Method in class io.milvus.response.<a href="../io/milvus/response/QueryResultsWrapper.html" title="class in io.milvus.response">QueryResultsWrapper</a></dt>
  218. <dd>
  219. <div class="block">Gets <a href="../io/milvus/response/FieldDataWrapper.html" title="class in io.milvus.response"><code>FieldDataWrapper</code></a> for a field.</div>
  220. </dd>
  221. <dt><span class="memberNameLink"><a href="../io/milvus/client/AbstractMilvusGrpcClient.html#getFlushState(io.milvus.param.control.GetFlushStateParam)">getFlushState(GetFlushStateParam)</a></span> - Method in class io.milvus.client.<a href="../io/milvus/client/AbstractMilvusGrpcClient.html" title="class in io.milvus.client">AbstractMilvusGrpcClient</a></dt>
  222. <dd>&nbsp;</dd>
  223. <dt><span class="memberNameLink"><a href="../io/milvus/client/MilvusClient.html#getFlushState(io.milvus.param.control.GetFlushStateParam)">getFlushState(GetFlushStateParam)</a></span> - Method in interface io.milvus.client.<a href="../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></dt>
  224. <dd>
  225. <div class="block">Get flush state of specified segments.</div>
  226. </dd>
  227. <dt><a href="../io/milvus/param/control/GetFlushStateParam.html" title="class in io.milvus.param.control"><span class="typeNameLink">GetFlushStateParam</span></a> - Class in <a href="../io/milvus/param/control/package-summary.html">io.milvus.param.control</a></dt>
  228. <dd>
  229. <div class="block">Parameters for <code>getMetric</code> interface.</div>
  230. </dd>
  231. <dt><a href="../io/milvus/param/control/GetFlushStateParam.Builder.html" title="class in io.milvus.param.control"><span class="typeNameLink">GetFlushStateParam.Builder</span></a> - Class in <a href="../io/milvus/param/control/package-summary.html">io.milvus.param.control</a></dt>
  232. <dd>
  233. <div class="block">Builder for <code>GetFlushStateParam</code> class.</div>
  234. </dd>
  235. <dt><span class="memberNameLink"><a href="../io/milvus/param/ConnectParam.html#getHost()">getHost()</a></span> - Method in class io.milvus.param.<a href="../io/milvus/param/ConnectParam.html" title="class in io.milvus.param">ConnectParam</a></dt>
  236. <dd>&nbsp;</dd>
  237. <dt><span class="memberNameLink"><a href="../io/milvus/param/ConnectParam.html#getIdleTimeoutMs()">getIdleTimeoutMs()</a></span> - Method in class io.milvus.param.<a href="../io/milvus/param/ConnectParam.html" title="class in io.milvus.param">ConnectParam</a></dt>
  238. <dd>&nbsp;</dd>
  239. <dt><span class="memberNameLink"><a href="../io/milvus/response/SearchResultsWrapper.html#getIDScore(int)">getIDScore(int)</a></span> - Method in class io.milvus.response.<a href="../io/milvus/response/SearchResultsWrapper.html" title="class in io.milvus.response">SearchResultsWrapper</a></dt>
  240. <dd>
  241. <div class="block">Gets ID-score pairs returned by search interface.</div>
  242. </dd>
  243. <dt><span class="memberNameLink"><a href="../io/milvus/client/AbstractMilvusGrpcClient.html#getIndexBuildProgress(io.milvus.param.index.GetIndexBuildProgressParam)">getIndexBuildProgress(GetIndexBuildProgressParam)</a></span> - Method in class io.milvus.client.<a href="../io/milvus/client/AbstractMilvusGrpcClient.html" title="class in io.milvus.client">AbstractMilvusGrpcClient</a></dt>
  244. <dd>&nbsp;</dd>
  245. <dt><span class="memberNameLink"><a href="../io/milvus/client/MilvusClient.html#getIndexBuildProgress(io.milvus.param.index.GetIndexBuildProgressParam)">getIndexBuildProgress(GetIndexBuildProgressParam)</a></span> - Method in interface io.milvus.client.<a href="../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></dt>
  246. <dd>
  247. <div class="block">Shows the index building progress, such as how many rows are indexed.</div>
  248. </dd>
  249. <dt><a href="../io/milvus/param/index/GetIndexBuildProgressParam.html" title="class in io.milvus.param.index"><span class="typeNameLink">GetIndexBuildProgressParam</span></a> - Class in <a href="../io/milvus/param/index/package-summary.html">io.milvus.param.index</a></dt>
  250. <dd>
  251. <div class="block">Parameters for <code>getIndexBuildProgress</code> interface.</div>
  252. </dd>
  253. <dt><a href="../io/milvus/param/index/GetIndexBuildProgressParam.Builder.html" title="class in io.milvus.param.index"><span class="typeNameLink">GetIndexBuildProgressParam.Builder</span></a> - Class in <a href="../io/milvus/param/index/package-summary.html">io.milvus.param.index</a></dt>
  254. <dd>
  255. <div class="block">Builder for <code>GetIndexBuildProgressParam</code> class.</div>
  256. </dd>
  257. <dt><span class="memberNameLink"><a href="../io/milvus/response/DescIndexResponseWrapper.html#getIndexDescByFieldName(java.lang.String)">getIndexDescByFieldName(String)</a></span> - Method in class io.milvus.response.<a href="../io/milvus/response/DescIndexResponseWrapper.html" title="class in io.milvus.response">DescIndexResponseWrapper</a></dt>
  258. <dd>
  259. <div class="block">Get index description by field name.</div>
  260. </dd>
  261. <dt><span class="memberNameLink"><a href="../io/milvus/response/DescIndexResponseWrapper.html#getIndexDescriptions()">getIndexDescriptions()</a></span> - Method in class io.milvus.response.<a href="../io/milvus/response/DescIndexResponseWrapper.html" title="class in io.milvus.response">DescIndexResponseWrapper</a></dt>
  262. <dd>
  263. <div class="block">Get index description of fields.</div>
  264. </dd>
  265. <dt><span class="memberNameLink"><a href="../io/milvus/client/AbstractMilvusGrpcClient.html#getIndexState(io.milvus.param.index.GetIndexStateParam)">getIndexState(GetIndexStateParam)</a></span> - Method in class io.milvus.client.<a href="../io/milvus/client/AbstractMilvusGrpcClient.html" title="class in io.milvus.client">AbstractMilvusGrpcClient</a></dt>
  266. <dd>&nbsp;</dd>
  267. <dt><span class="memberNameLink"><a href="../io/milvus/client/MilvusClient.html#getIndexState(io.milvus.param.index.GetIndexStateParam)">getIndexState(GetIndexStateParam)</a></span> - Method in interface io.milvus.client.<a href="../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></dt>
  268. <dd>
  269. <div class="block">Shows the index building state(in-progress/finished/failed), and the reason for failure (if any).</div>
  270. </dd>
  271. <dt><a href="../io/milvus/param/index/GetIndexStateParam.html" title="class in io.milvus.param.index"><span class="typeNameLink">GetIndexStateParam</span></a> - Class in <a href="../io/milvus/param/index/package-summary.html">io.milvus.param.index</a></dt>
  272. <dd>
  273. <div class="block">Parameters for <code>getIndexState</code> interface.</div>
  274. </dd>
  275. <dt><a href="../io/milvus/param/index/GetIndexStateParam.Builder.html" title="class in io.milvus.param.index"><span class="typeNameLink">GetIndexStateParam.Builder</span></a> - Class in <a href="../io/milvus/param/index/package-summary.html">io.milvus.param.index</a></dt>
  276. <dd>
  277. <div class="block">Builder for <code>GetIndexStateParam</code> class.</div>
  278. </dd>
  279. <dt><span class="memberNameLink"><a href="../io/milvus/response/DescIndexResponseWrapper.IndexDesc.html#getIndexType()">getIndexType()</a></span> - Method in class io.milvus.response.<a href="../io/milvus/response/DescIndexResponseWrapper.IndexDesc.html" title="class in io.milvus.response">DescIndexResponseWrapper.IndexDesc</a></dt>
  280. <dd>&nbsp;</dd>
  281. <dt><span class="memberNameLink"><a href="../io/milvus/response/MutationResultWrapper.html#getInsertCount()">getInsertCount()</a></span> - Method in class io.milvus.response.<a href="../io/milvus/response/MutationResultWrapper.html" title="class in io.milvus.response">MutationResultWrapper</a></dt>
  282. <dd>
  283. <div class="block">Gets the row count of the inserted entities.</div>
  284. </dd>
  285. <dt><span class="memberNameLink"><a href="../io/milvus/param/ConnectParam.html#getKeepAliveTimeMs()">getKeepAliveTimeMs()</a></span> - Method in class io.milvus.param.<a href="../io/milvus/param/ConnectParam.html" title="class in io.milvus.param">ConnectParam</a></dt>
  286. <dd>&nbsp;</dd>
  287. <dt><span class="memberNameLink"><a href="../io/milvus/param/ConnectParam.html#getKeepAliveTimeoutMs()">getKeepAliveTimeoutMs()</a></span> - Method in class io.milvus.param.<a href="../io/milvus/param/ConnectParam.html" title="class in io.milvus.param">ConnectParam</a></dt>
  288. <dd>&nbsp;</dd>
  289. <dt><span class="memberNameLink"><a href="../io/milvus/response/MutationResultWrapper.html#getLongIDs()">getLongIDs()</a></span> - Method in class io.milvus.response.<a href="../io/milvus/response/MutationResultWrapper.html" title="class in io.milvus.response">MutationResultWrapper</a></dt>
  290. <dd>
  291. <div class="block">Gets the long ID array returned by insert interface.</div>
  292. </dd>
  293. <dt><span class="memberNameLink"><a href="../io/milvus/param/R.html#getMessage()">getMessage()</a></span> - Method in class io.milvus.param.<a href="../io/milvus/param/R.html" title="class in io.milvus.param">R</a></dt>
  294. <dd>&nbsp;</dd>
  295. <dt><span class="memberNameLink"><a href="../io/milvus/client/AbstractMilvusGrpcClient.html#getMetrics(io.milvus.param.control.GetMetricsParam)">getMetrics(GetMetricsParam)</a></span> - Method in class io.milvus.client.<a href="../io/milvus/client/AbstractMilvusGrpcClient.html" title="class in io.milvus.client">AbstractMilvusGrpcClient</a></dt>
  296. <dd>&nbsp;</dd>
  297. <dt><span class="memberNameLink"><a href="../io/milvus/client/MilvusClient.html#getMetrics(io.milvus.param.control.GetMetricsParam)">getMetrics(GetMetricsParam)</a></span> - Method in interface io.milvus.client.<a href="../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></dt>
  298. <dd>
  299. <div class="block">Gets the runtime metrics information of Milvus, returns the result in .json format.</div>
  300. </dd>
  301. <dt><a href="../io/milvus/param/control/GetMetricsParam.html" title="class in io.milvus.param.control"><span class="typeNameLink">GetMetricsParam</span></a> - Class in <a href="../io/milvus/param/control/package-summary.html">io.milvus.param.control</a></dt>
  302. <dd>
  303. <div class="block">Parameters for <code>getMetric</code> interface.</div>
  304. </dd>
  305. <dt><a href="../io/milvus/param/control/GetMetricsParam.Builder.html" title="class in io.milvus.param.control"><span class="typeNameLink">GetMetricsParam.Builder</span></a> - Class in <a href="../io/milvus/param/control/package-summary.html">io.milvus.param.control</a></dt>
  306. <dd>
  307. <div class="block">Builder for <code>GetMetricsParam</code> class.</div>
  308. </dd>
  309. <dt><span class="memberNameLink"><a href="../io/milvus/response/DescIndexResponseWrapper.IndexDesc.html#getMetricType()">getMetricType()</a></span> - Method in class io.milvus.response.<a href="../io/milvus/response/DescIndexResponseWrapper.IndexDesc.html" title="class in io.milvus.response">DescIndexResponseWrapper.IndexDesc</a></dt>
  310. <dd>&nbsp;</dd>
  311. <dt><span class="memberNameLink"><a href="../io/milvus/param/RpcStatus.html#getMsg()">getMsg()</a></span> - Method in class io.milvus.param.<a href="../io/milvus/param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a></dt>
  312. <dd>&nbsp;</dd>
  313. <dt><span class="memberNameLink"><a href="../io/milvus/param/dml/InsertParam.Field.html#getName()">getName()</a></span> - Method in class io.milvus.param.dml.<a href="../io/milvus/param/dml/InsertParam.Field.html" title="class in io.milvus.param.dml">InsertParam.Field</a></dt>
  314. <dd>
  315. <div class="block">Return name of the field.</div>
  316. </dd>
  317. <dt><span class="memberNameLink"><a href="../io/milvus/response/MutationResultWrapper.html#getOperationTs()">getOperationTs()</a></span> - Method in class io.milvus.response.<a href="../io/milvus/response/MutationResultWrapper.html" title="class in io.milvus.response">MutationResultWrapper</a></dt>
  318. <dd>
  319. <div class="block">Get timestamp of the operation marked by server.</div>
  320. </dd>
  321. <dt><span class="memberNameLink"><a href="../io/milvus/response/ShowPartResponseWrapper.html#getPartitionInfoByName(java.lang.String)">getPartitionInfoByName(String)</a></span> - Method in class io.milvus.response.<a href="../io/milvus/response/ShowPartResponseWrapper.html" title="class in io.milvus.response">ShowPartResponseWrapper</a></dt>
  322. <dd>
  323. <div class="block">Get information of one partition by name.</div>
  324. </dd>
  325. <dt><span class="memberNameLink"><a href="../io/milvus/response/ShowPartResponseWrapper.html#getPartitionsInfo()">getPartitionsInfo()</a></span> - Method in class io.milvus.response.<a href="../io/milvus/response/ShowPartResponseWrapper.html" title="class in io.milvus.response">ShowPartResponseWrapper</a></dt>
  326. <dd>
  327. <div class="block">Get information of the partitions.</div>
  328. </dd>
  329. <dt><span class="memberNameLink"><a href="../io/milvus/client/AbstractMilvusGrpcClient.html#getPartitionStatistics(io.milvus.param.partition.GetPartitionStatisticsParam)">getPartitionStatistics(GetPartitionStatisticsParam)</a></span> - Method in class io.milvus.client.<a href="../io/milvus/client/AbstractMilvusGrpcClient.html" title="class in io.milvus.client">AbstractMilvusGrpcClient</a></dt>
  330. <dd>&nbsp;</dd>
  331. <dt><span class="memberNameLink"><a href="../io/milvus/client/MilvusClient.html#getPartitionStatistics(io.milvus.param.partition.GetPartitionStatisticsParam)">getPartitionStatistics(GetPartitionStatisticsParam)</a></span> - Method in interface io.milvus.client.<a href="../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></dt>
  332. <dd>
  333. <div class="block">Shows the statistics information of a partition.</div>
  334. </dd>
  335. <dt><a href="../io/milvus/param/partition/GetPartitionStatisticsParam.html" title="class in io.milvus.param.partition"><span class="typeNameLink">GetPartitionStatisticsParam</span></a> - Class in <a href="../io/milvus/param/partition/package-summary.html">io.milvus.param.partition</a></dt>
  336. <dd>
  337. <div class="block">Parameters for <code>getPartitionStatistics</code> interface.</div>
  338. </dd>
  339. <dt><a href="../io/milvus/param/partition/GetPartitionStatisticsParam.Builder.html" title="class in io.milvus.param.partition"><span class="typeNameLink">GetPartitionStatisticsParam.Builder</span></a> - Class in <a href="../io/milvus/param/partition/package-summary.html">io.milvus.param.partition</a></dt>
  340. <dd>
  341. <div class="block">Builder for <code>GetPartitionStatisticsParam</code> class.</div>
  342. </dd>
  343. <dt><a href="../io/milvus/response/GetPartStatResponseWrapper.html" title="class in io.milvus.response"><span class="typeNameLink">GetPartStatResponseWrapper</span></a> - Class in <a href="../io/milvus/response/package-summary.html">io.milvus.response</a></dt>
  344. <dd>
  345. <div class="block">Utility class to wrap response of <code>getPartitionStatistics</code> interface.</div>
  346. </dd>
  347. <dt><span class="memberNameLink"><a href="../io/milvus/response/GetPartStatResponseWrapper.html#%3Cinit%3E(io.milvus.grpc.GetPartitionStatisticsResponse)">GetPartStatResponseWrapper(GetPartitionStatisticsResponse)</a></span> - Constructor for class io.milvus.response.<a href="../io/milvus/response/GetPartStatResponseWrapper.html" title="class in io.milvus.response">GetPartStatResponseWrapper</a></dt>
  348. <dd>&nbsp;</dd>
  349. <dt><span class="memberNameLink"><a href="../io/milvus/client/AbstractMilvusGrpcClient.html#getPersistentSegmentInfo(io.milvus.param.control.GetPersistentSegmentInfoParam)">getPersistentSegmentInfo(GetPersistentSegmentInfoParam)</a></span> - Method in class io.milvus.client.<a href="../io/milvus/client/AbstractMilvusGrpcClient.html" title="class in io.milvus.client">AbstractMilvusGrpcClient</a></dt>
  350. <dd>&nbsp;</dd>
  351. <dt><span class="memberNameLink"><a href="../io/milvus/client/MilvusClient.html#getPersistentSegmentInfo(io.milvus.param.control.GetPersistentSegmentInfoParam)">getPersistentSegmentInfo(GetPersistentSegmentInfoParam)</a></span> - Method in interface io.milvus.client.<a href="../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></dt>
  352. <dd>
  353. <div class="block">Gets the information of persistent segments from data node, including row count,
  354. persistence state(growing or flushed), etc.</div>
  355. </dd>
  356. <dt><a href="../io/milvus/param/control/GetPersistentSegmentInfoParam.html" title="class in io.milvus.param.control"><span class="typeNameLink">GetPersistentSegmentInfoParam</span></a> - Class in <a href="../io/milvus/param/control/package-summary.html">io.milvus.param.control</a></dt>
  357. <dd>
  358. <div class="block">Parameters for <code>getPersistentSegmentInfo</code> interface.</div>
  359. </dd>
  360. <dt><a href="../io/milvus/param/control/GetPersistentSegmentInfoParam.Builder.html" title="class in io.milvus.param.control"><span class="typeNameLink">GetPersistentSegmentInfoParam.Builder</span></a> - Class in <a href="../io/milvus/param/control/package-summary.html">io.milvus.param.control</a></dt>
  361. <dd>
  362. <div class="block">Builder for <code>GetPersistentSegmentInfoParam</code> class.</div>
  363. </dd>
  364. <dt><span class="memberNameLink"><a href="../io/milvus/param/ConnectParam.html#getPort()">getPort()</a></span> - Method in class io.milvus.param.<a href="../io/milvus/param/ConnectParam.html" title="class in io.milvus.param">ConnectParam</a></dt>
  365. <dd>&nbsp;</dd>
  366. <dt><span class="memberNameLink"><a href="../io/milvus/client/AbstractMilvusGrpcClient.html#getQuerySegmentInfo(io.milvus.param.control.GetQuerySegmentInfoParam)">getQuerySegmentInfo(GetQuerySegmentInfoParam)</a></span> - Method in class io.milvus.client.<a href="../io/milvus/client/AbstractMilvusGrpcClient.html" title="class in io.milvus.client">AbstractMilvusGrpcClient</a></dt>
  367. <dd>&nbsp;</dd>
  368. <dt><span class="memberNameLink"><a href="../io/milvus/client/MilvusClient.html#getQuerySegmentInfo(io.milvus.param.control.GetQuerySegmentInfoParam)">getQuerySegmentInfo(GetQuerySegmentInfoParam)</a></span> - Method in interface io.milvus.client.<a href="../io/milvus/client/MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></dt>
  369. <dd>
  370. <div class="block">Gets the query information of segments in a collection from query node, including row count,
  371. memory usage size, index name, etc.</div>
  372. </dd>
  373. <dt><a href="../io/milvus/param/control/GetQuerySegmentInfoParam.html" title="class in io.milvus.param.control"><span class="typeNameLink">GetQuerySegmentInfoParam</span></a> - Class in <a href="../io/milvus/param/control/package-summary.html">io.milvus.param.control</a></dt>
  374. <dd>
  375. <div class="block">Parameters for <code>getQuerySegmentInfo</code> interface.</div>
  376. </dd>
  377. <dt><a href="../io/milvus/param/control/GetQuerySegmentInfoParam.Builder.html" title="class in io.milvus.param.control"><span class="typeNameLink">GetQuerySegmentInfoParam.Builder</span></a> - Class in <a href="../io/milvus/param/control/package-summary.html">io.milvus.param.control</a></dt>
  378. <dd>
  379. <div class="block">Builder for <code>GetPersistentSegmentInfoParam</code> class.</div>
  380. </dd>
  381. <dt><span class="memberNameLink"><a href="../io/milvus/response/FieldDataWrapper.html#getRowCount()">getRowCount()</a></span> - Method in class io.milvus.response.<a href="../io/milvus/response/FieldDataWrapper.html" title="class in io.milvus.response">FieldDataWrapper</a></dt>
  382. <dd>
  383. <div class="block">Gets the row count of a field.</div>
  384. </dd>
  385. <dt><span class="memberNameLink"><a href="../io/milvus/response/GetCollStatResponseWrapper.html#getRowCount()">getRowCount()</a></span> - Method in class io.milvus.response.<a href="../io/milvus/response/GetCollStatResponseWrapper.html" title="class in io.milvus.response">GetCollStatResponseWrapper</a></dt>
  386. <dd>
  387. <div class="block">Gets the row count of a field.</div>
  388. </dd>
  389. <dt><span class="memberNameLink"><a href="../io/milvus/response/GetPartStatResponseWrapper.html#getRowCount()">getRowCount()</a></span> - Method in class io.milvus.response.<a href="../io/milvus/response/GetPartStatResponseWrapper.html" title="class in io.milvus.response">GetPartStatResponseWrapper</a></dt>
  390. <dd>
  391. <div class="block">Gets the row count of a field.</div>
  392. </dd>
  393. <dt><span class="memberNameLink"><a href="../io/milvus/response/DescCollResponseWrapper.html#getShardNumber()">getShardNumber()</a></span> - Method in class io.milvus.response.<a href="../io/milvus/response/DescCollResponseWrapper.html" title="class in io.milvus.response">DescCollResponseWrapper</a></dt>
  394. <dd>
  395. <div class="block">Get shard number of the collection.</div>
  396. </dd>
  397. <dt><span class="memberNameLink"><a href="../io/milvus/exception/MilvusException.html#getStatus()">getStatus()</a></span> - Method in exception io.milvus.exception.<a href="../io/milvus/exception/MilvusException.html" title="class in io.milvus.exception">MilvusException</a></dt>
  398. <dd>&nbsp;</dd>
  399. <dt><span class="memberNameLink"><a href="../io/milvus/param/R.html#getStatus()">getStatus()</a></span> - Method in class io.milvus.param.<a href="../io/milvus/param/R.html" title="class in io.milvus.param">R</a></dt>
  400. <dd>&nbsp;</dd>
  401. <dt><span class="memberNameLink"><a href="../io/milvus/response/MutationResultWrapper.html#getStringIDs()">getStringIDs()</a></span> - Method in class io.milvus.response.<a href="../io/milvus/response/MutationResultWrapper.html" title="class in io.milvus.response">MutationResultWrapper</a></dt>
  402. <dd>
  403. <div class="block">Gets the string ID array returned by insert interface.</div>
  404. </dd>
  405. <dt><span class="memberNameLink"><a href="../io/milvus/param/dml/InsertParam.Field.html#getType()">getType()</a></span> - Method in class io.milvus.param.dml.<a href="../io/milvus/param/dml/InsertParam.Field.html" title="class in io.milvus.param.dml">InsertParam.Field</a></dt>
  406. <dd>
  407. <div class="block">Return data type of the field.</div>
  408. </dd>
  409. <dt><span class="memberNameLink"><a href="../io/milvus/param/dml/InsertParam.Field.html#getValues()">getValues()</a></span> - Method in class io.milvus.param.dml.<a href="../io/milvus/param/dml/InsertParam.Field.html" title="class in io.milvus.param.dml">InsertParam.Field</a></dt>
  410. <dd>
  411. <div class="block">Return data of the field, in column-base.</div>
  412. </dd>
  413. <dt><span class="memberNameLink"><a href="../io/milvus/param/Constant.html#GUARANTEE_EVENTUALLY_TS">GUARANTEE_EVENTUALLY_TS</a></span> - Static variable in class io.milvus.param.<a href="../io/milvus/param/Constant.html" title="class in io.milvus.param">Constant</a></dt>
  414. <dd>&nbsp;</dd>
  415. <dt><span class="memberNameLink"><a href="../io/milvus/param/Constant.html#GUARANTEE_STRONG_TS">GUARANTEE_STRONG_TS</a></span> - Static variable in class io.milvus.param.<a href="../io/milvus/param/Constant.html" title="class in io.milvus.param">Constant</a></dt>
  416. <dd>&nbsp;</dd>
  417. </dl>
  418. <a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">J</a>&nbsp;<a href="index-11.html">K</a>&nbsp;<a href="index-12.html">L</a>&nbsp;<a href="index-13.html">M</a>&nbsp;<a href="index-14.html">N</a>&nbsp;<a href="index-15.html">O</a>&nbsp;<a href="index-16.html">P</a>&nbsp;<a href="index-17.html">Q</a>&nbsp;<a href="index-18.html">R</a>&nbsp;<a href="index-19.html">S</a>&nbsp;<a href="index-20.html">T</a>&nbsp;<a href="index-21.html">U</a>&nbsp;<a href="index-22.html">V</a>&nbsp;<a href="index-23.html">W</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes</a>&nbsp;<a href="../allpackages-index.html">All&nbsp;Packages</a></div>
  419. </main>
  420. <footer role="contentinfo">
  421. <nav role="navigation">
  422. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  423. <div class="bottomNav"><a id="navbar.bottom">
  424. <!-- -->
  425. </a>
  426. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  427. <a id="navbar.bottom.firstrow">
  428. <!-- -->
  429. </a>
  430. <ul class="navList" title="Navigation">
  431. <li><a href="../index.html">Overview</a></li>
  432. <li>Package</li>
  433. <li>Class</li>
  434. <li><a href="../overview-tree.html">Tree</a></li>
  435. <li><a href="../deprecated-list.html">Deprecated</a></li>
  436. <li class="navBarCell1Rev">Index</li>
  437. <li><a href="../help-doc.html">Help</a></li>
  438. </ul>
  439. </div>
  440. <div class="subNav">
  441. <ul class="navList" id="allclasses_navbar_bottom">
  442. <li><a href="../allclasses.html">All&nbsp;Classes</a></li>
  443. </ul>
  444. <div>
  445. <script type="text/javascript"><!--
  446. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  447. if(window==top) {
  448. allClassesLink.style.display = "block";
  449. }
  450. else {
  451. allClassesLink.style.display = "none";
  452. }
  453. //-->
  454. </script>
  455. <noscript>
  456. <div>JavaScript is disabled on your browser.</div>
  457. </noscript>
  458. </div>
  459. <a id="skip.navbar.bottom">
  460. <!-- -->
  461. </a></div>
  462. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  463. </nav>
  464. </footer>
  465. </body>
  466. </html>