DescCollResponseWrapper.html 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (1.8.0_402-402) on Fri Oct 18 12:22:14 CST 2024 -->
  6. <title>DescCollResponseWrapper</title>
  7. <meta name="date" content="2024-10-18">
  8. <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
  9. <script type="text/javascript" src="../../../script.js"></script>
  10. </head>
  11. <body>
  12. <script type="text/javascript"><!--
  13. try {
  14. if (location.href.indexOf('is-external=true') == -1) {
  15. parent.document.title="DescCollResponseWrapper";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":42,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":42,"i18":10,"i19":10,"i20":10};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
  23. var altColor = "altColor";
  24. var rowColor = "rowColor";
  25. var tableTab = "tableTab";
  26. var activeTableTab = "activeTableTab";
  27. </script>
  28. <noscript>
  29. <div>JavaScript is disabled on your browser.</div>
  30. </noscript>
  31. <!-- ========= START OF TOP NAVBAR ======= -->
  32. <div class="topNav"><a name="navbar.top">
  33. <!-- -->
  34. </a>
  35. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  36. <a name="navbar.top.firstrow">
  37. <!-- -->
  38. </a>
  39. <ul class="navList" title="Navigation">
  40. <li><a href="../../../overview-summary.html">Overview</a></li>
  41. <li><a href="package-summary.html">Package</a></li>
  42. <li class="navBarCell1Rev">Class</li>
  43. <li><a href="package-tree.html">Tree</a></li>
  44. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  45. <li><a href="../../../index-files/index-1.html">Index</a></li>
  46. <li><a href="../../../help-doc.html">Help</a></li>
  47. </ul>
  48. </div>
  49. <div class="subNav">
  50. <ul class="navList">
  51. <li><a href="../../../io/milvus/response/BulkInsertResponseWrapper.html" title="class in io.milvus.response"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  52. <li><a href="../../../io/milvus/response/DescDBResponseWrapper.html" title="class in io.milvus.response"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  53. </ul>
  54. <ul class="navList">
  55. <li><a href="../../../index.html?io/milvus/response/DescCollResponseWrapper.html" target="_top">Frames</a></li>
  56. <li><a href="DescCollResponseWrapper.html" target="_top">No&nbsp;Frames</a></li>
  57. </ul>
  58. <ul class="navList" id="allclasses_navbar_top">
  59. <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  60. </ul>
  61. <div>
  62. <script type="text/javascript"><!--
  63. allClassesLink = document.getElementById("allclasses_navbar_top");
  64. if(window==top) {
  65. allClassesLink.style.display = "block";
  66. }
  67. else {
  68. allClassesLink.style.display = "none";
  69. }
  70. //-->
  71. </script>
  72. </div>
  73. <div>
  74. <ul class="subNavList">
  75. <li>Summary:&nbsp;</li>
  76. <li>Nested&nbsp;|&nbsp;</li>
  77. <li>Field&nbsp;|&nbsp;</li>
  78. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  79. <li><a href="#method.summary">Method</a></li>
  80. </ul>
  81. <ul class="subNavList">
  82. <li>Detail:&nbsp;</li>
  83. <li>Field&nbsp;|&nbsp;</li>
  84. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  85. <li><a href="#method.detail">Method</a></li>
  86. </ul>
  87. </div>
  88. <a name="skip.navbar.top">
  89. <!-- -->
  90. </a></div>
  91. <!-- ========= END OF TOP NAVBAR ========= -->
  92. <!-- ======== START OF CLASS DATA ======== -->
  93. <div class="header">
  94. <div class="subTitle">io.milvus.response</div>
  95. <h2 title="Class DescCollResponseWrapper" class="title">Class DescCollResponseWrapper</h2>
  96. </div>
  97. <div class="contentContainer">
  98. <ul class="inheritance">
  99. <li>java.lang.Object</li>
  100. <li>
  101. <ul class="inheritance">
  102. <li>io.milvus.response.DescCollResponseWrapper</li>
  103. </ul>
  104. </li>
  105. </ul>
  106. <div class="description">
  107. <ul class="blockList">
  108. <li class="blockList">
  109. <hr>
  110. <br>
  111. <pre>public class <span class="typeNameLabel">DescCollResponseWrapper</span>
  112. extends java.lang.Object</pre>
  113. <div class="block">Util class to wrap response of <code>describeCollection</code> interface.</div>
  114. </li>
  115. </ul>
  116. </div>
  117. <div class="summary">
  118. <ul class="blockList">
  119. <li class="blockList">
  120. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  121. <ul class="blockList">
  122. <li class="blockList"><a name="constructor.summary">
  123. <!-- -->
  124. </a>
  125. <h3>Constructor Summary</h3>
  126. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  127. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  128. <tr>
  129. <th class="colOne" scope="col">Constructor and Description</th>
  130. </tr>
  131. <tr class="altColor">
  132. <td class="colOne"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#DescCollResponseWrapper-io.milvus.grpc.DescribeCollectionResponse-">DescCollResponseWrapper</a></span>(@NonNull io.milvus.grpc.DescribeCollectionResponse&nbsp;response)</code>&nbsp;</td>
  133. </tr>
  134. </table>
  135. </li>
  136. </ul>
  137. <!-- ========== METHOD SUMMARY =========== -->
  138. <ul class="blockList">
  139. <li class="blockList"><a name="method.summary">
  140. <!-- -->
  141. </a>
  142. <h3>Method Summary</h3>
  143. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  144. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  145. <tr>
  146. <th class="colFirst" scope="col">Modifier and Type</th>
  147. <th class="colLast" scope="col">Method and Description</th>
  148. </tr>
  149. <tr id="i0" class="altColor">
  150. <td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td>
  151. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#getAliases--">getAliases</a></span>()</code>
  152. <div class="block">Get aliases of the collection.</div>
  153. </td>
  154. </tr>
  155. <tr id="i1" class="rowColor">
  156. <td class="colFirst"><code>java.lang.String</code></td>
  157. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#getCollectionDescription--">getCollectionDescription</a></span>()</code>
  158. <div class="block">Get description of the collection.</div>
  159. </td>
  160. </tr>
  161. <tr id="i2" class="altColor">
  162. <td class="colFirst"><code>long</code></td>
  163. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#getCollectionID--">getCollectionID</a></span>()</code>
  164. <div class="block">Get internal id of the collection.</div>
  165. </td>
  166. </tr>
  167. <tr id="i3" class="rowColor">
  168. <td class="colFirst"><code>java.lang.String</code></td>
  169. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#getCollectionName--">getCollectionName</a></span>()</code>
  170. <div class="block">Get name of the collection.</div>
  171. </td>
  172. </tr>
  173. <tr id="i4" class="altColor">
  174. <td class="colFirst"><code><a href="../../../io/milvus/common/clientenum/ConsistencyLevelEnum.html" title="enum in io.milvus.common.clientenum">ConsistencyLevelEnum</a></code></td>
  175. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#getConsistencyLevel--">getConsistencyLevel</a></span>()</code>
  176. <div class="block">Get consistency level of the collection.</div>
  177. </td>
  178. </tr>
  179. <tr id="i5" class="rowColor">
  180. <td class="colFirst"><code>long</code></td>
  181. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#getCreatedUtcTimestamp--">getCreatedUtcTimestamp</a></span>()</code>
  182. <div class="block">Get utc timestamp when collection created.</div>
  183. </td>
  184. </tr>
  185. <tr id="i6" class="altColor">
  186. <td class="colFirst"><code>java.lang.String</code></td>
  187. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#getDatabaseName--">getDatabaseName</a></span>()</code>
  188. <div class="block">Get database name of the collection.</div>
  189. </td>
  190. </tr>
  191. <tr id="i7" class="rowColor">
  192. <td class="colFirst"><code>boolean</code></td>
  193. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#getEnableDynamicField--">getEnableDynamicField</a></span>()</code>
  194. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
  195. </td>
  196. </tr>
  197. <tr id="i8" class="altColor">
  198. <td class="colFirst"><code><a href="../../../io/milvus/param/collection/FieldType.html" title="class in io.milvus.param.collection">FieldType</a></code></td>
  199. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#getFieldByName-java.lang.String-">getFieldByName</a></span>(@NonNull java.lang.String&nbsp;fieldName)</code>
  200. <div class="block">Get schema of a field by name.</div>
  201. </td>
  202. </tr>
  203. <tr id="i9" class="rowColor">
  204. <td class="colFirst"><code>java.util.List&lt;<a href="../../../io/milvus/param/collection/FieldType.html" title="class in io.milvus.param.collection">FieldType</a>&gt;</code></td>
  205. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#getFields--">getFields</a></span>()</code>
  206. <div class="block">Get schema of the collection's fields.</div>
  207. </td>
  208. </tr>
  209. <tr id="i10" class="altColor">
  210. <td class="colFirst"><code><a href="../../../io/milvus/param/collection/FieldType.html" title="class in io.milvus.param.collection">FieldType</a></code></td>
  211. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#getPartitionKeyField--">getPartitionKeyField</a></span>()</code>
  212. <div class="block">Get the partition key field.</div>
  213. </td>
  214. </tr>
  215. <tr id="i11" class="rowColor">
  216. <td class="colFirst"><code><a href="../../../io/milvus/param/collection/FieldType.html" title="class in io.milvus.param.collection">FieldType</a></code></td>
  217. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#getPrimaryField--">getPrimaryField</a></span>()</code>
  218. <div class="block">Get the primary key field.</div>
  219. </td>
  220. </tr>
  221. <tr id="i12" class="altColor">
  222. <td class="colFirst"><code>java.util.Map&lt;java.lang.String,java.lang.String&gt;</code></td>
  223. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#getProperties--">getProperties</a></span>()</code>
  224. <div class="block">Get properties of the collection.</div>
  225. </td>
  226. </tr>
  227. <tr id="i13" class="rowColor">
  228. <td class="colFirst"><code>int</code></td>
  229. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#getReplicaNumber--">getReplicaNumber</a></span>()</code>
  230. <div class="block">return collection replica number</div>
  231. </td>
  232. </tr>
  233. <tr id="i14" class="altColor">
  234. <td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td>
  235. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#getResourceGroups--">getResourceGroups</a></span>()</code>
  236. <div class="block">return collection resource groups</div>
  237. </td>
  238. </tr>
  239. <tr id="i15" class="rowColor">
  240. <td class="colFirst"><code><a href="../../../io/milvus/param/collection/CollectionSchemaParam.html" title="class in io.milvus.param.collection">CollectionSchemaParam</a></code></td>
  241. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#getSchema--">getSchema</a></span>()</code>
  242. <div class="block">Get the collection schema of collection</div>
  243. </td>
  244. </tr>
  245. <tr id="i16" class="altColor">
  246. <td class="colFirst"><code>int</code></td>
  247. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#getShardNumber--">getShardNumber</a></span>()</code>
  248. <div class="block">Get shard number of the collection.</div>
  249. </td>
  250. </tr>
  251. <tr id="i17" class="rowColor">
  252. <td class="colFirst"><code><a href="../../../io/milvus/param/collection/FieldType.html" title="class in io.milvus.param.collection">FieldType</a></code></td>
  253. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#getVectorField--">getVectorField</a></span>()</code>
  254. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
  255. </td>
  256. </tr>
  257. <tr id="i18" class="altColor">
  258. <td class="colFirst"><code>java.util.List&lt;<a href="../../../io/milvus/param/collection/FieldType.html" title="class in io.milvus.param.collection">FieldType</a>&gt;</code></td>
  259. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#getVectorFields--">getVectorFields</a></span>()</code>
  260. <div class="block">Get all the vector key field.</div>
  261. </td>
  262. </tr>
  263. <tr id="i19" class="rowColor">
  264. <td class="colFirst"><code>boolean</code></td>
  265. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#isDynamicFieldEnabled--">isDynamicFieldEnabled</a></span>()</code>
  266. <div class="block">Get whether the collection dynamic field is enabled</div>
  267. </td>
  268. </tr>
  269. <tr id="i20" class="altColor">
  270. <td class="colFirst"><code>java.lang.String</code></td>
  271. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#toString--">toString</a></span>()</code>
  272. <div class="block">Construct a <code>String</code> by <a href="../../../io/milvus/response/DescCollResponseWrapper.html" title="class in io.milvus.response"><code>DescCollResponseWrapper</code></a> instance.</div>
  273. </td>
  274. </tr>
  275. </table>
  276. <ul class="blockList">
  277. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  278. <!-- -->
  279. </a>
  280. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  281. <code>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
  282. </ul>
  283. </li>
  284. </ul>
  285. </li>
  286. </ul>
  287. </div>
  288. <div class="details">
  289. <ul class="blockList">
  290. <li class="blockList">
  291. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  292. <ul class="blockList">
  293. <li class="blockList"><a name="constructor.detail">
  294. <!-- -->
  295. </a>
  296. <h3>Constructor Detail</h3>
  297. <a name="DescCollResponseWrapper-io.milvus.grpc.DescribeCollectionResponse-">
  298. <!-- -->
  299. </a>
  300. <ul class="blockListLast">
  301. <li class="blockList">
  302. <h4>DescCollResponseWrapper</h4>
  303. <pre>public&nbsp;DescCollResponseWrapper(@NonNull
  304. @NonNull io.milvus.grpc.DescribeCollectionResponse&nbsp;response)</pre>
  305. </li>
  306. </ul>
  307. </li>
  308. </ul>
  309. <!-- ============ METHOD DETAIL ========== -->
  310. <ul class="blockList">
  311. <li class="blockList"><a name="method.detail">
  312. <!-- -->
  313. </a>
  314. <h3>Method Detail</h3>
  315. <a name="getCollectionName--">
  316. <!-- -->
  317. </a>
  318. <ul class="blockList">
  319. <li class="blockList">
  320. <h4>getCollectionName</h4>
  321. <pre>public&nbsp;java.lang.String&nbsp;getCollectionName()</pre>
  322. <div class="block">Get name of the collection.</div>
  323. <dl>
  324. <dt><span class="returnLabel">Returns:</span></dt>
  325. <dd><code>String</code> name of the collection</dd>
  326. </dl>
  327. </li>
  328. </ul>
  329. <a name="getDatabaseName--">
  330. <!-- -->
  331. </a>
  332. <ul class="blockList">
  333. <li class="blockList">
  334. <h4>getDatabaseName</h4>
  335. <pre>public&nbsp;java.lang.String&nbsp;getDatabaseName()</pre>
  336. <div class="block">Get database name of the collection.</div>
  337. <dl>
  338. <dt><span class="returnLabel">Returns:</span></dt>
  339. <dd><code>String</code> name of the database</dd>
  340. </dl>
  341. </li>
  342. </ul>
  343. <a name="getCollectionDescription--">
  344. <!-- -->
  345. </a>
  346. <ul class="blockList">
  347. <li class="blockList">
  348. <h4>getCollectionDescription</h4>
  349. <pre>public&nbsp;java.lang.String&nbsp;getCollectionDescription()</pre>
  350. <div class="block">Get description of the collection.</div>
  351. <dl>
  352. <dt><span class="returnLabel">Returns:</span></dt>
  353. <dd><code>String</code> description of the collection</dd>
  354. </dl>
  355. </li>
  356. </ul>
  357. <a name="getCollectionID--">
  358. <!-- -->
  359. </a>
  360. <ul class="blockList">
  361. <li class="blockList">
  362. <h4>getCollectionID</h4>
  363. <pre>public&nbsp;long&nbsp;getCollectionID()</pre>
  364. <div class="block">Get internal id of the collection.</div>
  365. <dl>
  366. <dt><span class="returnLabel">Returns:</span></dt>
  367. <dd><code>long</code> internal id of the collection</dd>
  368. </dl>
  369. </li>
  370. </ul>
  371. <a name="getShardNumber--">
  372. <!-- -->
  373. </a>
  374. <ul class="blockList">
  375. <li class="blockList">
  376. <h4>getShardNumber</h4>
  377. <pre>public&nbsp;int&nbsp;getShardNumber()</pre>
  378. <div class="block">Get shard number of the collection.</div>
  379. <dl>
  380. <dt><span class="returnLabel">Returns:</span></dt>
  381. <dd><code>int</code> shard number of the collection</dd>
  382. </dl>
  383. </li>
  384. </ul>
  385. <a name="getConsistencyLevel--">
  386. <!-- -->
  387. </a>
  388. <ul class="blockList">
  389. <li class="blockList">
  390. <h4>getConsistencyLevel</h4>
  391. <pre>public&nbsp;<a href="../../../io/milvus/common/clientenum/ConsistencyLevelEnum.html" title="enum in io.milvus.common.clientenum">ConsistencyLevelEnum</a>&nbsp;getConsistencyLevel()</pre>
  392. <div class="block">Get consistency level of the collection.</div>
  393. <dl>
  394. <dt><span class="returnLabel">Returns:</span></dt>
  395. <dd><code>ConsistencyLevelEnum</code> consistency level of the collection</dd>
  396. </dl>
  397. </li>
  398. </ul>
  399. <a name="getCreatedUtcTimestamp--">
  400. <!-- -->
  401. </a>
  402. <ul class="blockList">
  403. <li class="blockList">
  404. <h4>getCreatedUtcTimestamp</h4>
  405. <pre>public&nbsp;long&nbsp;getCreatedUtcTimestamp()</pre>
  406. <div class="block">Get utc timestamp when collection created.</div>
  407. <dl>
  408. <dt><span class="returnLabel">Returns:</span></dt>
  409. <dd><code>long</code> utc timestamp when collection created</dd>
  410. </dl>
  411. </li>
  412. </ul>
  413. <a name="getAliases--">
  414. <!-- -->
  415. </a>
  416. <ul class="blockList">
  417. <li class="blockList">
  418. <h4>getAliases</h4>
  419. <pre>public&nbsp;java.util.List&lt;java.lang.String&gt;&nbsp;getAliases()</pre>
  420. <div class="block">Get aliases of the collection.</div>
  421. <dl>
  422. <dt><span class="returnLabel">Returns:</span></dt>
  423. <dd>List of String, aliases of the collection</dd>
  424. </dl>
  425. </li>
  426. </ul>
  427. <a name="getFields--">
  428. <!-- -->
  429. </a>
  430. <ul class="blockList">
  431. <li class="blockList">
  432. <h4>getFields</h4>
  433. <pre>public&nbsp;java.util.List&lt;<a href="../../../io/milvus/param/collection/FieldType.html" title="class in io.milvus.param.collection">FieldType</a>&gt;&nbsp;getFields()</pre>
  434. <div class="block">Get schema of the collection's fields.</div>
  435. <dl>
  436. <dt><span class="returnLabel">Returns:</span></dt>
  437. <dd>List of FieldType, schema of the collection's fields</dd>
  438. </dl>
  439. </li>
  440. </ul>
  441. <a name="getFieldByName-java.lang.String-">
  442. <!-- -->
  443. </a>
  444. <ul class="blockList">
  445. <li class="blockList">
  446. <h4>getFieldByName</h4>
  447. <pre>public&nbsp;<a href="../../../io/milvus/param/collection/FieldType.html" title="class in io.milvus.param.collection">FieldType</a>&nbsp;getFieldByName(@NonNull
  448. @NonNull java.lang.String&nbsp;fieldName)</pre>
  449. <div class="block">Get schema of a field by name.
  450. Return null if the field doesn't exist</div>
  451. <dl>
  452. <dt><span class="paramLabel">Parameters:</span></dt>
  453. <dd><code>fieldName</code> - field name to get field description</dd>
  454. <dt><span class="returnLabel">Returns:</span></dt>
  455. <dd><a href="../../../io/milvus/param/collection/FieldType.html" title="class in io.milvus.param.collection"><code>FieldType</code></a> schema of the field</dd>
  456. </dl>
  457. </li>
  458. </ul>
  459. <a name="getEnableDynamicField--">
  460. <!-- -->
  461. </a>
  462. <ul class="blockList">
  463. <li class="blockList">
  464. <h4>getEnableDynamicField</h4>
  465. <pre>@Deprecated
  466. public&nbsp;boolean&nbsp;getEnableDynamicField()</pre>
  467. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
  468. </li>
  469. </ul>
  470. <a name="isDynamicFieldEnabled--">
  471. <!-- -->
  472. </a>
  473. <ul class="blockList">
  474. <li class="blockList">
  475. <h4>isDynamicFieldEnabled</h4>
  476. <pre>public&nbsp;boolean&nbsp;isDynamicFieldEnabled()</pre>
  477. <div class="block">Get whether the collection dynamic field is enabled</div>
  478. <dl>
  479. <dt><span class="returnLabel">Returns:</span></dt>
  480. <dd>boolean</dd>
  481. </dl>
  482. </li>
  483. </ul>
  484. <a name="getPartitionKeyField--">
  485. <!-- -->
  486. </a>
  487. <ul class="blockList">
  488. <li class="blockList">
  489. <h4>getPartitionKeyField</h4>
  490. <pre>public&nbsp;<a href="../../../io/milvus/param/collection/FieldType.html" title="class in io.milvus.param.collection">FieldType</a>&nbsp;getPartitionKeyField()</pre>
  491. <div class="block">Get the partition key field.
  492. Return null if the partition key field doesn't exist.</div>
  493. <dl>
  494. <dt><span class="returnLabel">Returns:</span></dt>
  495. <dd><a href="../../../io/milvus/param/collection/FieldType.html" title="class in io.milvus.param.collection"><code>FieldType</code></a> schema of the partition key field</dd>
  496. </dl>
  497. </li>
  498. </ul>
  499. <a name="getPrimaryField--">
  500. <!-- -->
  501. </a>
  502. <ul class="blockList">
  503. <li class="blockList">
  504. <h4>getPrimaryField</h4>
  505. <pre>public&nbsp;<a href="../../../io/milvus/param/collection/FieldType.html" title="class in io.milvus.param.collection">FieldType</a>&nbsp;getPrimaryField()</pre>
  506. <div class="block">Get the primary key field.
  507. throw ParamException if the primary key field doesn't exist.</div>
  508. <dl>
  509. <dt><span class="returnLabel">Returns:</span></dt>
  510. <dd><a href="../../../io/milvus/param/collection/FieldType.html" title="class in io.milvus.param.collection"><code>FieldType</code></a> schema of the primary key field</dd>
  511. </dl>
  512. </li>
  513. </ul>
  514. <a name="getVectorField--">
  515. <!-- -->
  516. </a>
  517. <ul class="blockList">
  518. <li class="blockList">
  519. <h4>getVectorField</h4>
  520. <pre>@Deprecated
  521. public&nbsp;<a href="../../../io/milvus/param/collection/FieldType.html" title="class in io.milvus.param.collection">FieldType</a>&nbsp;getVectorField()</pre>
  522. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
  523. <div class="block">Get the vector key field.
  524. throw ParamException if the vector key field doesn't exist.
  525. This method is deprecated since Milvus supports multiple vector fields from v2.4</div>
  526. <dl>
  527. <dt><span class="returnLabel">Returns:</span></dt>
  528. <dd><a href="../../../io/milvus/param/collection/FieldType.html" title="class in io.milvus.param.collection"><code>FieldType</code></a> schema of the vector key field</dd>
  529. </dl>
  530. </li>
  531. </ul>
  532. <a name="getVectorFields--">
  533. <!-- -->
  534. </a>
  535. <ul class="blockList">
  536. <li class="blockList">
  537. <h4>getVectorFields</h4>
  538. <pre>public&nbsp;java.util.List&lt;<a href="../../../io/milvus/param/collection/FieldType.html" title="class in io.milvus.param.collection">FieldType</a>&gt;&nbsp;getVectorFields()</pre>
  539. <div class="block">Get all the vector key field. (Milvus supports multiple vector fields from v2.4)</div>
  540. <dl>
  541. <dt><span class="returnLabel">Returns:</span></dt>
  542. <dd><a href="../../../io/milvus/param/collection/FieldType.html" title="class in io.milvus.param.collection"><code>FieldType</code></a> schema of the vector key field</dd>
  543. </dl>
  544. </li>
  545. </ul>
  546. <a name="getProperties--">
  547. <!-- -->
  548. </a>
  549. <ul class="blockList">
  550. <li class="blockList">
  551. <h4>getProperties</h4>
  552. <pre>public&nbsp;java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;getProperties()</pre>
  553. <div class="block">Get properties of the collection.</div>
  554. <dl>
  555. <dt><span class="returnLabel">Returns:</span></dt>
  556. <dd>List of String, aliases of the collection</dd>
  557. </dl>
  558. </li>
  559. </ul>
  560. <a name="getSchema--">
  561. <!-- -->
  562. </a>
  563. <ul class="blockList">
  564. <li class="blockList">
  565. <h4>getSchema</h4>
  566. <pre>public&nbsp;<a href="../../../io/milvus/param/collection/CollectionSchemaParam.html" title="class in io.milvus.param.collection">CollectionSchemaParam</a>&nbsp;getSchema()</pre>
  567. <div class="block">Get the collection schema of collection</div>
  568. <dl>
  569. <dt><span class="returnLabel">Returns:</span></dt>
  570. <dd><a href="../../../io/milvus/param/collection/CollectionSchemaParam.html" title="class in io.milvus.param.collection"><code>CollectionSchemaParam</code></a> schema of the collection</dd>
  571. </dl>
  572. </li>
  573. </ul>
  574. <a name="getResourceGroups--">
  575. <!-- -->
  576. </a>
  577. <ul class="blockList">
  578. <li class="blockList">
  579. <h4>getResourceGroups</h4>
  580. <pre>public&nbsp;java.util.List&lt;java.lang.String&gt;&nbsp;getResourceGroups()</pre>
  581. <div class="block">return collection resource groups</div>
  582. <dl>
  583. <dt><span class="returnLabel">Returns:</span></dt>
  584. <dd>resource group names</dd>
  585. </dl>
  586. </li>
  587. </ul>
  588. <a name="getReplicaNumber--">
  589. <!-- -->
  590. </a>
  591. <ul class="blockList">
  592. <li class="blockList">
  593. <h4>getReplicaNumber</h4>
  594. <pre>public&nbsp;int&nbsp;getReplicaNumber()</pre>
  595. <div class="block">return collection replica number</div>
  596. <dl>
  597. <dt><span class="returnLabel">Returns:</span></dt>
  598. <dd>replica number</dd>
  599. </dl>
  600. </li>
  601. </ul>
  602. <a name="toString--">
  603. <!-- -->
  604. </a>
  605. <ul class="blockListLast">
  606. <li class="blockList">
  607. <h4>toString</h4>
  608. <pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
  609. <div class="block">Construct a <code>String</code> by <a href="../../../io/milvus/response/DescCollResponseWrapper.html" title="class in io.milvus.response"><code>DescCollResponseWrapper</code></a> instance.</div>
  610. <dl>
  611. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  612. <dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  613. <dt><span class="returnLabel">Returns:</span></dt>
  614. <dd><code>String</code></dd>
  615. </dl>
  616. </li>
  617. </ul>
  618. </li>
  619. </ul>
  620. </li>
  621. </ul>
  622. </div>
  623. </div>
  624. <!-- ========= END OF CLASS DATA ========= -->
  625. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  626. <div class="bottomNav"><a name="navbar.bottom">
  627. <!-- -->
  628. </a>
  629. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  630. <a name="navbar.bottom.firstrow">
  631. <!-- -->
  632. </a>
  633. <ul class="navList" title="Navigation">
  634. <li><a href="../../../overview-summary.html">Overview</a></li>
  635. <li><a href="package-summary.html">Package</a></li>
  636. <li class="navBarCell1Rev">Class</li>
  637. <li><a href="package-tree.html">Tree</a></li>
  638. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  639. <li><a href="../../../index-files/index-1.html">Index</a></li>
  640. <li><a href="../../../help-doc.html">Help</a></li>
  641. </ul>
  642. </div>
  643. <div class="subNav">
  644. <ul class="navList">
  645. <li><a href="../../../io/milvus/response/BulkInsertResponseWrapper.html" title="class in io.milvus.response"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  646. <li><a href="../../../io/milvus/response/DescDBResponseWrapper.html" title="class in io.milvus.response"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  647. </ul>
  648. <ul class="navList">
  649. <li><a href="../../../index.html?io/milvus/response/DescCollResponseWrapper.html" target="_top">Frames</a></li>
  650. <li><a href="DescCollResponseWrapper.html" target="_top">No&nbsp;Frames</a></li>
  651. </ul>
  652. <ul class="navList" id="allclasses_navbar_bottom">
  653. <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  654. </ul>
  655. <div>
  656. <script type="text/javascript"><!--
  657. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  658. if(window==top) {
  659. allClassesLink.style.display = "block";
  660. }
  661. else {
  662. allClassesLink.style.display = "none";
  663. }
  664. //-->
  665. </script>
  666. </div>
  667. <div>
  668. <ul class="subNavList">
  669. <li>Summary:&nbsp;</li>
  670. <li>Nested&nbsp;|&nbsp;</li>
  671. <li>Field&nbsp;|&nbsp;</li>
  672. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  673. <li><a href="#method.summary">Method</a></li>
  674. </ul>
  675. <ul class="subNavList">
  676. <li>Detail:&nbsp;</li>
  677. <li>Field&nbsp;|&nbsp;</li>
  678. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  679. <li><a href="#method.detail">Method</a></li>
  680. </ul>
  681. </div>
  682. <a name="skip.navbar.bottom">
  683. <!-- -->
  684. </a></div>
  685. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  686. </body>
  687. </html>