RemoteBulkWriterParam.Builder.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337
  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 Thu Aug 08 18:07:05 CST 2024 -->
  6. <title>RemoteBulkWriterParam.Builder</title>
  7. <meta name="date" content="2024-08-08">
  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="RemoteBulkWriterParam.Builder";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":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/bulkwriter/RemoteBulkWriterParam.html" title="class in io.milvus.bulkwriter"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  52. <li>Next&nbsp;Class</li>
  53. </ul>
  54. <ul class="navList">
  55. <li><a href="../../../index.html?io/milvus/bulkwriter/RemoteBulkWriterParam.Builder.html" target="_top">Frames</a></li>
  56. <li><a href="RemoteBulkWriterParam.Builder.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>Constr&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>Constr&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.bulkwriter</div>
  95. <h2 title="Class RemoteBulkWriterParam.Builder" class="title">Class RemoteBulkWriterParam.Builder</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.bulkwriter.RemoteBulkWriterParam.Builder</li>
  103. </ul>
  104. </li>
  105. </ul>
  106. <div class="description">
  107. <ul class="blockList">
  108. <li class="blockList">
  109. <dl>
  110. <dt>Enclosing class:</dt>
  111. <dd><a href="../../../io/milvus/bulkwriter/RemoteBulkWriterParam.html" title="class in io.milvus.bulkwriter">RemoteBulkWriterParam</a></dd>
  112. </dl>
  113. <hr>
  114. <br>
  115. <pre>public static final class <span class="typeNameLabel">RemoteBulkWriterParam.Builder</span>
  116. extends java.lang.Object</pre>
  117. <div class="block">Builder for <a href="../../../io/milvus/bulkwriter/RemoteBulkWriterParam.html" title="class in io.milvus.bulkwriter"><code>RemoteBulkWriterParam</code></a> class.</div>
  118. </li>
  119. </ul>
  120. </div>
  121. <div class="summary">
  122. <ul class="blockList">
  123. <li class="blockList">
  124. <!-- ========== METHOD SUMMARY =========== -->
  125. <ul class="blockList">
  126. <li class="blockList"><a name="method.summary">
  127. <!-- -->
  128. </a>
  129. <h3>Method Summary</h3>
  130. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  131. <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>
  132. <tr>
  133. <th class="colFirst" scope="col">Modifier and Type</th>
  134. <th class="colLast" scope="col">Method and Description</th>
  135. </tr>
  136. <tr id="i0" class="altColor">
  137. <td class="colFirst"><code><a href="../../../io/milvus/bulkwriter/RemoteBulkWriterParam.html" title="class in io.milvus.bulkwriter">RemoteBulkWriterParam</a></code></td>
  138. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/bulkwriter/RemoteBulkWriterParam.Builder.html#build--">build</a></span>()</code>
  139. <div class="block">Verifies parameters and creates a new <a href="../../../io/milvus/bulkwriter/RemoteBulkWriterParam.html" title="class in io.milvus.bulkwriter"><code>RemoteBulkWriterParam</code></a> instance.</div>
  140. </td>
  141. </tr>
  142. <tr id="i1" class="rowColor">
  143. <td class="colFirst"><code><a href="../../../io/milvus/bulkwriter/RemoteBulkWriterParam.Builder.html" title="class in io.milvus.bulkwriter">RemoteBulkWriterParam.Builder</a></code></td>
  144. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/bulkwriter/RemoteBulkWriterParam.Builder.html#withChunkSize-int-">withChunkSize</a></span>(int&nbsp;chunkSize)</code>&nbsp;</td>
  145. </tr>
  146. <tr id="i2" class="altColor">
  147. <td class="colFirst"><code><a href="../../../io/milvus/bulkwriter/RemoteBulkWriterParam.Builder.html" title="class in io.milvus.bulkwriter">RemoteBulkWriterParam.Builder</a></code></td>
  148. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/bulkwriter/RemoteBulkWriterParam.Builder.html#withCollectionSchema-io.milvus.param.collection.CollectionSchemaParam-">withCollectionSchema</a></span>(@NonNull <a href="../../../io/milvus/param/collection/CollectionSchemaParam.html" title="class in io.milvus.param.collection">CollectionSchemaParam</a>&nbsp;collectionSchema)</code>
  149. <div class="block">Sets the collection info.</div>
  150. </td>
  151. </tr>
  152. <tr id="i3" class="rowColor">
  153. <td class="colFirst"><code><a href="../../../io/milvus/bulkwriter/RemoteBulkWriterParam.Builder.html" title="class in io.milvus.bulkwriter">RemoteBulkWriterParam.Builder</a></code></td>
  154. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/bulkwriter/RemoteBulkWriterParam.Builder.html#withConnectParam-io.milvus.bulkwriter.connect.StorageConnectParam-">withConnectParam</a></span>(<a href="../../../io/milvus/bulkwriter/connect/StorageConnectParam.html" title="class in io.milvus.bulkwriter.connect">StorageConnectParam</a>&nbsp;connectParam)</code>&nbsp;</td>
  155. </tr>
  156. <tr id="i4" class="altColor">
  157. <td class="colFirst"><code><a href="../../../io/milvus/bulkwriter/RemoteBulkWriterParam.Builder.html" title="class in io.milvus.bulkwriter">RemoteBulkWriterParam.Builder</a></code></td>
  158. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/bulkwriter/RemoteBulkWriterParam.Builder.html#withFileType-io.milvus.bulkwriter.common.clientenum.BulkFileType-">withFileType</a></span>(@NonNull <a href="../../../io/milvus/bulkwriter/common/clientenum/BulkFileType.html" title="enum in io.milvus.bulkwriter.common.clientenum">BulkFileType</a>&nbsp;fileType)</code>&nbsp;</td>
  159. </tr>
  160. <tr id="i5" class="rowColor">
  161. <td class="colFirst"><code><a href="../../../io/milvus/bulkwriter/RemoteBulkWriterParam.Builder.html" title="class in io.milvus.bulkwriter">RemoteBulkWriterParam.Builder</a></code></td>
  162. <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/bulkwriter/RemoteBulkWriterParam.Builder.html#withRemotePath-java.lang.String-">withRemotePath</a></span>(@NonNull java.lang.String&nbsp;remotePath)</code>
  163. <div class="block">Sets the remotePath.</div>
  164. </td>
  165. </tr>
  166. </table>
  167. <ul class="blockList">
  168. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  169. <!-- -->
  170. </a>
  171. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  172. <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  173. </ul>
  174. </li>
  175. </ul>
  176. </li>
  177. </ul>
  178. </div>
  179. <div class="details">
  180. <ul class="blockList">
  181. <li class="blockList">
  182. <!-- ============ METHOD DETAIL ========== -->
  183. <ul class="blockList">
  184. <li class="blockList"><a name="method.detail">
  185. <!-- -->
  186. </a>
  187. <h3>Method Detail</h3>
  188. <a name="withCollectionSchema-io.milvus.param.collection.CollectionSchemaParam-">
  189. <!-- -->
  190. </a>
  191. <ul class="blockList">
  192. <li class="blockList">
  193. <h4>withCollectionSchema</h4>
  194. <pre>public&nbsp;<a href="../../../io/milvus/bulkwriter/RemoteBulkWriterParam.Builder.html" title="class in io.milvus.bulkwriter">RemoteBulkWriterParam.Builder</a>&nbsp;withCollectionSchema(@NonNull
  195. @NonNull <a href="../../../io/milvus/param/collection/CollectionSchemaParam.html" title="class in io.milvus.param.collection">CollectionSchemaParam</a>&nbsp;collectionSchema)</pre>
  196. <div class="block">Sets the collection info.</div>
  197. <dl>
  198. <dt><span class="paramLabel">Parameters:</span></dt>
  199. <dd><code>collectionSchema</code> - collection info</dd>
  200. <dt><span class="returnLabel">Returns:</span></dt>
  201. <dd><code>Builder</code></dd>
  202. </dl>
  203. </li>
  204. </ul>
  205. <a name="withConnectParam-io.milvus.bulkwriter.connect.StorageConnectParam-">
  206. <!-- -->
  207. </a>
  208. <ul class="blockList">
  209. <li class="blockList">
  210. <h4>withConnectParam</h4>
  211. <pre>public&nbsp;<a href="../../../io/milvus/bulkwriter/RemoteBulkWriterParam.Builder.html" title="class in io.milvus.bulkwriter">RemoteBulkWriterParam.Builder</a>&nbsp;withConnectParam(@NotNull
  212. <a href="../../../io/milvus/bulkwriter/connect/StorageConnectParam.html" title="class in io.milvus.bulkwriter.connect">StorageConnectParam</a>&nbsp;connectParam)</pre>
  213. </li>
  214. </ul>
  215. <a name="withRemotePath-java.lang.String-">
  216. <!-- -->
  217. </a>
  218. <ul class="blockList">
  219. <li class="blockList">
  220. <h4>withRemotePath</h4>
  221. <pre>public&nbsp;<a href="../../../io/milvus/bulkwriter/RemoteBulkWriterParam.Builder.html" title="class in io.milvus.bulkwriter">RemoteBulkWriterParam.Builder</a>&nbsp;withRemotePath(@NonNull
  222. @NonNull java.lang.String&nbsp;remotePath)</pre>
  223. <div class="block">Sets the remotePath.</div>
  224. <dl>
  225. <dt><span class="paramLabel">Parameters:</span></dt>
  226. <dd><code>remotePath</code> - remote path</dd>
  227. <dt><span class="returnLabel">Returns:</span></dt>
  228. <dd><code>Builder</code></dd>
  229. </dl>
  230. </li>
  231. </ul>
  232. <a name="withChunkSize-int-">
  233. <!-- -->
  234. </a>
  235. <ul class="blockList">
  236. <li class="blockList">
  237. <h4>withChunkSize</h4>
  238. <pre>public&nbsp;<a href="../../../io/milvus/bulkwriter/RemoteBulkWriterParam.Builder.html" title="class in io.milvus.bulkwriter">RemoteBulkWriterParam.Builder</a>&nbsp;withChunkSize(int&nbsp;chunkSize)</pre>
  239. </li>
  240. </ul>
  241. <a name="withFileType-io.milvus.bulkwriter.common.clientenum.BulkFileType-">
  242. <!-- -->
  243. </a>
  244. <ul class="blockList">
  245. <li class="blockList">
  246. <h4>withFileType</h4>
  247. <pre>public&nbsp;<a href="../../../io/milvus/bulkwriter/RemoteBulkWriterParam.Builder.html" title="class in io.milvus.bulkwriter">RemoteBulkWriterParam.Builder</a>&nbsp;withFileType(@NonNull
  248. @NonNull <a href="../../../io/milvus/bulkwriter/common/clientenum/BulkFileType.html" title="enum in io.milvus.bulkwriter.common.clientenum">BulkFileType</a>&nbsp;fileType)</pre>
  249. </li>
  250. </ul>
  251. <a name="build--">
  252. <!-- -->
  253. </a>
  254. <ul class="blockListLast">
  255. <li class="blockList">
  256. <h4>build</h4>
  257. <pre>public&nbsp;<a href="../../../io/milvus/bulkwriter/RemoteBulkWriterParam.html" title="class in io.milvus.bulkwriter">RemoteBulkWriterParam</a>&nbsp;build()
  258. throws <a href="../../../io/milvus/exception/ParamException.html" title="class in io.milvus.exception">ParamException</a></pre>
  259. <div class="block">Verifies parameters and creates a new <a href="../../../io/milvus/bulkwriter/RemoteBulkWriterParam.html" title="class in io.milvus.bulkwriter"><code>RemoteBulkWriterParam</code></a> instance.</div>
  260. <dl>
  261. <dt><span class="returnLabel">Returns:</span></dt>
  262. <dd><a href="../../../io/milvus/bulkwriter/RemoteBulkWriterParam.html" title="class in io.milvus.bulkwriter"><code>RemoteBulkWriterParam</code></a></dd>
  263. <dt><span class="throwsLabel">Throws:</span></dt>
  264. <dd><code><a href="../../../io/milvus/exception/ParamException.html" title="class in io.milvus.exception">ParamException</a></code></dd>
  265. </dl>
  266. </li>
  267. </ul>
  268. </li>
  269. </ul>
  270. </li>
  271. </ul>
  272. </div>
  273. </div>
  274. <!-- ========= END OF CLASS DATA ========= -->
  275. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  276. <div class="bottomNav"><a name="navbar.bottom">
  277. <!-- -->
  278. </a>
  279. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  280. <a name="navbar.bottom.firstrow">
  281. <!-- -->
  282. </a>
  283. <ul class="navList" title="Navigation">
  284. <li><a href="../../../overview-summary.html">Overview</a></li>
  285. <li><a href="package-summary.html">Package</a></li>
  286. <li class="navBarCell1Rev">Class</li>
  287. <li><a href="package-tree.html">Tree</a></li>
  288. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  289. <li><a href="../../../index-files/index-1.html">Index</a></li>
  290. <li><a href="../../../help-doc.html">Help</a></li>
  291. </ul>
  292. </div>
  293. <div class="subNav">
  294. <ul class="navList">
  295. <li><a href="../../../io/milvus/bulkwriter/RemoteBulkWriterParam.html" title="class in io.milvus.bulkwriter"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  296. <li>Next&nbsp;Class</li>
  297. </ul>
  298. <ul class="navList">
  299. <li><a href="../../../index.html?io/milvus/bulkwriter/RemoteBulkWriterParam.Builder.html" target="_top">Frames</a></li>
  300. <li><a href="RemoteBulkWriterParam.Builder.html" target="_top">No&nbsp;Frames</a></li>
  301. </ul>
  302. <ul class="navList" id="allclasses_navbar_bottom">
  303. <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  304. </ul>
  305. <div>
  306. <script type="text/javascript"><!--
  307. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  308. if(window==top) {
  309. allClassesLink.style.display = "block";
  310. }
  311. else {
  312. allClassesLink.style.display = "none";
  313. }
  314. //-->
  315. </script>
  316. </div>
  317. <div>
  318. <ul class="subNavList">
  319. <li>Summary:&nbsp;</li>
  320. <li>Nested&nbsp;|&nbsp;</li>
  321. <li>Field&nbsp;|&nbsp;</li>
  322. <li>Constr&nbsp;|&nbsp;</li>
  323. <li><a href="#method.summary">Method</a></li>
  324. </ul>
  325. <ul class="subNavList">
  326. <li>Detail:&nbsp;</li>
  327. <li>Field&nbsp;|&nbsp;</li>
  328. <li>Constr&nbsp;|&nbsp;</li>
  329. <li><a href="#method.detail">Method</a></li>
  330. </ul>
  331. </div>
  332. <a name="skip.navbar.bottom">
  333. <!-- -->
  334. </a></div>
  335. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  336. </body>
  337. </html>