MutationResultWrapper.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452
  1. <!DOCTYPE HTML>
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (11.0.18) on Fri Apr 19 15:06:25 CST 2024 -->
  6. <title>MutationResultWrapper</title>
  7. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  8. <meta name="dc.created" content="2024-04-19">
  9. <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
  10. <link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.min.css" title="Style">
  11. <link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style">
  12. <script type="text/javascript" src="../../../script.js"></script>
  13. <script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
  14. <script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
  15. <!--[if IE]>
  16. <script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
  17. <![endif]-->
  18. <script type="text/javascript" src="../../../jquery/jquery-3.6.0.min.js"></script>
  19. <script type="text/javascript" src="../../../jquery/jquery-ui.min.js"></script>
  20. </head>
  21. <body>
  22. <script type="text/javascript"><!--
  23. try {
  24. if (location.href.indexOf('is-external=true') == -1) {
  25. parent.document.title="MutationResultWrapper";
  26. }
  27. }
  28. catch(err) {
  29. }
  30. //-->
  31. var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
  32. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
  33. var altColor = "altColor";
  34. var rowColor = "rowColor";
  35. var tableTab = "tableTab";
  36. var activeTableTab = "activeTableTab";
  37. var pathtoroot = "../../../";
  38. var useModuleDirectories = true;
  39. loadScripts(document, 'script');</script>
  40. <noscript>
  41. <div>JavaScript is disabled on your browser.</div>
  42. </noscript>
  43. <header role="banner">
  44. <nav role="navigation">
  45. <div class="fixedNav">
  46. <!-- ========= START OF TOP NAVBAR ======= -->
  47. <div class="topNav"><a id="navbar.top">
  48. <!-- -->
  49. </a>
  50. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  51. <a id="navbar.top.firstrow">
  52. <!-- -->
  53. </a>
  54. <ul class="navList" title="Navigation">
  55. <li><a href="../../../index.html">Overview</a></li>
  56. <li><a href="package-summary.html">Package</a></li>
  57. <li class="navBarCell1Rev">Class</li>
  58. <li><a href="package-tree.html">Tree</a></li>
  59. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  60. <li><a href="../../../index-files/index-1.html">Index</a></li>
  61. <li><a href="../../../help-doc.html">Help</a></li>
  62. </ul>
  63. </div>
  64. <div class="subNav">
  65. <ul class="navList" id="allclasses_navbar_top">
  66. <li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
  67. </ul>
  68. <ul class="navListSearch">
  69. <li><label for="search">SEARCH:</label>
  70. <input type="text" id="search" value="search" disabled="disabled">
  71. <input type="reset" id="reset" value="reset" disabled="disabled">
  72. </li>
  73. </ul>
  74. <div>
  75. <script type="text/javascript"><!--
  76. allClassesLink = document.getElementById("allclasses_navbar_top");
  77. if(window==top) {
  78. allClassesLink.style.display = "block";
  79. }
  80. else {
  81. allClassesLink.style.display = "none";
  82. }
  83. //-->
  84. </script>
  85. <noscript>
  86. <div>JavaScript is disabled on your browser.</div>
  87. </noscript>
  88. </div>
  89. <div>
  90. <ul class="subNavList">
  91. <li>Summary:&nbsp;</li>
  92. <li>Nested&nbsp;|&nbsp;</li>
  93. <li>Field&nbsp;|&nbsp;</li>
  94. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  95. <li><a href="#method.summary">Method</a></li>
  96. </ul>
  97. <ul class="subNavList">
  98. <li>Detail:&nbsp;</li>
  99. <li>Field&nbsp;|&nbsp;</li>
  100. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  101. <li><a href="#method.detail">Method</a></li>
  102. </ul>
  103. </div>
  104. <a id="skip.navbar.top">
  105. <!-- -->
  106. </a></div>
  107. <!-- ========= END OF TOP NAVBAR ========= -->
  108. </div>
  109. <div class="navPadding">&nbsp;</div>
  110. <script type="text/javascript"><!--
  111. $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
  112. //-->
  113. </script>
  114. </nav>
  115. </header>
  116. <!-- ======== START OF CLASS DATA ======== -->
  117. <main role="main">
  118. <div class="header">
  119. <div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">io.milvus.response</a></div>
  120. <h2 title="Class MutationResultWrapper" class="title">Class MutationResultWrapper</h2>
  121. </div>
  122. <div class="contentContainer">
  123. <ul class="inheritance">
  124. <li>java.lang.Object</li>
  125. <li>
  126. <ul class="inheritance">
  127. <li>io.milvus.response.MutationResultWrapper</li>
  128. </ul>
  129. </li>
  130. </ul>
  131. <div class="description">
  132. <ul class="blockList">
  133. <li class="blockList">
  134. <hr>
  135. <pre>public class <span class="typeNameLabel">MutationResultWrapper</span>
  136. extends java.lang.Object</pre>
  137. <div class="block">Utility class to wrap response of <code>insert/delete</code> interface.</div>
  138. </li>
  139. </ul>
  140. </div>
  141. <div class="summary">
  142. <ul class="blockList">
  143. <li class="blockList">
  144. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  145. <section>
  146. <ul class="blockList">
  147. <li class="blockList"><a id="constructor.summary">
  148. <!-- -->
  149. </a>
  150. <h3>Constructor Summary</h3>
  151. <table class="memberSummary">
  152. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  153. <tr>
  154. <th class="colFirst" scope="col">Constructor</th>
  155. <th class="colLast" scope="col">Description</th>
  156. </tr>
  157. <tr class="altColor">
  158. <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(io.milvus.grpc.MutationResult)">MutationResultWrapper</a></span>&#8203;(@NonNull io.milvus.grpc.MutationResult&nbsp;result)</code></th>
  159. <td class="colLast">&nbsp;</td>
  160. </tr>
  161. </table>
  162. </li>
  163. </ul>
  164. </section>
  165. <!-- ========== METHOD SUMMARY =========== -->
  166. <section>
  167. <ul class="blockList">
  168. <li class="blockList"><a id="method.summary">
  169. <!-- -->
  170. </a>
  171. <h3>Method Summary</h3>
  172. <table class="memberSummary">
  173. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  174. <tr>
  175. <th class="colFirst" scope="col">Modifier and Type</th>
  176. <th class="colSecond" scope="col">Method</th>
  177. <th class="colLast" scope="col">Description</th>
  178. </tr>
  179. <tr id="i0" class="altColor">
  180. <td class="colFirst"><code>long</code></td>
  181. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDeleteCount()">getDeleteCount</a></span>()</code></th>
  182. <td class="colLast">
  183. <div class="block">Gets the row count of the deleted entities.</div>
  184. </td>
  185. </tr>
  186. <tr id="i1" class="rowColor">
  187. <td class="colFirst"><code>java.util.List&lt;?&gt;</code></td>
  188. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDeleteIDs()">getDeleteIDs</a></span>()</code></th>
  189. <td class="colLast">
  190. <div class="block">Gets the ID array from returned by delete interface.</div>
  191. </td>
  192. </tr>
  193. <tr id="i2" class="altColor">
  194. <td class="colFirst"><code>long</code></td>
  195. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInsertCount()">getInsertCount</a></span>()</code></th>
  196. <td class="colLast">
  197. <div class="block">Gets the row count of the inserted entities.</div>
  198. </td>
  199. </tr>
  200. <tr id="i3" class="rowColor">
  201. <td class="colFirst"><code>java.util.List&lt;?&gt;</code></td>
  202. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInsertIDs()">getInsertIDs</a></span>()</code></th>
  203. <td class="colLast">
  204. <div class="block">Gets the ID array from returned by insert interface.</div>
  205. </td>
  206. </tr>
  207. <tr id="i4" class="altColor">
  208. <td class="colFirst"><code>java.util.List&lt;java.lang.Long&gt;</code></td>
  209. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLongIDs()">getLongIDs</a></span>()</code></th>
  210. <td class="colLast">
  211. <div class="block">Gets the long ID array returned by insert interface.</div>
  212. </td>
  213. </tr>
  214. <tr id="i5" class="rowColor">
  215. <td class="colFirst"><code>long</code></td>
  216. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOperationTs()">getOperationTs</a></span>()</code></th>
  217. <td class="colLast">
  218. <div class="block">Get timestamp of the operation marked by server.</div>
  219. </td>
  220. </tr>
  221. <tr id="i6" class="altColor">
  222. <td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td>
  223. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStringIDs()">getStringIDs</a></span>()</code></th>
  224. <td class="colLast">
  225. <div class="block">Gets the string ID array returned by insert interface.</div>
  226. </td>
  227. </tr>
  228. </table>
  229. <ul class="blockList">
  230. <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
  231. <!-- -->
  232. </a>
  233. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  234. <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  235. </ul>
  236. </li>
  237. </ul>
  238. </section>
  239. </li>
  240. </ul>
  241. </div>
  242. <div class="details">
  243. <ul class="blockList">
  244. <li class="blockList">
  245. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  246. <section>
  247. <ul class="blockList">
  248. <li class="blockList"><a id="constructor.detail">
  249. <!-- -->
  250. </a>
  251. <h3>Constructor Detail</h3>
  252. <a id="&lt;init&gt;(io.milvus.grpc.MutationResult)">
  253. <!-- -->
  254. </a>
  255. <ul class="blockListLast">
  256. <li class="blockList">
  257. <h4>MutationResultWrapper</h4>
  258. <pre>public&nbsp;MutationResultWrapper&#8203;(@NonNull
  259. @NonNull io.milvus.grpc.MutationResult&nbsp;result)</pre>
  260. </li>
  261. </ul>
  262. </li>
  263. </ul>
  264. </section>
  265. <!-- ============ METHOD DETAIL ========== -->
  266. <section>
  267. <ul class="blockList">
  268. <li class="blockList"><a id="method.detail">
  269. <!-- -->
  270. </a>
  271. <h3>Method Detail</h3>
  272. <a id="getInsertCount()">
  273. <!-- -->
  274. </a>
  275. <ul class="blockList">
  276. <li class="blockList">
  277. <h4>getInsertCount</h4>
  278. <pre class="methodSignature">public&nbsp;long&nbsp;getInsertCount()</pre>
  279. <div class="block">Gets the row count of the inserted entities.</div>
  280. <dl>
  281. <dt><span class="returnLabel">Returns:</span></dt>
  282. <dd><code>int</code> row count of the inserted entities</dd>
  283. </dl>
  284. </li>
  285. </ul>
  286. <a id="getLongIDs()">
  287. <!-- -->
  288. </a>
  289. <ul class="blockList">
  290. <li class="blockList">
  291. <h4>getLongIDs</h4>
  292. <pre class="methodSignature">public&nbsp;java.util.List&lt;java.lang.Long&gt;&nbsp;getLongIDs()
  293. throws <a href="../exception/ParamException.html" title="class in io.milvus.exception">ParamException</a></pre>
  294. <div class="block">Gets the long ID array returned by insert interface.
  295. Throw <a href="../exception/ParamException.html" title="class in io.milvus.exception"><code>ParamException</code></a> if the primary key type is not int64 type.</div>
  296. <dl>
  297. <dt><span class="returnLabel">Returns:</span></dt>
  298. <dd>List of Long, ID array returned by insert interface</dd>
  299. <dt><span class="throwsLabel">Throws:</span></dt>
  300. <dd><code><a href="../exception/ParamException.html" title="class in io.milvus.exception">ParamException</a></code></dd>
  301. </dl>
  302. </li>
  303. </ul>
  304. <a id="getStringIDs()">
  305. <!-- -->
  306. </a>
  307. <ul class="blockList">
  308. <li class="blockList">
  309. <h4>getStringIDs</h4>
  310. <pre class="methodSignature">public&nbsp;java.util.List&lt;java.lang.String&gt;&nbsp;getStringIDs()
  311. throws <a href="../exception/ParamException.html" title="class in io.milvus.exception">ParamException</a></pre>
  312. <div class="block">Gets the string ID array returned by insert interface.
  313. Throw <a href="../exception/ParamException.html" title="class in io.milvus.exception"><code>ParamException</code></a> if the primary key type is not string type.
  314. Note that current release of Milvus doesn't support string type field, thus this method is reserved.</div>
  315. <dl>
  316. <dt><span class="returnLabel">Returns:</span></dt>
  317. <dd>List of String, ID array returned by insert interface</dd>
  318. <dt><span class="throwsLabel">Throws:</span></dt>
  319. <dd><code><a href="../exception/ParamException.html" title="class in io.milvus.exception">ParamException</a></code></dd>
  320. </dl>
  321. </li>
  322. </ul>
  323. <a id="getInsertIDs()">
  324. <!-- -->
  325. </a>
  326. <ul class="blockList">
  327. <li class="blockList">
  328. <h4>getInsertIDs</h4>
  329. <pre class="methodSignature">public&nbsp;java.util.List&lt;?&gt;&nbsp;getInsertIDs()</pre>
  330. <div class="block">Gets the ID array from returned by insert interface.</div>
  331. <dl>
  332. <dt><span class="returnLabel">Returns:</span></dt>
  333. <dd>List of Ids, ID array returned by insert interface</dd>
  334. </dl>
  335. </li>
  336. </ul>
  337. <a id="getDeleteIDs()">
  338. <!-- -->
  339. </a>
  340. <ul class="blockList">
  341. <li class="blockList">
  342. <h4>getDeleteIDs</h4>
  343. <pre class="methodSignature">public&nbsp;java.util.List&lt;?&gt;&nbsp;getDeleteIDs()</pre>
  344. <div class="block">Gets the ID array from returned by delete interface.</div>
  345. <dl>
  346. <dt><span class="returnLabel">Returns:</span></dt>
  347. <dd>List of Ids, ID array returned by delete interface</dd>
  348. </dl>
  349. </li>
  350. </ul>
  351. <a id="getDeleteCount()">
  352. <!-- -->
  353. </a>
  354. <ul class="blockList">
  355. <li class="blockList">
  356. <h4>getDeleteCount</h4>
  357. <pre class="methodSignature">public&nbsp;long&nbsp;getDeleteCount()</pre>
  358. <div class="block">Gets the row count of the deleted entities. Currently, this value is always equal to input row count</div>
  359. <dl>
  360. <dt><span class="returnLabel">Returns:</span></dt>
  361. <dd><code>int</code> row count of the deleted entities</dd>
  362. </dl>
  363. </li>
  364. </ul>
  365. <a id="getOperationTs()">
  366. <!-- -->
  367. </a>
  368. <ul class="blockListLast">
  369. <li class="blockList">
  370. <h4>getOperationTs</h4>
  371. <pre class="methodSignature">public&nbsp;long&nbsp;getOperationTs()</pre>
  372. <div class="block">Get timestamp of the operation marked by server. You can use this timestamp as for guarantee timestamp of query/search api.
  373. Note: the timestamp is not an absolute timestamp, it is a hybrid value combined by UTC time and internal flags.
  374. We call it TSO, for more information: @see <a href="https://github.com/milvus-io/milvus/blob/master/docs/design_docs/milvus_hybrid_ts_en.md">Hybrid Timestamp in Milvus</a></div>
  375. <dl>
  376. <dt><span class="returnLabel">Returns:</span></dt>
  377. <dd><code>int</code> row count of the deleted entities</dd>
  378. </dl>
  379. </li>
  380. </ul>
  381. </li>
  382. </ul>
  383. </section>
  384. </li>
  385. </ul>
  386. </div>
  387. </div>
  388. </main>
  389. <!-- ========= END OF CLASS DATA ========= -->
  390. <footer role="contentinfo">
  391. <nav role="navigation">
  392. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  393. <div class="bottomNav"><a id="navbar.bottom">
  394. <!-- -->
  395. </a>
  396. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  397. <a id="navbar.bottom.firstrow">
  398. <!-- -->
  399. </a>
  400. <ul class="navList" title="Navigation">
  401. <li><a href="../../../index.html">Overview</a></li>
  402. <li><a href="package-summary.html">Package</a></li>
  403. <li class="navBarCell1Rev">Class</li>
  404. <li><a href="package-tree.html">Tree</a></li>
  405. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  406. <li><a href="../../../index-files/index-1.html">Index</a></li>
  407. <li><a href="../../../help-doc.html">Help</a></li>
  408. </ul>
  409. </div>
  410. <div class="subNav">
  411. <ul class="navList" id="allclasses_navbar_bottom">
  412. <li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
  413. </ul>
  414. <div>
  415. <script type="text/javascript"><!--
  416. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  417. if(window==top) {
  418. allClassesLink.style.display = "block";
  419. }
  420. else {
  421. allClassesLink.style.display = "none";
  422. }
  423. //-->
  424. </script>
  425. <noscript>
  426. <div>JavaScript is disabled on your browser.</div>
  427. </noscript>
  428. </div>
  429. <div>
  430. <ul class="subNavList">
  431. <li>Summary:&nbsp;</li>
  432. <li>Nested&nbsp;|&nbsp;</li>
  433. <li>Field&nbsp;|&nbsp;</li>
  434. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  435. <li><a href="#method.summary">Method</a></li>
  436. </ul>
  437. <ul class="subNavList">
  438. <li>Detail:&nbsp;</li>
  439. <li>Field&nbsp;|&nbsp;</li>
  440. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  441. <li><a href="#method.detail">Method</a></li>
  442. </ul>
  443. </div>
  444. <a id="skip.navbar.bottom">
  445. <!-- -->
  446. </a></div>
  447. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  448. </nav>
  449. </footer>
  450. </body>
  451. </html>