DescDBResponseWrapper.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360
  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>DescDBResponseWrapper</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="DescDBResponseWrapper";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/DescCollResponseWrapper.html" title="class in io.milvus.response"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  52. <li><a href="../../../io/milvus/response/DescIndexResponseWrapper.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/DescDBResponseWrapper.html" target="_top">Frames</a></li>
  56. <li><a href="DescDBResponseWrapper.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 DescDBResponseWrapper" class="title">Class DescDBResponseWrapper</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.DescDBResponseWrapper</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">DescDBResponseWrapper</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/DescDBResponseWrapper.html#DescDBResponseWrapper-io.milvus.grpc.DescribeDatabaseResponse-">DescDBResponseWrapper</a></span>(@NonNull io.milvus.grpc.DescribeDatabaseResponse&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></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.lang.String</code></td>
  151. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescDBResponseWrapper.html#getDatabaseName--">getDatabaseName</a></span>()</code>
  152. <div class="block">get database name</div>
  153. </td>
  154. </tr>
  155. <tr id="i1" class="rowColor">
  156. <td class="colFirst"><code>java.util.Map&lt;java.lang.String,java.lang.String&gt;</code></td>
  157. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescDBResponseWrapper.html#getProperties--">getProperties</a></span>()</code>
  158. <div class="block">Get properties of the collection.</div>
  159. </td>
  160. </tr>
  161. <tr id="i2" class="altColor">
  162. <td class="colFirst"><code>int</code></td>
  163. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescDBResponseWrapper.html#getReplicaNumber--">getReplicaNumber</a></span>()</code>
  164. <div class="block">return database replica number</div>
  165. </td>
  166. </tr>
  167. <tr id="i3" class="rowColor">
  168. <td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td>
  169. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescDBResponseWrapper.html#getResourceGroups--">getResourceGroups</a></span>()</code>
  170. <div class="block">return database resource groups</div>
  171. </td>
  172. </tr>
  173. <tr id="i4" class="altColor">
  174. <td class="colFirst"><code>java.lang.String</code></td>
  175. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescDBResponseWrapper.html#toString--">toString</a></span>()</code>
  176. <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>
  177. </td>
  178. </tr>
  179. </table>
  180. <ul class="blockList">
  181. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  182. <!-- -->
  183. </a>
  184. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  185. <code>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
  186. </ul>
  187. </li>
  188. </ul>
  189. </li>
  190. </ul>
  191. </div>
  192. <div class="details">
  193. <ul class="blockList">
  194. <li class="blockList">
  195. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  196. <ul class="blockList">
  197. <li class="blockList"><a name="constructor.detail">
  198. <!-- -->
  199. </a>
  200. <h3>Constructor Detail</h3>
  201. <a name="DescDBResponseWrapper-io.milvus.grpc.DescribeDatabaseResponse-">
  202. <!-- -->
  203. </a>
  204. <ul class="blockListLast">
  205. <li class="blockList">
  206. <h4>DescDBResponseWrapper</h4>
  207. <pre>public&nbsp;DescDBResponseWrapper(@NonNull
  208. @NonNull io.milvus.grpc.DescribeDatabaseResponse&nbsp;response)</pre>
  209. </li>
  210. </ul>
  211. </li>
  212. </ul>
  213. <!-- ============ METHOD DETAIL ========== -->
  214. <ul class="blockList">
  215. <li class="blockList"><a name="method.detail">
  216. <!-- -->
  217. </a>
  218. <h3>Method Detail</h3>
  219. <a name="getDatabaseName--">
  220. <!-- -->
  221. </a>
  222. <ul class="blockList">
  223. <li class="blockList">
  224. <h4>getDatabaseName</h4>
  225. <pre>public&nbsp;java.lang.String&nbsp;getDatabaseName()</pre>
  226. <div class="block">get database name</div>
  227. <dl>
  228. <dt><span class="returnLabel">Returns:</span></dt>
  229. <dd>database name</dd>
  230. </dl>
  231. </li>
  232. </ul>
  233. <a name="getProperties--">
  234. <!-- -->
  235. </a>
  236. <ul class="blockList">
  237. <li class="blockList">
  238. <h4>getProperties</h4>
  239. <pre>public&nbsp;java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;getProperties()</pre>
  240. <div class="block">Get properties of the collection.</div>
  241. <dl>
  242. <dt><span class="returnLabel">Returns:</span></dt>
  243. <dd>map of key value pair</dd>
  244. </dl>
  245. </li>
  246. </ul>
  247. <a name="getResourceGroups--">
  248. <!-- -->
  249. </a>
  250. <ul class="blockList">
  251. <li class="blockList">
  252. <h4>getResourceGroups</h4>
  253. <pre>public&nbsp;java.util.List&lt;java.lang.String&gt;&nbsp;getResourceGroups()</pre>
  254. <div class="block">return database resource groups</div>
  255. <dl>
  256. <dt><span class="returnLabel">Returns:</span></dt>
  257. <dd>resource group names</dd>
  258. </dl>
  259. </li>
  260. </ul>
  261. <a name="getReplicaNumber--">
  262. <!-- -->
  263. </a>
  264. <ul class="blockList">
  265. <li class="blockList">
  266. <h4>getReplicaNumber</h4>
  267. <pre>public&nbsp;int&nbsp;getReplicaNumber()</pre>
  268. <div class="block">return database replica number</div>
  269. <dl>
  270. <dt><span class="returnLabel">Returns:</span></dt>
  271. <dd>database replica number</dd>
  272. </dl>
  273. </li>
  274. </ul>
  275. <a name="toString--">
  276. <!-- -->
  277. </a>
  278. <ul class="blockListLast">
  279. <li class="blockList">
  280. <h4>toString</h4>
  281. <pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
  282. <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>
  283. <dl>
  284. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  285. <dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  286. <dt><span class="returnLabel">Returns:</span></dt>
  287. <dd><code>String</code></dd>
  288. </dl>
  289. </li>
  290. </ul>
  291. </li>
  292. </ul>
  293. </li>
  294. </ul>
  295. </div>
  296. </div>
  297. <!-- ========= END OF CLASS DATA ========= -->
  298. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  299. <div class="bottomNav"><a name="navbar.bottom">
  300. <!-- -->
  301. </a>
  302. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  303. <a name="navbar.bottom.firstrow">
  304. <!-- -->
  305. </a>
  306. <ul class="navList" title="Navigation">
  307. <li><a href="../../../overview-summary.html">Overview</a></li>
  308. <li><a href="package-summary.html">Package</a></li>
  309. <li class="navBarCell1Rev">Class</li>
  310. <li><a href="package-tree.html">Tree</a></li>
  311. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  312. <li><a href="../../../index-files/index-1.html">Index</a></li>
  313. <li><a href="../../../help-doc.html">Help</a></li>
  314. </ul>
  315. </div>
  316. <div class="subNav">
  317. <ul class="navList">
  318. <li><a href="../../../io/milvus/response/DescCollResponseWrapper.html" title="class in io.milvus.response"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  319. <li><a href="../../../io/milvus/response/DescIndexResponseWrapper.html" title="class in io.milvus.response"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  320. </ul>
  321. <ul class="navList">
  322. <li><a href="../../../index.html?io/milvus/response/DescDBResponseWrapper.html" target="_top">Frames</a></li>
  323. <li><a href="DescDBResponseWrapper.html" target="_top">No&nbsp;Frames</a></li>
  324. </ul>
  325. <ul class="navList" id="allclasses_navbar_bottom">
  326. <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  327. </ul>
  328. <div>
  329. <script type="text/javascript"><!--
  330. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  331. if(window==top) {
  332. allClassesLink.style.display = "block";
  333. }
  334. else {
  335. allClassesLink.style.display = "none";
  336. }
  337. //-->
  338. </script>
  339. </div>
  340. <div>
  341. <ul class="subNavList">
  342. <li>Summary:&nbsp;</li>
  343. <li>Nested&nbsp;|&nbsp;</li>
  344. <li>Field&nbsp;|&nbsp;</li>
  345. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  346. <li><a href="#method.summary">Method</a></li>
  347. </ul>
  348. <ul class="subNavList">
  349. <li>Detail:&nbsp;</li>
  350. <li>Field&nbsp;|&nbsp;</li>
  351. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  352. <li><a href="#method.detail">Method</a></li>
  353. </ul>
  354. </div>
  355. <a name="skip.navbar.bottom">
  356. <!-- -->
  357. </a></div>
  358. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  359. </body>
  360. </html>