Главная Обзор Помощь
Вход
milvus
/
milvus-sdk-java
зеркало из https://github.com/milvus-io/milvus-sdk-java.git
2
0
Ответвить 0
Файлы Задачи 0 Вики
Дерево: 92d5d231aa
Ветки Метки
milvus-sdk-java
/
doc
/
io
/
milvus
/
param
/
collection
/
CreateCollectionParam.Builder.html

CreateCollectionParam.Builder.html 22 KB
История Исходник

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503 
  1. <!DOCTYPE HTML>
    2. 

  2. <!-- NewPage -->
    3. 

  3. <html lang="en">
    4. 

  4. <head>
    5. 

  5. <!-- Generated by javadoc (11.0.18) on Fri Oct 27 18:27:49 CST 2023 -->
    6. 

  6. <title>CreateCollectionParam.Builder</title>
    7. 

  7. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    8. 

  8. <meta name="dc.created" content="2023-10-27">
    9. 

  9. <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
    10. 

  10. <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.min.css" title="Style">
    11. 

  11. <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
    12. 

  12. <script type="text/javascript" src="../../../../script.js"></script>
    13. 

  13. <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
    14. 

  14. <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
    15. 

  15. <!--[if IE]>
    16. 

  16. <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
    17. 

  17. <![endif]-->
    18. 

  18. <script type="text/javascript" src="../../../../jquery/jquery-3.6.0.min.js"></script>
    19. 

  19. <script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script>
    20. 

  20. </head>
    21. 

  21. <body>
    22. 

  22. <script type="text/javascript"><!--
    23. 

  23.     try {
    24. 

  24.         if (location.href.indexOf('is-external=true') == -1) {
    25. 

  25.             parent.document.title="CreateCollectionParam.Builder";
    26. 

  26.         }
    27. 

  27.     }
    28. 

  28.     catch(err) {
    29. 

  29.     }
    30. 

  30. //-->
    31. 

  31. var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10};
    32. 

  32. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
    33. 

  33. var altColor = "altColor";
    34. 

  34. var rowColor = "rowColor";
    35. 

  35. var tableTab = "tableTab";
    36. 

  36. var activeTableTab = "activeTableTab";
    37. 

  37. var pathtoroot = "../../../../";
    38. 

  38. var useModuleDirectories = true;
    39. 

  39. loadScripts(document, 'script');</script>
    40. 

  40. <noscript>
    41. 

  41. <div>JavaScript is disabled on your browser.</div>
    42. 

  42. </noscript>
    43. 

  43. <header role="banner">
    44. 

  44. <nav role="navigation">
    45. 

  45. <div class="fixedNav">
    46. 

  46. <!-- ========= START OF TOP NAVBAR ======= -->
    47. 

  47. <div class="topNav"><a id="navbar.top">
    48. 

  48. <!--   -->
    49. 

  49. </a>
    50. 

  50. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
    51. 

  51. <a id="navbar.top.firstrow">
    52. 

  52. <!--   -->
    53. 

  53. </a>
    54. 

  54. <ul class="navList" title="Navigation">
    55. 

  55. <li><a href="../../../../index.html">Overview</a></li>
    56. 

  56. <li><a href="package-summary.html">Package</a></li>
    57. 

  57. <li class="navBarCell1Rev">Class</li>
    58. 

  58. <li><a href="package-tree.html">Tree</a></li>
    59. 

  59. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
    60. 

  60. <li><a href="../../../../index-files/index-1.html">Index</a></li>
    61. 

  61. <li><a href="../../../../help-doc.html">Help</a></li>
    62. 

  62. </ul>
    63. 

  63. </div>
    64. 

  64. <div class="subNav">
    65. 

  65. <ul class="navList" id="allclasses_navbar_top">
    66. 

  66. <li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
    67. 

  67. </ul>
    68. 

  68. <ul class="navListSearch">
    69. 

  69. <li><label for="search">SEARCH:</label>
    70. 

  70. <input type="text" id="search" value="search" disabled="disabled">
    71. 

  71. <input type="reset" id="reset" value="reset" disabled="disabled">
    72. 

  72. </li>
    73. 

  73. </ul>
    74. 

  74. <div>
    75. 

  75. <script type="text/javascript"><!--
    76. 

  76.   allClassesLink = document.getElementById("allclasses_navbar_top");
    77. 

  77.   if(window==top) {
    78. 

  78.     allClassesLink.style.display = "block";
    79. 

  79.   }
    80. 

  80.   else {
    81. 

  81.     allClassesLink.style.display = "none";
    82. 

  82.   }
    83. 

  83.   //-->
    84. 

  84. </script>
    85. 

  85. <noscript>
    86. 

  86. <div>JavaScript is disabled on your browser.</div>
    87. 

  87. </noscript>
    88. 

  88. </div>
    89. 

  89. <div>
    90. 

  90. <ul class="subNavList">
    91. 

  91. <li>Summary:&nbsp;</li>
    92. 

  92. <li>Nested&nbsp;|&nbsp;</li>
    93. 

  93. <li>Field&nbsp;|&nbsp;</li>
    94. 

  94. <li>Constr&nbsp;|&nbsp;</li>
    95. 

  95. <li><a href="#method.summary">Method</a></li>
    96. 

  96. </ul>
    97. 

  97. <ul class="subNavList">
    98. 

  98. <li>Detail:&nbsp;</li>
    99. 

  99. <li>Field&nbsp;|&nbsp;</li>
    100. 

  100. <li>Constr&nbsp;|&nbsp;</li>
    101. 

  101. <li><a href="#method.detail">Method</a></li>
    102. 

  102. </ul>
    103. 

  103. </div>
    104. 

  104. <a id="skip.navbar.top">
    105. 

  105. <!--   -->
    106. 

  106. </a></div>
    107. 

  107. <!-- ========= END OF TOP NAVBAR ========= -->
    108. 

  108. </div>
    109. 

  109. <div class="navPadding">&nbsp;</div>
    110. 

  110. <script type="text/javascript"><!--
    111. 

  111. $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
    112. 

  112. //-->
    113. 

  113. </script>
    114. 

  114. </nav>
    115. 

  115. </header>
    116. 

  116. <!-- ======== START OF CLASS DATA ======== -->
    117. 

  117. <main role="main">
    118. 

  118. <div class="header">
    119. 

  119. <div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">io.milvus.param.collection</a></div>
    120. 

  120. <h2 title="Class CreateCollectionParam.Builder" class="title">Class CreateCollectionParam.Builder</h2>
    121. 

  121. </div>
    122. 

  122. <div class="contentContainer">
    123. 

  123. <ul class="inheritance">
    124. 

  124. <li>java.lang.Object</li>
    125. 

  125. <li>
    126. 

  126. <ul class="inheritance">
    127. 

  127. <li>io.milvus.param.collection.CreateCollectionParam.Builder</li>
    128. 

  128. </ul>
    129. 

  129. </li>
    130. 

  130. </ul>
    131. 

  131. <div class="description">
    132. 

  132. <ul class="blockList">
    133. 

  133. <li class="blockList">
    134. 

  134. <dl>
    135. 

  135. <dt>Enclosing class:</dt>
    136. 

  136. <dd><a href="CreateCollectionParam.html" title="class in io.milvus.param.collection">CreateCollectionParam</a></dd>
    137. 

  137. </dl>
    138. 

  138. <hr>
    139. 

  139. <pre>public static final class <span class="typeNameLabel">CreateCollectionParam.Builder</span>
    140. 

  140. extends java.lang.Object</pre>
    141. 

  141. <div class="block">Builder for <a href="CreateCollectionParam.html" title="class in io.milvus.param.collection"><code>CreateCollectionParam</code></a> class.</div>
    142. 

  142. </li>
    143. 

  143. </ul>
    144. 

  144. </div>
    145. 

  145. <div class="summary">
    146. 

  146. <ul class="blockList">
    147. 

  147. <li class="blockList">
    148. 

  148. <!-- ========== METHOD SUMMARY =========== -->
    149. 

  149. <section>
    150. 

  150. <ul class="blockList">
    151. 

  151. <li class="blockList"><a id="method.summary">
    152. 

  152. <!--   -->
    153. 

  153. </a>
    154. 

  154. <h3>Method Summary</h3>
    155. 

  155. <table class="memberSummary">
    156. 

  156. <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>
    157. 

  157. <tr>
    158. 

  158. <th class="colFirst" scope="col">Modifier and Type</th>
    159. 

  159. <th class="colSecond" scope="col">Method</th>
    160. 

  160. <th class="colLast" scope="col">Description</th>
    161. 

  161. </tr>
    162. 

  162. <tr id="i0" class="altColor">
    163. 

  163. <td class="colFirst"><code><a href="CreateCollectionParam.Builder.html" title="class in io.milvus.param.collection">CreateCollectionParam.Builder</a></code></td>
    164. 

  164. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addFieldType(io.milvus.param.collection.FieldType)">addFieldType</a></span>&#8203;(@NonNull <a href="FieldType.html" title="class in io.milvus.param.collection">FieldType</a>&nbsp;fieldType)</code></th>
    165. 

  165. <td class="colLast">
    166. 

  166. <div class="block">Adds a field schema.</div>
    167. 

  167. </td>
    168. 

  168. </tr>
    169. 

  169. <tr id="i1" class="rowColor">
    170. 

  170. <td class="colFirst"><code><a href="CreateCollectionParam.html" title="class in io.milvus.param.collection">CreateCollectionParam</a></code></td>
    171. 

  171. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#build()">build</a></span>()</code></th>
    172. 

  172. <td class="colLast">
    173. 

  173. <div class="block">Verifies parameters and creates a new <a href="CreateCollectionParam.html" title="class in io.milvus.param.collection"><code>CreateCollectionParam</code></a> instance.</div>
    174. 

  174. </td>
    175. 

  175. </tr>
    176. 

  176. <tr id="i2" class="altColor">
    177. 

  177. <td class="colFirst"><code><a href="CreateCollectionParam.Builder.html" title="class in io.milvus.param.collection">CreateCollectionParam.Builder</a></code></td>
    178. 

  178. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withCollectionName(java.lang.String)">withCollectionName</a></span>&#8203;(@NonNull java.lang.String&nbsp;collectionName)</code></th>
    179. 

  179. <td class="colLast">
    180. 

  180. <div class="block">Sets the collection name.</div>
    181. 

  181. </td>
    182. 

  182. </tr>
    183. 

  183. <tr id="i3" class="rowColor">
    184. 

  184. <td class="colFirst"><code><a href="CreateCollectionParam.Builder.html" title="class in io.milvus.param.collection">CreateCollectionParam.Builder</a></code></td>
    185. 

  185. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withConsistencyLevel(io.milvus.common.clientenum.ConsistencyLevelEnum)">withConsistencyLevel</a></span>&#8203;(@NonNull <a href="../../common/clientenum/ConsistencyLevelEnum.html" title="enum in io.milvus.common.clientenum">ConsistencyLevelEnum</a>&nbsp;consistencyLevel)</code></th>
    186. 

  186. <td class="colLast">
    187. 

  187. <div class="block">Sets the consistency level.</div>
    188. 

  188. </td>
    189. 

  189. </tr>
    190. 

  190. <tr id="i4" class="altColor">
    191. 

  191. <td class="colFirst"><code><a href="CreateCollectionParam.Builder.html" title="class in io.milvus.param.collection">CreateCollectionParam.Builder</a></code></td>
    192. 

  192. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withDatabaseName(java.lang.String)">withDatabaseName</a></span>&#8203;(java.lang.String&nbsp;databaseName)</code></th>
    193. 

  193. <td class="colLast">
    194. 

  194. <div class="block">Sets the database name.</div>
    195. 

  195. </td>
    196. 

  196. </tr>
    197. 

  197. <tr id="i5" class="rowColor">
    198. 

  198. <td class="colFirst"><code><a href="CreateCollectionParam.Builder.html" title="class in io.milvus.param.collection">CreateCollectionParam.Builder</a></code></td>
    199. 

  199. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withDescription(java.lang.String)">withDescription</a></span>&#8203;(@NonNull java.lang.String&nbsp;description)</code></th>
    200. 

  200. <td class="colLast">
    201. 

  201. <div class="block">Sets the collection description.</div>
    202. 

  202. </td>
    203. 

  203. </tr>
    204. 

  204. <tr id="i6" class="altColor">
    205. 

  205. <td class="colFirst"><code><a href="CreateCollectionParam.Builder.html" title="class in io.milvus.param.collection">CreateCollectionParam.Builder</a></code></td>
    206. 

  206. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withEnableDynamicField(boolean)">withEnableDynamicField</a></span>&#8203;(boolean&nbsp;enableDynamicField)</code></th>
    207. 

  207. <td class="colLast">
    208. 

  208. <div class="block">Sets the collection if enableDynamicField.</div>
    209. 

  209. </td>
    210. 

  210. </tr>
    211. 

  211. <tr id="i7" class="rowColor">
    212. 

  212. <td class="colFirst"><code><a href="CreateCollectionParam.Builder.html" title="class in io.milvus.param.collection">CreateCollectionParam.Builder</a></code></td>
    213. 

  213. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withFieldTypes(java.util.List)">withFieldTypes</a></span>&#8203;(@NonNull java.util.List&lt;<a href="FieldType.html" title="class in io.milvus.param.collection">FieldType</a>&gt;&nbsp;fieldTypes)</code></th>
    214. 

  214. <td class="colLast">
    215. 

  215. <div class="block">Sets the schema of the collection.</div>
    216. 

  216. </td>
    217. 

  217. </tr>
    218. 

  218. <tr id="i8" class="altColor">
    219. 

  219. <td class="colFirst"><code><a href="CreateCollectionParam.Builder.html" title="class in io.milvus.param.collection">CreateCollectionParam.Builder</a></code></td>
    220. 

  220. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withPartitionsNum(int)">withPartitionsNum</a></span>&#8203;(int&nbsp;partitionsNum)</code></th>
    221. 

  221. <td class="colLast">
    222. 

  222. <div class="block">Sets the partitions number if there is partition key field.</div>
    223. 

  223. </td>
    224. 

  224. </tr>
    225. 

  225. <tr id="i9" class="rowColor">
    226. 

  226. <td class="colFirst"><code><a href="CreateCollectionParam.Builder.html" title="class in io.milvus.param.collection">CreateCollectionParam.Builder</a></code></td>
    227. 

  227. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withShardsNum(int)">withShardsNum</a></span>&#8203;(int&nbsp;shardsNum)</code></th>
    228. 

  228. <td class="colLast">
    229. 

  229. <div class="block">Sets the shards number.</div>
    230. 

  230. </td>
    231. 

  231. </tr>
    232. 

  232. </table>
    233. 

  233. <ul class="blockList">
    234. 

  234. <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
    235. 

  235. <!--   -->
    236. 

  236. </a>
    237. 

  237. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
    238. 

  238. <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
    239. 

  239. </ul>
    240. 

  240. </li>
    241. 

  241. </ul>
    242. 

  242. </section>
    243. 

  243. </li>
    244. 

  244. </ul>
    245. 

  245. </div>
    246. 

  246. <div class="details">
    247. 

  247. <ul class="blockList">
    248. 

  248. <li class="blockList">
    249. 

  249. <!-- ============ METHOD DETAIL ========== -->
    250. 

  250. <section>
    251. 

  251. <ul class="blockList">
    252. 

  252. <li class="blockList"><a id="method.detail">
    253. 

  253. <!--   -->
    254. 

  254. </a>
    255. 

  255. <h3>Method Detail</h3>
    256. 

  256. <a id="withCollectionName(java.lang.String)">
    257. 

  257. <!--   -->
    258. 

  258. </a>
    259. 

  259. <ul class="blockList">
    260. 

  260. <li class="blockList">
    261. 

  261. <h4>withCollectionName</h4>
    262. 

  262. <pre class="methodSignature">public&nbsp;<a href="CreateCollectionParam.Builder.html" title="class in io.milvus.param.collection">CreateCollectionParam.Builder</a>&nbsp;withCollectionName&#8203;(@NonNull
    263. 

  263.                                                         @NonNull java.lang.String&nbsp;collectionName)</pre>
    264. 

  264. <div class="block">Sets the collection name. Collection name cannot be empty or null.</div>
    265. 

  265. <dl>
    266. 

  266. <dt><span class="paramLabel">Parameters:</span></dt>
    267. 

  267. <dd><code>collectionName</code> - collection name</dd>
    268. 

  268. <dt><span class="returnLabel">Returns:</span></dt>
    269. 

  269. <dd><code>Builder</code></dd>
    270. 

  270. </dl>
    271. 

  271. </li>
    272. 

  272. </ul>
    273. 

  273. <a id="withDatabaseName(java.lang.String)">
    274. 

  274. <!--   -->
    275. 

  275. </a>
    276. 

  276. <ul class="blockList">
    277. 

  277. <li class="blockList">
    278. 

  278. <h4>withDatabaseName</h4>
    279. 

  279. <pre class="methodSignature">public&nbsp;<a href="CreateCollectionParam.Builder.html" title="class in io.milvus.param.collection">CreateCollectionParam.Builder</a>&nbsp;withDatabaseName&#8203;(java.lang.String&nbsp;databaseName)</pre>
    280. 

  280. <div class="block">Sets the database name. database name can be nil.</div>
    281. 

  281. <dl>
    282. 

  282. <dt><span class="paramLabel">Parameters:</span></dt>
    283. 

  283. <dd><code>databaseName</code> - database name</dd>
    284. 

  284. <dt><span class="returnLabel">Returns:</span></dt>
    285. 

  285. <dd><code>Builder</code></dd>
    286. 

  286. </dl>
    287. 

  287. </li>
    288. 

  288. </ul>
    289. 

  289. <a id="withShardsNum(int)">
    290. 

  290. <!--   -->
    291. 

  291. </a>
    292. 

  292. <ul class="blockList">
    293. 

  293. <li class="blockList">
    294. 

  294. <h4>withShardsNum</h4>
    295. 

  295. <pre class="methodSignature">public&nbsp;<a href="CreateCollectionParam.Builder.html" title="class in io.milvus.param.collection">CreateCollectionParam.Builder</a>&nbsp;withShardsNum&#8203;(int&nbsp;shardsNum)</pre>
    296. 

  296. <div class="block">Sets the shards number. The number must be greater or equal to zero.
    297. 

  297.  The default value is 0, which means letting the server decide the value.
    298. 

  298.  The server set this value to 1 if user didn't specify it.</div>
    299. 

  299. <dl>
    300. 

  300. <dt><span class="paramLabel">Parameters:</span></dt>
    301. 

  301. <dd><code>shardsNum</code> - shards number to distribute insert data into multiple data nodes and query nodes.</dd>
    302. 

  302. <dt><span class="returnLabel">Returns:</span></dt>
    303. 

  303. <dd><code>Builder</code></dd>
    304. 

  304. </dl>
    305. 

  305. </li>
    306. 

  306. </ul>
    307. 

  307. <a id="withEnableDynamicField(boolean)">
    308. 

  308. <!--   -->
    309. 

  309. </a>
    310. 

  310. <ul class="blockList">
    311. 

  311. <li class="blockList">
    312. 

  312. <h4>withEnableDynamicField</h4>
    313. 

  313. <pre class="methodSignature">public&nbsp;<a href="CreateCollectionParam.Builder.html" title="class in io.milvus.param.collection">CreateCollectionParam.Builder</a>&nbsp;withEnableDynamicField&#8203;(boolean&nbsp;enableDynamicField)</pre>
    314. 

  314. <div class="block">Sets the collection if enableDynamicField.</div>
    315. 

  315. <dl>
    316. 

  316. <dt><span class="paramLabel">Parameters:</span></dt>
    317. 

  317. <dd><code>enableDynamicField</code> - enableDynamicField of the collection</dd>
    318. 

  318. <dt><span class="returnLabel">Returns:</span></dt>
    319. 

  319. <dd><code>Builder</code></dd>
    320. 

  320. </dl>
    321. 

  321. </li>
    322. 

  322. </ul>
    323. 

  323. <a id="withDescription(java.lang.String)">
    324. 

  324. <!--   -->
    325. 

  325. </a>
    326. 

  326. <ul class="blockList">
    327. 

  327. <li class="blockList">
    328. 

  328. <h4>withDescription</h4>
    329. 

  329. <pre class="methodSignature">public&nbsp;<a href="CreateCollectionParam.Builder.html" title="class in io.milvus.param.collection">CreateCollectionParam.Builder</a>&nbsp;withDescription&#8203;(@NonNull
    330. 

  330.                                                      @NonNull java.lang.String&nbsp;description)</pre>
    331. 

  331. <div class="block">Sets the collection description. The description can be empty. The default is "".</div>
    332. 

  332. <dl>
    333. 

  333. <dt><span class="paramLabel">Parameters:</span></dt>
    334. 

  334. <dd><code>description</code> - description of the collection</dd>
    335. 

  335. <dt><span class="returnLabel">Returns:</span></dt>
    336. 

  336. <dd><code>Builder</code></dd>
    337. 

  337. </dl>
    338. 

  338. </li>
    339. 

  339. </ul>
    340. 

  340. <a id="withFieldTypes(java.util.List)">
    341. 

  341. <!--   -->
    342. 

  342. </a>
    343. 

  343. <ul class="blockList">
    344. 

  344. <li class="blockList">
    345. 

  345. <h4>withFieldTypes</h4>
    346. 

  346. <pre class="methodSignature">public&nbsp;<a href="CreateCollectionParam.Builder.html" title="class in io.milvus.param.collection">CreateCollectionParam.Builder</a>&nbsp;withFieldTypes&#8203;(@NonNull
    347. 

  347.                                                     @NonNull java.util.List&lt;<a href="FieldType.html" title="class in io.milvus.param.collection">FieldType</a>&gt;&nbsp;fieldTypes)</pre>
    348. 

  348. <div class="block">Sets the schema of the collection. The schema cannot be empty or null.</div>
    349. 

  349. <dl>
    350. 

  350. <dt><span class="paramLabel">Parameters:</span></dt>
    351. 

  351. <dd><code>fieldTypes</code> - a <code>List</code> of <a href="FieldType.html" title="class in io.milvus.param.collection"><code>FieldType</code></a></dd>
    352. 

  352. <dt><span class="returnLabel">Returns:</span></dt>
    353. 

  353. <dd><code>Builder</code></dd>
    354. 

  354. <dt><span class="seeLabel">See Also:</span></dt>
    355. 

  355. <dd><a href="FieldType.html" title="class in io.milvus.param.collection"><code>FieldType</code></a></dd>
    356. 

  356. </dl>
    357. 

  357. </li>
    358. 

  358. </ul>
    359. 

  359. <a id="addFieldType(io.milvus.param.collection.FieldType)">
    360. 

  360. <!--   -->
    361. 

  361. </a>
    362. 

  362. <ul class="blockList">
    363. 

  363. <li class="blockList">
    364. 

  364. <h4>addFieldType</h4>
    365. 

  365. <pre class="methodSignature">public&nbsp;<a href="CreateCollectionParam.Builder.html" title="class in io.milvus.param.collection">CreateCollectionParam.Builder</a>&nbsp;addFieldType&#8203;(@NonNull
    366. 

  366.                                                   @NonNull <a href="FieldType.html" title="class in io.milvus.param.collection">FieldType</a>&nbsp;fieldType)</pre>
    367. 

  367. <div class="block">Adds a field schema.</div>
    368. 

  368. <dl>
    369. 

  369. <dt><span class="paramLabel">Parameters:</span></dt>
    370. 

  370. <dd><code>fieldType</code> - a <a href="FieldType.html" title="class in io.milvus.param.collection"><code>FieldType</code></a> object</dd>
    371. 

  371. <dt><span class="returnLabel">Returns:</span></dt>
    372. 

  372. <dd><code>Builder</code></dd>
    373. 

  373. <dt><span class="seeLabel">See Also:</span></dt>
    374. 

  374. <dd><a href="FieldType.html" title="class in io.milvus.param.collection"><code>FieldType</code></a></dd>
    375. 

  375. </dl>
    376. 

  376. </li>
    377. 

  377. </ul>
    378. 

  378. <a id="withConsistencyLevel(io.milvus.common.clientenum.ConsistencyLevelEnum)">
    379. 

  379. <!--   -->
    380. 

  380. </a>
    381. 

  381. <ul class="blockList">
    382. 

  382. <li class="blockList">
    383. 

  383. <h4>withConsistencyLevel</h4>
    384. 

  384. <pre class="methodSignature">public&nbsp;<a href="CreateCollectionParam.Builder.html" title="class in io.milvus.param.collection">CreateCollectionParam.Builder</a>&nbsp;withConsistencyLevel&#8203;(@NonNull
    385. 

  385.                                                           @NonNull <a href="../../common/clientenum/ConsistencyLevelEnum.html" title="enum in io.milvus.common.clientenum">ConsistencyLevelEnum</a>&nbsp;consistencyLevel)</pre>
    386. 

  386. <div class="block">Sets the consistency level. The default value is <a href="../../common/clientenum/ConsistencyLevelEnum.html#BOUNDED"><code>ConsistencyLevelEnum.BOUNDED</code></a>.</div>
    387. 

  387. <dl>
    388. 

  388. <dt><span class="paramLabel">Parameters:</span></dt>
    389. 

  389. <dd><code>consistencyLevel</code> - consistency level</dd>
    390. 

  390. <dt><span class="returnLabel">Returns:</span></dt>
    391. 

  391. <dd><code>Builder</code></dd>
    392. 

  392. <dt><span class="seeLabel">See Also:</span></dt>
    393. 

  393. <dd><a href="../../common/clientenum/ConsistencyLevelEnum.html" title="enum in io.milvus.common.clientenum"><code>ConsistencyLevelEnum</code></a></dd>
    394. 

  394. </dl>
    395. 

  395. </li>
    396. 

  396. </ul>
    397. 

  397. <a id="withPartitionsNum(int)">
    398. 

  398. <!--   -->
    399. 

  399. </a>
    400. 

  400. <ul class="blockList">
    401. 

  401. <li class="blockList">
    402. 

  402. <h4>withPartitionsNum</h4>
    403. 

  403. <pre class="methodSignature">public&nbsp;<a href="CreateCollectionParam.Builder.html" title="class in io.milvus.param.collection">CreateCollectionParam.Builder</a>&nbsp;withPartitionsNum&#8203;(int&nbsp;partitionsNum)</pre>
    404. 

  404. <div class="block">Sets the partitions number if there is partition key field. The number must be greater than zero.
    405. 

  405.  The default value is 64(defined in server side). The upper limit is 4096(defined in server side).
    406. 

  406.  Not allow to set this value if none of field is partition key.
    407. 

  407.  Only one partition key field is allowed in a collection.</div>
    408. 

  408. <dl>
    409. 

  409. <dt><span class="paramLabel">Parameters:</span></dt>
    410. 

  410. <dd><code>partitionsNum</code> - partitions number</dd>
    411. 

  411. <dt><span class="returnLabel">Returns:</span></dt>
    412. 

  412. <dd><code>Builder</code></dd>
    413. 

  413. </dl>
    414. 

  414. </li>
    415. 

  415. </ul>
    416. 

  416. <a id="build()">
    417. 

  417. <!--   -->
    418. 

  418. </a>
    419. 

  419. <ul class="blockListLast">
    420. 

  420. <li class="blockList">
    421. 

  421. <h4>build</h4>
    422. 

  422. <pre class="methodSignature">public&nbsp;<a href="CreateCollectionParam.html" title="class in io.milvus.param.collection">CreateCollectionParam</a>&nbsp;build()
    423. 

  423.                             throws <a href="../../exception/ParamException.html" title="class in io.milvus.exception">ParamException</a></pre>
    424. 

  424. <div class="block">Verifies parameters and creates a new <a href="CreateCollectionParam.html" title="class in io.milvus.param.collection"><code>CreateCollectionParam</code></a> instance.</div>
    425. 

  425. <dl>
    426. 

  426. <dt><span class="returnLabel">Returns:</span></dt>
    427. 

  427. <dd><a href="CreateCollectionParam.html" title="class in io.milvus.param.collection"><code>CreateCollectionParam</code></a></dd>
    428. 

  428. <dt><span class="throwsLabel">Throws:</span></dt>
    429. 

  429. <dd><code><a href="../../exception/ParamException.html" title="class in io.milvus.exception">ParamException</a></code></dd>
    430. 

  430. </dl>
    431. 

  431. </li>
    432. 

  432. </ul>
    433. 

  433. </li>
    434. 

  434. </ul>
    435. 

  435. </section>
    436. 

  436. </li>
    437. 

  437. </ul>
    438. 

  438. </div>
    439. 

  439. </div>
    440. 

  440. </main>
    441. 

  441. <!-- ========= END OF CLASS DATA ========= -->
    442. 

  442. <footer role="contentinfo">
    443. 

  443. <nav role="navigation">
    444. 

  444. <!-- ======= START OF BOTTOM NAVBAR ====== -->
    445. 

  445. <div class="bottomNav"><a id="navbar.bottom">
    446. 

  446. <!--   -->
    447. 

  447. </a>
    448. 

  448. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
    449. 

  449. <a id="navbar.bottom.firstrow">
    450. 

  450. <!--   -->
    451. 

  451. </a>
    452. 

  452. <ul class="navList" title="Navigation">
    453. 

  453. <li><a href="../../../../index.html">Overview</a></li>
    454. 

  454. <li><a href="package-summary.html">Package</a></li>
    455. 

  455. <li class="navBarCell1Rev">Class</li>
    456. 

  456. <li><a href="package-tree.html">Tree</a></li>
    457. 

  457. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
    458. 

  458. <li><a href="../../../../index-files/index-1.html">Index</a></li>
    459. 

  459. <li><a href="../../../../help-doc.html">Help</a></li>
    460. 

  460. </ul>
    461. 

  461. </div>
    462. 

  462. <div class="subNav">
    463. 

  463. <ul class="navList" id="allclasses_navbar_bottom">
    464. 

  464. <li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
    465. 

  465. </ul>
    466. 

  466. <div>
    467. 

  467. <script type="text/javascript"><!--
    468. 

  468.   allClassesLink = document.getElementById("allclasses_navbar_bottom");
    469. 

  469.   if(window==top) {
    470. 

  470.     allClassesLink.style.display = "block";
    471. 

  471.   }
    472. 

  472.   else {
    473. 

  473.     allClassesLink.style.display = "none";
    474. 

  474.   }
    475. 

  475.   //-->
    476. 

  476. </script>
    477. 

  477. <noscript>
    478. 

  478. <div>JavaScript is disabled on your browser.</div>
    479. 

  479. </noscript>
    480. 

  480. </div>
    481. 

  481. <div>
    482. 

  482. <ul class="subNavList">
    483. 

  483. <li>Summary:&nbsp;</li>
    484. 

  484. <li>Nested&nbsp;|&nbsp;</li>
    485. 

  485. <li>Field&nbsp;|&nbsp;</li>
    486. 

  486. <li>Constr&nbsp;|&nbsp;</li>
    487. 

  487. <li><a href="#method.summary">Method</a></li>
    488. 

  488. </ul>
    489. 

  489. <ul class="subNavList">
    490. 

  490. <li>Detail:&nbsp;</li>
    491. 

  491. <li>Field&nbsp;|&nbsp;</li>
    492. 

  492. <li>Constr&nbsp;|&nbsp;</li>
    493. 

  493. <li><a href="#method.detail">Method</a></li>
    494. 

  494. </ul>
    495. 

  495. </div>
    496. 

  496. <a id="skip.navbar.bottom">
    497. 

  497. <!--   -->
    498. 

  498. </a></div>
    499. 

  499. <!-- ======== END OF BOTTOM NAVBAR ======= -->
    500. 

  500. </nav>
    501. 

  501. </footer>
    502. 

  502. </body>
    503. 

  503. </html>
    504.